OSIsoft.AF.Data Namespace
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
The OSIsoft.AF.Data namespace provides a set of classes for obtaining data from assets within an organization.
Classes
| Class | Description | |
|---|---|---|
| AFAnnotation |
The structured AFAnnotation object is used to read and create annotations associated
with historical data events of an AFAttribute as well as to read and create
annotations associated with asset based objects such as an AFEventFrame
or AFElement.
| |
| AFAnnotations |
A list of structured AFAnnotation objects associated with an historical data event.
| |
| AFCalculation |
The static class AFCalculation provides mechanisms to evaluate expressions.
| |
| AFData |
The AFData object is associated with a single AFAttribute
and is used to retrieve and set extended historical data.
It is accessed through the Data property of an AFAttribute.
| |
| AFDataCache |
An AFDataCache manages a collection of AFAttributes via cache enabled AFData objects and will
can automatically monitor for new data changes.
| |
| AFDataLossException |
Represents a data loss incident in a datapipe.
| |
| AFDataPipe |
An AFDataPipe is a collection of AFAttribute objects
that are signed up for data change events on the server.
| |
| AFDataPipeEvent |
A data pipe event used to represent changes to the PIPoint and AFAttribute objects delivered by
the PIDataPipe and AFDataPipe classes.
| |
| AFDataPipeEventWithChangeTime |
A data pipe event used to represent changes to an AFAttribute object delivered by
the PIDataPipe class, including the time at which the update occurred.
| |
| AFDataPipeRangeDeletedEvent |
A data pipe event used to represent removal of a range of data.
| |
| AFDataPipeSignupEstablishedEvent |
A data pipe event used to represent a previously suspended signup that has been established.
| |
| AFDataPipeSignupSuspendedException |
Represents a signup that cannot be completed currently but could become active in the future.
| |
| AFDataPipeStatistics |
Statistics for data pipe updates.
| |
| AFDataPipeUpdateToken |
The AFDataPipeUpdateToken contains the AFAttributes that could be affected when loading the specified changes.
| |
| AFEventSource |
The AFEventSource is a base class that can be used for data references which
need to provide streaming events for an AFDataPipe.
| |
| AFListData |
The AFListData object is associated with a AFAttributeList
and is used to retrieve and set extended historical data for multiple attributes.
It is accessed through the Data property of an AFAttributeList.
| |
| AFTimeBasedEventSource |
The AFTimeBasedEventSource is a base class that can be used for data references which do not natively support
streaming events for an AFDataPipe but supports RecordedValues(AFTimeRange, AFBoundaryType, UOM, String, Boolean, Int32). AFTimeBasedEventSource periodically
polls data from AFAttribute in the pipe and caches the result. When the GetUpdateEvents/GetObserverEvents of the
pipe is called, AFTimeBasedEventSource extracts the events up to current time + EventHorizonOffset from its cache
to be returned to the caller.
|
Interfaces
| Interface | Description | |
|---|---|---|
| IAFDataProvider |
An interface for providing cache-enabled AFData instances that can be used to generate inputs for calculations.
|
Enumerations
| Enumeration | Description | |
|---|---|---|
| AFBoundaryType |
Defines the behavior of data retrieval at the end points of a specified time range.
| |
| AFBufferOption |
Indicates buffering option in updating values, when supported by the Data Reference.
| |
| AFCalculationBasis |
Defines the possible calculation options when performing summary calculations over time-series data.
| |
| AFDataCacheUpdateOption |
Specifies how AFDataCache update the data in the cache for the AFAttribute items
the AFDataCache manages.
| |
| AFDataMethods |
The AFDataMethods is an enumeration of the possible data methods which a
data reference supports. It is returned by the
AFAttribute.SupportedDataMethods and
AFDataReference.SupportedDataMethods
properties.
| |
| AFDataPipeAction |
Specifies how the data for the PIPoint or AFAttribute associated with an
AFDataPipeEvent was changed.
| |
| AFDataPipePreviousEventAction |
Provides information about the previous data pipe events. Not every data source has information about
previous data pipe events.
| |
| AFDataPipeType |
Specifies the type of data change events generated by the PIDataPipe class.
| |
| AFDataPipeUpdateAction |
Identifies the effect that updating items had on an AFDataPipe or AFDataCache signup.
| |
| AFEventHorizonMode |
EventHorizonMode specifies what events are returned by the datapipe at the GetUpdateEvent/GetObserverEvents calls
based on the timestamp of the events.
| |
| AFRetrievalMode |
Defines the possible options for retrieving recorded values from an attribute.
| |
| AFSampleType |
Defines the evaluation of an expression over a time range.
| |
| AFSummaryTypes |
Flags to indicate which summary type calculation(s) should be performed.
| |
| AFTimestampCalculation |
Defines the timestamp returned for a value when a summary calculation is done.
| |
| AFUpdateOption |
Indicates how to treat duplicate values in the archive, when supported by the Data Reference.
|
In This Topic
Related Links
- AFAnnotation Class
- AFAnnotations Class
- AFBoundaryType Enumeration
- AFBufferOption Enumeration
- AFCalculation Class
- AFCalculationBasis Enumeration
- AFData Class
- AFDataCache Class
- AFDataCacheUpdateOption Enumeration
- AFDataLossException Class
- AFDataMethods Enumeration
- AFDataPipe Class
- AFDataPipeAction Enumeration
- AFDataPipeEvent Class
- AFDataPipeEventWithChangeTime Class
- AFDataPipePreviousEventAction Enumeration
- AFDataPipeRangeDeletedEvent Class
- AFDataPipeSignupEstablishedEvent Class
- AFDataPipeSignupSuspendedException Class
- AFDataPipeStatistics Class
- AFDataPipeType Enumeration
- AFDataPipeUpdateAction Enumeration
- AFDataPipeUpdateToken Class
- AFEventHorizonMode Enumeration
- AFEventSource Class
- AFListData Class
- AFRetrievalMode Enumeration
- AFSampleType Enumeration
- AFSummaryTypes Enumeration
- AFTimeBasedEventSource Class
- AFTimestampCalculation Enumeration
- AFUpdateOption Enumeration
- IAFDataProvider Interface