Click or drag to resize
OSIsoft, LLC

PIPoint Class

The PIPoint object represents a point on a PIServer.

Inheritance Hierarchy
SystemObject
  OSIsoft.AF.PIPIPoint

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.6.195
Syntax
public sealed class PIPoint : IComparable, 
	IComparable<PIPoint>, IEquatable<PIPoint>

The PIPoint type exposes the following members.

Properties
  NameDescription
Public propertyFuture
This property is used to determine if the PIPoint has the ability to store data in the future.
Public propertyID
This property identifies the ID of the PIPoint on the PIServer.
Public propertyIsLoadedForDataAccess
This property is used to determine if the PIPoint properties used when reading and writing data have been loaded.
Public propertyIsResolved
This property is used to determine if the PIPoint's Name has been resolved.
Public propertyName
This property identifies the name of the PIPoint.
Public propertyPointClass
This property identifies the PIPointClass of the PIPoint.
Public propertyPointType
This property identifies the PIPointType of the PIPoint.
Public propertyServer
The PIServer for this PIPoint.
Public propertyStep
The Step attribute for the PIPoint.
Top
Methods
  NameDescription
Public methodCompareTo(Object)
Compares this instance with a specified Object.
Public methodCompareTo(PIPoint)
Compares this instance with a specified PIPoint.
Public methodCurrentValue
Get the value of the PI Point at the current PI Server time.
Public methodEndOfStream
Get the end-of-stream value of the point.
Public methodEndOfStreamAsync
Gets the value recorded for a PI Point with the latest time stamp. This value may be in the future.
Public methodEquals(Object)
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public methodEquals(PIPoint)
Indicates whether the current object is equal to another object of the same type.
Public methodFilteredSummaries(IListAFTimeIntervalDefinition, Boolean, String, AFSummaryTypes, AFCalculationBasis, AFSampleType, AFTimeSpan, AFTimestampCalculation)
This method, when supplied a filter expression that evaluates to true or false, evaluates it over the time range on the passed in intervalDefinitions. For the time ranges where the expression evaluates to true, the method calculates the requested summaries on the PI point.
Public methodFilteredSummaries(AFTimeRange, AFTimeSpan, String, AFSummaryTypes, AFCalculationBasis, AFSampleType, AFTimeSpan, AFTimestampCalculation)
This method, when supplied a filter expression that evaluates to true or false, evaluates it over the passed time range. For the time ranges where the expression evaluates to true, the method calculates the requested summaries on the source attribute.
Public methodFilteredSummariesAsync(IListAFTimeIntervalDefinition, Boolean, String, AFSummaryTypes, AFCalculationBasis, AFSampleType, AFTimeSpan, AFTimestampCalculation, CancellationToken)
This method, when supplied a filter expression that evaluates to true or false, evaluates it over the passed time range. For the time ranges where the expression evaluates to true, the method calculates the requested summaries on the source attribute.
Public methodFilteredSummariesAsync(AFTimeRange, AFTimeSpan, String, AFSummaryTypes, AFCalculationBasis, AFSampleType, AFTimeSpan, AFTimestampCalculation, CancellationToken)
This method, when supplied a filter expression that evaluates to true or false, evaluates it over the passed time range. For the time ranges where the expression evaluates to true, the method calculates the requested summaries on the source attribute.
Public methodCode exampleFindAttributeNames
Find the loaded PIPoint attribute names based upon a filter.
Public methodStatic memberFindPIPoint(String)
Returns the PIPoint identified by the path.
Public methodStatic memberFindPIPoint(PIServer, Int32)
Find a PIPoint on the current PIServer using the specified point ID.
Public methodStatic memberFindPIPoint(PIServer, String)
Find a PIPoint on the current PIServer using the specified point name.
Public methodStatic memberFindPIPoints(PIServer, IEnumerablePIPointQuery, IEnumerableString)
Find an enumerable list of PIPoint objects that match the specified query filter conditions.
Public methodStatic memberFindPIPoints(PIServer, IEnumerableInt32, IEnumerableString)
Finds a list of PIPoint objects from the specified point ids.
Public methodStatic memberFindPIPoints(PIServer, IEnumerableString, IEnumerableString)
Find a list of PIPoint objects from a specified list of point names.
Public methodStatic memberFindPIPoints(PIServer, IListIEnumerablePIPointQuery, IEnumerableString)
Find an enumerable list of PIPoint objects that match the specified list of query filter conditions ORed together.
Public methodStatic memberFindPIPoints(PIServer, String, String, IEnumerableString)
Find an enumerable list of PIPoint objects from a point name and point source filter.
Public methodStatic memberFindPIPoints(PIServer, String, Boolean, IEnumerableString, AFSearchTextOption)
Find an enumerable list of PIPoint objects that match the specified query string.
Public methodStatic memberFindPIPointsAsync(PIServer, IEnumerablePIPointQuery, IEnumerableString, CancellationToken)
Find an enumerable list of PIPoint objects that match the specified query filter conditions.
Public methodStatic memberFindPIPointsAsync(PIServer, IEnumerableInt32, IEnumerableString, CancellationToken)
Finds a list of PIPoint objects from the specified point ids.
Public methodStatic memberFindPIPointsAsync(PIServer, IEnumerableString, IEnumerableString, CancellationToken)
Find a list of PIPoint objects from a specified list of point names.
Public methodStatic memberFindPIPointsAsync(PIServer, IListIEnumerablePIPointQuery, IEnumerableString, CancellationToken)
Find an enumerable list of PIPoint objects that match the specified list of query filter conditions ORed together.
Public methodStatic memberFindPIPointsAsync(PIServer, String, String, IEnumerableString, CancellationToken)
Find an enumerable list of PIPoint objects from a point name and point source filter.
Public methodStatic memberFindPIPointsAsync(PIServer, String, Boolean, IEnumerableString, AFSearchTextOption, CancellationToken)
Find an enumerable list of PIPoint objects that match the specified query string.
Public methodStatic memberFindPIPointsByPath
Find a collection of PIPoint objects from a specified list of path names as keyed results. The path name is the key to lookup the PIPoint object in the result.
Public methodGetAnnotation
Gets the annotation associated with a single historical event.
Public methodCode exampleGetAttribute
Get the value of a PIPoint attribute by name.
Public methodCode exampleGetAttributes
Get the list of PIPoint attribute values by name.
Public methodGetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ObjectGetHashCode.)
Public methodGetPath
Returns the full path to the PIPoint, using just the names.
Public methodGetPath(AFEncodeType)
Returns the path to the PIPoint using the name and/or id as specified by the encodeType.
Public methodGetStateSet
Gets the AFEnumerationSet for the Digital State Set associated with the PIPoint.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInterpolatedValue
Returns a single AFValue whose value is interpolated at the passed time.
Public methodInterpolatedValueAsync
Returns a single AFValue whose value is interpolated at the passed time.
Public methodInterpolatedValues
Retrieves interpolated values over the specified time range at the specified sampling interval.
Public methodInterpolatedValuesAsync
Retrieves interpolated values over the specified time range at the specified sampling interval.
Public methodInterpolatedValuesAtTimes
Retrieves interpolated values at the specified times.
Public methodInterpolatedValuesAtTimesAsync
Retrieves interpolated values at the specified times.
Public methodInterpolatedValuesByCount
This method returns the specified number of interpolated values evenly spaced throughout the specified timeRange.
Public methodInterpolatedValuesByCountAsync
This method returns the specified number of interpolated values evenly spaced throughout the specified timeRange.
Public methodCode exampleIsAttributeLoaded
Determines whether or not the PIPoint attribute has been loaded into cache.
Public methodCode exampleLoadAttributes
Load PIPoint attributes into the cache.
Public methodPlotValues
Retrieves values over the specified time range suitable for plotting over the number of intervals (typically represents pixels).
Public methodPlotValuesAsync
Retrieves values over the specified time range suitable for plotting over the number of intervals (typically represents pixels).
Public methodRecordedValue
Returns a single recorded AFValue based on the passed time and mode.
Public methodRecordedValueAsync
Returns a single recorded AFValue based on the passed time and mode.
Public methodRecordedValues
Returns a list of compressed values for the requested time range from PI.
Public methodRecordedValuesAsync
Returns a list of values for the requested time range from the source provider.
Public methodRecordedValuesAtTimes
Returns recorded values based on the specified times and mode.
Public methodRecordedValuesAtTimesAsync
Returns recorded values based on the specified times and mode.
Public methodRecordedValuesByCount
This method returns a specified number of compressed values beginning at the requested start time in the direction specified.
Public methodRecordedValuesByCountAsync
This method returns a specified number of compressed values beginning at the requested start time in the direction specified.
Public methodReplaceValues(AFTimeRange, IListAFValue)
This method removes existing data within the specified AFTimeRange and inserts the specified values.
Public methodReplaceValues(AFTimeRange, IListAFValue, AFBufferOption)
This method removes existing data within the specified AFTimeRange and inserts the specified values.
Public methodReplaceValuesAsync(AFTimeRange, IListAFValue, CancellationToken)
This method removes existing data within the specified AFTimeRange and inserts the specified values.
Public methodReplaceValuesAsync(AFTimeRange, IListAFValue, AFBufferOption, CancellationToken)
This method removes existing data within the specified AFTimeRange and inserts the specified values.
Public methodCode exampleSaveAttributes(IDictionaryString, Object)
Set the PIPoint cached attribute values and save them to the server.
Public methodCode exampleSaveAttributes(String)
Save the PIPoint attribute values in the cache to the server.
Public methodSetAnnotation
Associates the annotation with the passed in value.
Public methodCode exampleSetAttribute
Set the value of a PIPoint attribute by name. In order to save the modified value to the server, the following SaveAttributes(String) call should be made.
Public methodSnapshot Obsolete.
Get the snapshot value of the point.
Public methodSummaries(IListAFTimeIntervalDefinition, Boolean, AFSummaryTypes, AFCalculationBasis, AFTimestampCalculation)
Returns several summaries for each specified interval and range.
Public methodSummaries(AFTimeRange, AFTimeSpan, AFSummaryTypes, AFCalculationBasis, AFTimestampCalculation)
Returns several summaries over a time range for each interval within the range.
Public methodSummariesAsync(IListAFTimeIntervalDefinition, Boolean, AFSummaryTypes, AFCalculationBasis, AFTimestampCalculation, CancellationToken)
Returns several summaries for a single PIPoint over a time range for each interval within the range.
Public methodSummariesAsync(AFTimeRange, AFTimeSpan, AFSummaryTypes, AFCalculationBasis, AFTimestampCalculation, CancellationToken)
Returns several summaries for a single PIPoint over a time range for each interval within the range.
Public methodSummary
Returns several summaries over a single time range.
Public methodSummaryAsync
Returns several summaries for a single PIPoint over a single time range.
Public methodToString
Returns a String that represents the current object.
(Overrides ObjectToString.)
Public methodStatic memberTryFindPIPoint
Find a PIPoint on the current PIServer using the specified point name without throwing an exception.
Public methodCode exampleUnloadAllAttributes
Unload all PIPoint attributes from the cache except for the specified names.
Public methodCode exampleUnloadAttributes
Unload PIPoint attributes from the cache.
Public methodUpdateValue(AFValue, AFUpdateOption)
This method writes or replaces a value in the PI Data Archive.
Public methodUpdateValue(AFValue, AFUpdateOption, AFBufferOption)
This method writes or replaces a value in the PI Data Archive.
Public methodUpdateValues(IListAFValue, AFUpdateOption)
Update multiple values for the PIPoint.
Public methodCode exampleUpdateValues(IListAFValue, AFUpdateOption, AFBufferOption)
Update multiple values for the PIPoint.
Public methodUpdateValuesAsync(IListAFValue, AFUpdateOption, CancellationToken)
This method writes or replaces one or more values on the target system using the configured data reference.
Public methodUpdateValuesAsync(IListAFValue, AFUpdateOption, AFBufferOption, CancellationToken)
This method writes or replaces one or more values on the target system using the configured data reference.
Top
Operators
  NameDescription
Public operatorStatic memberEquality
The equality operator (==) compares its operands to determine if they are equal.
Public operatorStatic memberGreaterThan
The greater than relation operator (>) compares its operands to determine which one is greater than the other.
Public operatorStatic memberGreaterThanOrEqual
The greater than or equal relation operator (>=) compares its operands to determine which one is greater than or equal to the other.
Public operatorStatic memberInequality
The inequality operator (!=) compares its operands to determine if they are not equal.
Public operatorStatic memberLessThan
The less than relation operator (<) compares its operands to determine which one is less than the other.
Public operatorStatic memberLessThanOrEqual
The less than or equal relation operator (<=) compares its operands to determine which one is less than or equal to the other.
Top
Remarks
The PIPoint is the primary access point to data on a PIServer as well as configuration of a point's properties.

Note Notes to Callers
This method, property, or class is only available in the .NET 4 version of the SDK.

Examples
// Get the PIPoint from the PIServer on the local computer
PISystems myPISystems = new PISystems();
PISystem myPISystem = myPISystems.DefaultPISystem;
PIServer myPIServer = PIServer.FindPIServer(myPISystem, piServerName);
PIPoint myPIPoint = PIPoint.FindPIPoint(myPIServer, piPointName);

// Display information about the PIPoint
Console.WriteLine("Name of the PIPoint = {0}", myPIPoint.Name);
Console.WriteLine("ID of the PIPoint = {0}", myPIPoint.ID);
Console.WriteLine("Type of the PIPoint = {0}", myPIPoint.PointType);
Console.WriteLine("PIPoint Current Value = '{0}'", myPIPoint.CurrentValue());
Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5
See Also
Enabling Operational Intelligence