AFDataPipe Methods
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFDataPipe type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddSignups |
Adds a list of AFAttribute objects to be monitored by the data pipe.
The method returns server level and attribute level errors in AFErrorsTKey .
|
| AddSignupsWithInitEvents |
Adds a list of AFAttribute objects to be monitored by the data pipe and returns the
initial events for this list of new signup objects.
PIserver level and attribute level errors can be accessed in the AFListResultsTKey, TResult |
| Dispose |
Closes the event pipe
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObserverEvents |
Trigger retrieval of new events that occurred on the PIPoint objects monitored
by the data pipe. The new events will be sent to the IObserver objects registered with the data pipe.
|
| GetObserverEvents(Boolean) |
Trigger retrieval of new events that occurred on the PIPoint objects monitored
by the data pipe. The new events will be sent to the IObserver objects registered with the data pipe.
|
| GetRelatedAttributes |
For each AFChangeInfo, finds the subscribed AFAttributes that might be impacted by the change.
|
| GetSignups |
Get the list of the AFAttribute objects being monitored by the pipe.
|
| GetSignupsByPIServer |
Get the list of the AFAttribute objects being monitored by the pipe that could
get data from the passed PIServer.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUpdateEvents |
Get the list of data change events from the server
|
| GetUpdateEvents(Boolean) |
Get the list of data change events from the server
|
| 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.
|
| RemoveSignups |
Remove a list of AFAttribute objects being monitored by the data pipe.
The method returns server level and attribute level errors in AFErrorsTKey .
|
| Subscribe |
Register an IObserver for AFDataPipeEvent with the AFDataPipe. All the AFDataPipeEvents
received by the data pipe will be sent to the IObserver.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |