AFDataReference Methods
- Last UpdatedNov 18, 2025
- 13 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFDataReference type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
 | CreateConfig |
This method is invoked by the user to update the attribute configuration relative to a foreign system.
|
 | CreateConfig(AFDatabase, EventHandlerAFProgressEventArgs) |
Executes the create configuration function of the data references found
within the attributes and its children of a database.
|
| CreateConfig(PISystem, EventHandlerAFProgressEventArgs) |
Executes the create configuration function of the data references found
within the attributes and its children of a PI System.
|
| CreateConfig(IList, Boolean, EventHandlerAFProgressEventArgs) |
Executes the create configuration function of the data references found
within the list of attributes and or elements.
|
| CreateConfig(AFAttribute, Boolean, EventHandlerAFProgressEventArgs) |
Executes the create configuration function of the data reference found
within the specified attribute, and optionally, any child attributes.
|
| CreateConfig(AFBaseElement, Boolean, EventHandlerAFProgressEventArgs) |
Executes the create configuration function of the data references found
within the attributes of the element, and optionally, its children.
|
| CreateConfigEventFrames(AFDatabase, Object, Object, EventHandlerAFProgressEventArgs) |
Executes the create configuration function of the data references found
within the attributes and its children of a database.
|
| CreateConfigEventFrames(PISystem, Object, Object, EventHandlerAFProgressEventArgs) |
Executes the create configuration function of the data references found
within the attributes and its children of a PI System.
|
| DefaultSaveConfigChanges |
Called by the protected SaveConfigChanges method to perform the default actions to save
the configuration changes.
|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Inherited from AFObject.) |
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) |
| FilterCreateConfigSupportedAttributes |
Filter out attributes that do not support CreateConfig.
|
| FilteredSummaries |
Returns several summaries for a single attribute over a time range for each interval within the range.
|
| 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.
|
| GetAnnotation |
Gets the annotation associated with a single historical event.
|
| GetAttribute |
Retrieve the attribute for the specified name
relative to the attribute in this Data Reference.
|
| GetAttributeTemplate |
Retrieve the attribute template for the specified name
relative to the attribute template in this Data Reference.
|
| 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.
(Inherited from AFObject.) |
| GetInputs |
This method provides the data reference a mechanism to specify the attributes
it will use during its calculation.
|
| GetPath |
Returns the full path to the object, using just the names.
(Inherited from AFObject.) |
| GetPath(AFObject) |
Returns the path to the object relative from another object.
(Inherited from AFObject.) |
| GetPath(AFEncodeType, AFObject) |
Returns the path to the object relative from another object,
using the name and/or id as specified
by encodeType.
(Inherited from AFObject.) |
| GetPIPointDataReference |
This method will return the AFPlugIn for the PIPoint
data reference.
|
| GetToolTip |
Returns a tool tip suitable for displaying the current configuration.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue(AFAttributeList, Object, Object) |
This method gets the value for multiple attributes based upon the data reference
configuration within the specified context.
|
| GetValue(Object, Object, AFAttributeList, AFValues) |
This method gets the value based upon the data reference configuration
within the specified context.
|
| GetValues |
This method gets a collection of AFValue objects for an attribute based upon
the data reference configuration within the specified AFTimeRange context.
|
| 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.
|
| InterpolatedValuesAtTimes |
Retrieves interpolated values at the specified times.
|
| InterpolatedValuesAtTimesAsync |
Retrieves interpolated values at the specified times.
|
| InterpolatedValuesByCount |
Retrieves interpolated values over the specified time range evenly spaced using the numberOfValues.
|
| InterpolatedValuesByCountAsync |
This method returns the specified number of interpolated values evenly spaced throughout the specified timeRange.
|
| IsRepairSupported |
Checks whether attributes support Repair function.
|
| IsReplacePIServerSupported(AFAttribute) |
Checks whether attributes and attribute templates support ReplacePIServer method.
|
| IsReplacePIServerSupported(AFAttributeTemplate) |
Checks whether attributes supports ReplacePIServer.
|
| Persist |
This method returns the persistence string for the object.
(Overrides AFObjectPersist.) |
| PlotValues |
Returns a single AFValue whose value is
interpolated at the passed time.
|
| 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.
|
| Repair(AFDatabase, EventHandlerAFProgressEventArgs) |
Executes the repair function on the PI Point or PI Point Array data references found
within the attributes and its children of a database. When PI point ids or point names
in the ConfigString no longer match those on the PI Data Archive, a repair fixes the mismatch.
|
| Repair(PISystem, EventHandlerAFProgressEventArgs) |
Executes the repair function on the PI Point or PI Point Array data references found
within the attributes and its children of a PI System. When point ids or point names
in the ConfigString no longer match those on the PI Data Archive, a repair fixes the mismatch.
|
| RepairEventFrames(AFDatabase, Object, Object, EventHandlerAFProgressEventArgs) |
Executes the repair function on the PI Point or PI Point Array data references found
within the attributes and its children of event frames of a database. When point ids or point names
in the ConfigString no longer match those on the PI Data Archive, a repair fixes the mismatch.
|
| RepairEventFrames(PISystem, Object, Object, EventHandlerAFProgressEventArgs) |
Executes the repair function on the PI Point or PI Point Array data references found
within the attributes and its children of event frames of a PI System. When point ids or point names
in the ConfigString no longer match those on the PI Data Archive, a repair fixes the mismatch.
|
| ReplacePIServer(AFDatabase, String, String, EventHandlerAFProgressEventArgs) |
Replaces the PI Data Archive server name with another server on the PI Point and PI Point Array data references found
within the attributes and attribute templates and its children of a database.
|
| ReplacePIServer(PISystem, String, String, EventHandlerAFProgressEventArgs) |
Replaces the PI Data Archive server name with another server name on the PI Point and PI Point Array data references found
within the attributes and attribute templates and its children of a PI System.
|
| ReplacePIServerEventFrames(AFDatabase, String, String, Object, Object, EventHandlerAFProgressEventArgs) |
Replaces the PI Data Archive server with another server on the PI Point and PI Point Array data references found
within the attributes and attribute templates and its children of event frames of a database.
|
| ReplacePIServerEventFrames(PISystem, String, String, Object, Object, EventHandlerAFProgressEventArgs) |
Replaces the PI Data Archive server with another server on the PI Point and PI Point Array data references found
within the attributes and attribute templates and its children of event frames of a PI System.
|
| 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.
|
| SetAnnotation |
Associates the annotation with the passed in value.
|
| SetSaveConfigChangesHandler |
Set the handler used for saving ConfigString changes.
|
| SetValue |
This method sets the value based upon the data reference configuration
within the specified context.
|
| 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.
(Overrides AFObjectToString.) |
| 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.
|
| UsesInternalAFValue |
Determines if the specified AFPlugIn uses
the SetInternalAFValue method for storing values.
|
See Also
In This Topic
Related Links
- CreateConfig Method
- CreateConfigEventFrames Method
- DefaultSaveConfigChanges Method
- FilterCreateConfigSupportedAttributes Method
- FilteredSummaries Method
- FilteredSummariesAsync Method
- GetAnnotation Method
- GetAttribute Method
- GetAttributeTemplate Method
- GetInputs Method
- GetPIPointDataReference Method
- GetToolTip Method
- GetValue Method
- GetValues Method
- InterpolatedValue Method
- InterpolatedValueAsync Method
- InterpolatedValuesAtTimes Method
- InterpolatedValuesAtTimesAsync Method
- InterpolatedValuesByCount Method
- InterpolatedValuesByCountAsync Method
- IsRepairSupported Method
- IsReplacePIServerSupported Method
- Persist Method
- PlotValues Method
- PlotValuesAsync Method
- RecordedValue Method
- RecordedValueAsync Method
- RecordedValues Method
- RecordedValuesAsync Method
- RecordedValuesAtTimes Method
- RecordedValuesAtTimesAsync Method
- RecordedValuesByCount Method
- RecordedValuesByCountAsync Method
- Repair Method
- RepairEventFrames Method
- ReplacePIServer Method
- ReplacePIServerEventFrames Method
- ReplaceValues Method
- ReplaceValuesAsync Method
- SetAnnotation Method
- SetSaveConfigChangesHandler Method
- SetValue Method
- Summaries Method
- SummariesAsync Method
- Summary Method
- SummaryAsync Method
- ToString Method
- UpdateValue Method
- UpdateValues Method
- UpdateValuesAsync Method
- UsesInternalAFValue Method