AFDataCache Methods
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFDataCache type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Add |
Adds a list of AFAttribute objects to be managed by AFDataCache. The AFAttributes are
reference counted. Adding AFAttribute that is already in the AFDataCache will increment the reference count and not
generate error. Adding the same AFAttribute multiple times will require the same number of Remove call to actually
remove the AFAttribute from the AFDataCache.
|
| Dispose |
Release all the resources associated with this AFDataCache, including the AFDataPipe
used to populate the cached data.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetDataPipeItemsByPIServer |
Get the list of the AFAttribute objects managed by AFDataCache with
DataPipe that get data from the passed PIServer.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetItemUpdateOption | |
| GetRelatedAttributes |
For each AFChangeInfo, finds the subscribed AFAttributes that might be impacted by the change.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ObservePendingChanges |
Observes a set of changes from the server and prepares to update the AFDataPipe to reflect them.
|
| ProcessAppliedChanges |
Updates the AFDataPipe to reflect previously observed changes.
|
| Remove |
Remove a list of AFAttribute objects from the data cache.
|
| ResetCounters |
Reset AFDataCache statistic counters.
|
| Subscribe |
Register an IObserver to receive AFDataPipeEvents that are a result of the internal
AFDataPipe used within the data cache for auto-monitored attributes.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TrimData(AFAttribute, AFTime) |
Trims any cached data for the AFAttribute at or before the specified AFTime.
|
| TrimData(AFAttribute, AFTime, Int32) |
Trims cached data for the AFAttribute while maintaining coverage for events from a specified time.
|
| TryGetItem |
Returns the cache enabled AFData object for a given AFAttribute.
|
| UpdateData |
Update the time series cache for the attributes managed by this AFDataCache.
|
| UpdateData(Boolean) |
Update the time series cache for the attributes managed by this AFDataCache.
|
| UpdateData(AFTime) |
Update the time series cache for the attributes managed by this AFDataCache.
|
| UpdateData(AFTime, Boolean) |
Update the time series cache for the attributes managed by this AFDataCache.
|
| WriteToCache(AFAttribute, IListAFValue) |
Initialize the data cache of the AFAttribute with passed values. The AFAttribute
must already be added to the AFDataCache with Manual
or ManualRange.
|
| WriteToCache(AFValue, AFUpdateOption) |
Writes value to the data cache. The AFAttribute property of the passed AFValue is the key
to lookup the data cache. This AFAttribute must already be added to the
AFDataCache with Manual or ManualRange.
|