PIPoint Class
- Last UpdatedNov 18, 2025
- 16 minute read
- PI System
- AF SDK 2024 R2
- Developer
The PIPoint object represents a point on a PIServer.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.PIPIPoint
OSIsoft.AF.PIPIPoint
Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class PIPoint : IComparable, IComparable<PIPoint>, IEquatable<PIPoint>
Public NotInheritable Class PIPoint Implements IComparable, IComparable(Of PIPoint), IEquatable(Of PIPoint) Dim instance As PIPoint
public ref class PIPoint sealed : IComparable, IComparable<PIPoint^>, IEquatable<PIPoint^>
[<SealedAttribute>] type PIPoint = class interface IComparable interface IComparable<PIPoint> interface IEquatable<PIPoint> end
The PIPoint type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Future |
This property is used to determine if the PIPoint has the ability to store data in the future.
|
| ID |
This property identifies the ID of the PIPoint on the PIServer.
|
| IsLoadedForDataAccess |
This property is used to determine if the PIPoint properties used when reading and writing data have been loaded.
|
| IsResolved |
This property is used to determine if the PIPoint's Name has been resolved.
|
| Name |
This property identifies the name of the PIPoint.
|
| PointClass |
This property identifies the PIPointClass of the PIPoint.
|
| PointType |
This property identifies the PIPointType of the PIPoint.
|
| Server |
The PIServer for this PIPoint.
|
| Step |
The Step attribute for the PIPoint.
|
Methods
| Name | Description | |
|---|---|---|
 | CompareTo(Object) |
Compares this instance with a specified Object.
|
| CompareTo(PIPoint) |
Compares this instance with a specified PIPoint.
|
| CurrentValue |
Get the value of the PI Point at the current PI Server time.
|
| EndOfStream |
Get the end-of-stream value of the point.
|
| EndOfStreamAsync |
Gets the value recorded for a PI Point with the latest time stamp. This value may be in the future.
|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).) |
| Equals(PIPoint) |
Indicates whether the current object is equal to another object of the same type.
|
| FilteredSummaries(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.
|
| FilteredSummaries(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.
|
| FilteredSummariesAsync(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.
|
| FilteredSummariesAsync(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.
|
 | FindAttributeNames |
Find the loaded PIPoint attribute names based upon a filter.
|
 | FindPIPoint(String) |
Returns the PIPoint identified by the path.
|
| FindPIPoint(PIServer, Int32) |
Find a PIPoint on the current PIServer
using the specified point ID.
|
| FindPIPoint(PIServer, String) |
Find a PIPoint on the current PIServer
using the specified point name.
|
| FindPIPoints(PIServer, IEnumerablePIPointQuery, IEnumerableString) |
Find an enumerable list of PIPoint objects that match the specified query filter conditions.
|
| FindPIPoints(PIServer, IEnumerableInt32, IEnumerableString) |
Finds a list of PIPoint objects from the specified point ids.
|
| FindPIPoints(PIServer, IEnumerableString, IEnumerableString) |
Find a list of PIPoint objects from a specified list of point names.
|
| FindPIPoints(PIServer, IListIEnumerablePIPointQuery, IEnumerableString) |
Find an enumerable list of PIPoint objects that match the specified list of
query filter conditions ORed together.
|
| FindPIPoints(PIServer, String, String, IEnumerableString) |
Find an enumerable list of PIPoint objects from a point name and point source filter.
|
| FindPIPoints(PIServer, String, Boolean, IEnumerableString, AFSearchTextOption) |
Find an enumerable list of PIPoint objects that match the specified query string.
|
| FindPIPointsAsync(PIServer, IEnumerablePIPointQuery, IEnumerableString, CancellationToken) |
Find an enumerable list of PIPoint objects that match the specified query filter conditions.
|
| FindPIPointsAsync(PIServer, IEnumerableInt32, IEnumerableString, CancellationToken) |
Finds a list of PIPoint objects from the specified point ids.
|
| FindPIPointsAsync(PIServer, IEnumerableString, IEnumerableString, CancellationToken) |
Find a list of PIPoint objects from a specified list of point names.
|
| FindPIPointsAsync(PIServer, IListIEnumerablePIPointQuery, IEnumerableString, CancellationToken) |
Find an enumerable list of PIPoint objects that match the specified list of
query filter conditions ORed together.
|
| FindPIPointsAsync(PIServer, String, String, IEnumerableString, CancellationToken) |
Find an enumerable list of PIPoint objects from a point name and point source filter.
|
| FindPIPointsAsync(PIServer, String, Boolean, IEnumerableString, AFSearchTextOption, CancellationToken) |
Find an enumerable list of PIPoint objects that match the specified query string.
|
| FindPIPointsByPath |
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.
|
| GetAnnotation |
Gets the annotation associated with a single historical event.
|
| GetAttribute |
Get the value of a PIPoint attribute by name.
|
| GetAttributes |
Get the list of PIPoint attribute values by name.
|
| GetHashCode |
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.) |
| GetPath |
Returns the full path to the PIPoint, using just the names.
|
| GetPath(AFEncodeType) |
Returns the path to the PIPoint using the name and/or id
as specified by the encodeType.
|
| GetStateSet |
Gets the AFEnumerationSet for the Digital State Set
associated with the PIPoint.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InterpolatedValue |
Returns a single AFValue whose value is
interpolated at the passed time.
|
| InterpolatedValueAsync |
Returns a single AFValue whose value is
interpolated at the passed time.
|
| InterpolatedValues |
Retrieves interpolated values over the specified time range at the specified sampling interval.
|
| InterpolatedValuesAsync |
Retrieves interpolated values over the specified time range at the specified sampling interval.
|
| InterpolatedValuesAtTimes |
Retrieves interpolated values at the specified times.
|
| InterpolatedValuesAtTimesAsync |
Retrieves interpolated values at the specified times.
|
| InterpolatedValuesByCount |
This method returns the specified number of interpolated values evenly spaced throughout the specified timeRange.
|
| InterpolatedValuesByCountAsync |
This method returns the specified number of interpolated values evenly spaced throughout the specified timeRange.
|
| IsAttributeLoaded |
Determines whether or not the PIPoint attribute has been loaded into cache.
|
| LoadAttributes |
Load PIPoint attributes into the cache.
|
| PlotValues |
Retrieves values over the specified time range suitable for plotting over the number of intervals (typically represents pixels).
|
| PlotValuesAsync |
Retrieves values over the specified time range suitable for plotting over the number of intervals (typically represents pixels).
|
| RecordedValue |
Returns a single recorded AFValue based on the
passed time and mode.
|
| RecordedValueAsync |
Returns a single recorded AFValue based on the
passed time and mode.
|
| RecordedValues |
Returns a list of compressed values for the requested time range
from PI.
|
| RecordedValuesAsync |
Returns a list of values for the requested time range
from the source provider.
|
| RecordedValuesAtTimes |
Returns recorded values based on the
specified times and mode.
|
| RecordedValuesAtTimesAsync |
Returns recorded values based on the
specified times and mode.
|
| RecordedValuesByCount |
This method returns a specified number of compressed values beginning at the requested start time in the direction specified.
|
| RecordedValuesByCountAsync |
This method returns a specified number of compressed values beginning at the requested start time in the direction specified.
|
| ReplaceValues(AFTimeRange, IListAFValue) |
This method removes existing data within the specified AFTimeRange and
inserts the specified values.
|
| ReplaceValues(AFTimeRange, IListAFValue, AFBufferOption) |
This method removes existing data within the specified AFTimeRange and
inserts the specified values.
|
| ReplaceValuesAsync(AFTimeRange, IListAFValue, CancellationToken) |
This method removes existing data within the specified AFTimeRange and
inserts the specified values.
|
| ReplaceValuesAsync(AFTimeRange, IListAFValue, AFBufferOption, CancellationToken) |
This method removes existing data within the specified AFTimeRange and
inserts the specified values.
|
| SaveAttributes(IDictionaryString, Object) |
Set the PIPoint cached attribute values and save them to the server.
|
| SaveAttributes(String) |
Save the PIPoint attribute values in the cache to the server.
|
| SetAnnotation |
Associates the annotation with the passed in value.
|
| SetAttribute |
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.
|
| Snapshot | Obsolete.
Get the snapshot value of the point.
|
| Summaries(IListAFTimeIntervalDefinition, Boolean, AFSummaryTypes, AFCalculationBasis, AFTimestampCalculation) |
Returns several summaries for each specified interval and range.
|
| Summaries(AFTimeRange, AFTimeSpan, AFSummaryTypes, AFCalculationBasis, AFTimestampCalculation) |
Returns several summaries over a time range for each interval within the range.
|
| SummariesAsync(IListAFTimeIntervalDefinition, Boolean, AFSummaryTypes, AFCalculationBasis, AFTimestampCalculation, CancellationToken) |
Returns several summaries for a single PIPoint over a time range for each interval within the range.
|
| SummariesAsync(AFTimeRange, AFTimeSpan, AFSummaryTypes, AFCalculationBasis, AFTimestampCalculation, CancellationToken) |
Returns several summaries for a single PIPoint over a time range for each interval within the range.
|
| Summary |
Returns several summaries over a single time range.
|
| SummaryAsync |
Returns several summaries for a single PIPoint over a single time range.
|
| ToString |
Returns a String that represents the current object.
(Overrides ObjectToString.) |
| TryFindPIPoint |
Find a PIPoint on the current PIServer
using the specified point name without throwing an exception.
|
| UnloadAllAttributes |
Unload all PIPoint attributes from the cache except for the specified names.
|
| UnloadAttributes |
Unload PIPoint attributes from the cache.
|
| UpdateValue(AFValue, AFUpdateOption) |
This method writes or replaces a value in the PI Data Archive.
|
| UpdateValue(AFValue, AFUpdateOption, AFBufferOption) |
This method writes or replaces a value in the PI Data Archive.
|
| UpdateValues(IListAFValue, AFUpdateOption) |
Update multiple values for the PIPoint.
|
| UpdateValues(IListAFValue, AFUpdateOption, AFBufferOption) |
Update multiple values for the PIPoint.
|
| UpdateValuesAsync(IListAFValue, AFUpdateOption, CancellationToken) |
This method writes or replaces one or more values on the target system using the configured data reference.
|
| UpdateValuesAsync(IListAFValue, AFUpdateOption, AFBufferOption, CancellationToken) |
This method writes or replaces one or more values on the target system using the configured data reference.
|
Operators
| Name | Description | |
|---|---|---|
 | Equality |
The equality operator (==) compares its operands to determine if they are equal.
|
| GreaterThan |
The greater than relation operator (>) compares its operands to determine
which one is greater than the other.
|
| GreaterThanOrEqual |
The greater than or equal relation operator (>=) compares its operands to determine
which one is greater than or equal to the other.
|
| Inequality |
The inequality operator (!=) compares its operands to determine if they are not equal.
|
| LessThan |
The less than relation operator (<) compares its operands to determine
which one is less than the other.
|
| LessThanOrEqual |
The less than or equal relation operator (<=) compares its operands to determine
which one is less than or equal to the other.
|
Remarks
The PIPoint is the primary access point to data on
a PIServer as well as configuration of a point's properties.
 Notes to Callers |
|---|
| This method, property, or class is not available in the legacy .NET 3.5 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());
' Get the PIPoint from the PIServer on the local computer Dim myPISystems As New PISystems Dim myPISystem As PISystem = myPISystems.DefaultPISystem Dim myPIServer As PIServer = PIServer.FindPIServer(myPISystem, piServerName) Dim myPIPoint As PIPoint = 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())
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.