AFData Methods
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFData type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| CreateWithInputDataProvider |
Creates a new AFData instance that will evaluate this attribute with input data obtained by the specified input data provider.
| |
| EndOfStream |
Returns the end-of-stream AFValue.
| |
| EndOfStreamAsync |
Get the value with the largest timestamp for a data stream.
| |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
| FilteredSummaries |
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 |
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.
| |
| GetAllCachedValues |
Get all the events in the AFDataCache for this AFData instance.
| |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
| 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.
| |
| 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 the source provider.
| |
| RecordedValuesAsync |
Returns a list of values for the requested time range
from the source provider.
| |
| RecordedValuesAtTimes |
Retrieves recorded values at the specified times.
| |
| RecordedValuesAtTimesAsync |
Retrieves recorded values at the specified times.
| |
| 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, AFValues) |
This method removes existing data within the specified AFTimeRange and
inserts the specified values on the target system using the configured data reference.
| |
| ReplaceValues(AFTimeRange, AFValues, AFBufferOption) |
This method removes existing data within the specified AFTimeRange and
inserts the specified values on the target system using the configured data reference.
| |
| ReplaceValuesAsync(AFTimeRange, AFValues, CancellationToken) |
This method removes existing data within the specified AFTimeRange and
inserts the specified values on the target system using the configured data reference.
| |
| ReplaceValuesAsync(AFTimeRange, AFValues, AFBufferOption, CancellationToken) |
This method removes existing data within the specified AFTimeRange and
inserts the specified values on the target system using the configured data reference.
| |
| Summaries |
Returns several summaries for a single attribute over a time range for each interval within the range.
| |
| SummariesAsync |
Returns several summaries for a single attribute over a time range for each interval within the range.
| |
| Summary |
Returns several summaries for a single attribute over a single time range.
| |
| SummaryAsync |
Returns several summaries for a single attribute over a single time range.
| |
| ToString | Returns a string that represents the current object. (Inherited from Object.) | |
| UpdateValue(AFValue, AFUpdateOption) |
This method writes, replaces, or removes a value on the target system using the configured data reference.
| |
| UpdateValue(AFValue, AFUpdateOption, AFBufferOption) |
This method writes, replaces, or removes a value on the target system using the configured data reference.
| |
| UpdateValues(AFValues, AFUpdateOption) |
This method writes or replaces one or more values on the target system using the configured data reference.
| |
| UpdateValues(AFValues, AFUpdateOption, AFBufferOption) |
This method writes or replaces one or more values on the target system using the configured data reference.
| |
| UpdateValuesAsync(AFValues, AFUpdateOption, CancellationToken) |
This method writes or replaces one or more values on the target system using the configured data reference.
| |
| UpdateValuesAsync(AFValues, AFUpdateOption, AFBufferOption, CancellationToken) |
This method writes or replaces one or more values on the target system using the configured data reference.
|
See Also
In This Topic
Related Links
- CreateWithInputDataProvider Method
- EndOfStream Method
- EndOfStreamAsync Method
- FilteredSummaries Method
- FilteredSummariesAsync Method
- GetAllCachedValues Method
- InterpolatedValue Method
- InterpolatedValueAsync Method
- InterpolatedValues Method
- InterpolatedValuesAsync Method
- InterpolatedValuesAtTimes Method
- InterpolatedValuesAtTimesAsync Method
- PlotValues Method
- PlotValuesAsync Method
- RecordedValue Method
- RecordedValueAsync Method
- RecordedValues Method
- RecordedValuesAsync Method
- RecordedValuesAtTimes Method
- RecordedValuesAtTimesAsync Method
- RecordedValuesByCount Method
- RecordedValuesByCountAsync Method
- ReplaceValues Method
- ReplaceValuesAsync Method
- Summaries Method
- SummariesAsync Method
- Summary Method
- SummaryAsync Method
- UpdateValue Method
- UpdateValues Method
- UpdateValuesAsync Method