PISystems Methods
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
The PISystems type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| Add |
Registers a new PISystem to the list of known systems on the local machine.
| |
| Clear |
Unregisters all existing PISystem entries from the list of known
PISystems on the local machine.
| |
| Contains(Guid) |
This method determines whether the collection contains a specific item referenced by id.
| |
| Contains(String) |
This method determines whether the collection contains a specific item referenced by name.
| |
| CopyTo |
Copies the entire collection to a compatible one-dimensional Array,
starting at the specified index of the target array.
| |
| DisconnectAll |
Disconnects all PISystems that are currently connected.
| |
| Equals |
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).) | |
| GetEnumerator |
Returns an enumerator that iterates through the collection.
| |
| 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.
(Overrides ObjectGetHashCode.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| IndexOf |
Searches for the specified object and returns the zero-based index of the first
occurrence within the entire collection.
| |
| Refresh |
Refresh the collection to the list of known systems on the local machine
including disconnected systems.
| |
| Refresh(Boolean) |
Refresh the collection to the list of known systems on the local machine with
the option to refresh only connected systems.
| |
| Refresh(Boolean, Boolean) |
Refresh the collection to the list of known systems on the local machine with
the option to refresh only connected systems and/or database-level objects.
| |
| Remove(Guid) |
Unregisters an existing PISystem with the specified unique identifier.
| |
| Remove(String) |
Unregisters an existing PISystem with the specified name.
| |
| Remove(PISystem) |
Unregisters the specified PISystem.
| |
| RemoveAt |
Unregisters an existing PISystem by removing the entry from the list of known
PISystems on the local machine.
| |
| SetApplicationIdentity |
Set the client application identity to identify an application to the servers
to which it connects.
| |
| Sort |
Sorts the items in the entire collection using the default comparer.
| |
| Sort(IComparerPISystem) |
Sorts the items in the entire collection using the specified comparer.
| |
| Sort(Int32, Int32, IComparerPISystem) |
Sorts the items in a range of items in the collection using the specified comparer.
| |
| ToString |
Returns a String that represents the current object.
(Overrides ObjectToString.) |
Extension Methods
| Name | Description | |
|---|---|---|
| AggregatePISystem |
Performs all requested aggregates on the specified items.
(Defined by AFAggregate.) | |
| AggregateAsyncPISystem |
Performs all requested aggregates on the specified items asynchronously.
(Defined by AFAggregate.) | |
| BinnedSummaryPISystem, TBin |
Generates a summary broken down by the specified bins for items matching the search criteria.
(Defined by AFAggregate.) | |
| BinnedSummaryAsyncPISystem, TBin |
Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
(Defined by AFAggregate.) | |
| ChunkedByPISystem |
This extension method breaks up search results into chunks to make it easier to
page through and process IEnumerableT collections in chunks.
(Defined by AFSDKExtension.) | |
| FrequencyDistributionPISystem |
Generates a frequency distribution for the specified items.
(Defined by AFAggregate.) | |
| FrequencyDistributionAsyncPISystem |
Generates a frequency distribution for the specified items asynchronously.
(Defined by AFAggregate.) | |
| GroupedSummaryPISystem |
Generates a summary broken down by group for the specified items.
(Defined by AFAggregate.) | |
| GroupedSummaryAsyncPISystem |
Generates a histogram for the specified items asynchronously.
(Defined by AFAggregate.) | |
| HistogramPISystem, TBin |
Generates a histogram for the specified items with the specified weighting.
(Defined by AFAggregate.) | |
| HistogramAsyncPISystem, TBin |
Generates a histogram for the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.) | |
| SummaryPISystem(String, AFSummaryTypes) | Overloaded.
Summarizes the specified items.
(Defined by AFAggregate.) | |
| SummaryPISystem(String, AFSummaryTypes, String) | Overloaded.
Summarizes the specified items with the specified weighting.
(Defined by AFAggregate.) | |
| SummaryAsyncPISystem(String, AFSummaryTypes, CancellationToken) | Overloaded.
Summarizes the specified items asynchronously.
(Defined by AFAggregate.) | |
| SummaryAsyncPISystem(String, AFSummaryTypes, String, CancellationToken) | Overloaded.
Summarizes the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.) |