Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

PISystems Methods

  • Last UpdatedNov 18, 2025
  • 6 minute read
PISystems Methods

The PISystems type exposes the following members.

Methods

  NameDescription
Public method
Add
Registers a new PISystem to the list of known systems on the local machine.
Public method
Clear
Unregisters all existing PISystem entries from the list of known PISystems on the local machine.
Public method
Contains(Guid)
This method determines whether the collection contains a specific item referenced by id.
Public method
Contains(String)
This method determines whether the collection contains a specific item referenced by name.
Public method
CopyTo
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
Public method
DisconnectAll
Disconnects all PISystems that are currently connected.
Public method
Equals
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public method
GetEnumerator
Returns an enumerator that iterates through the collection.
Public method
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.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.
Public method
Refresh
Refresh the collection to the list of known systems on the local machine including disconnected systems.
Public method
Refresh(Boolean)
Refresh the collection to the list of known systems on the local machine with the option to refresh only connected systems.
Public method
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.
Public method
Remove(Guid)
Unregisters an existing PISystem with the specified unique identifier.
Public method
Remove(String)
Unregisters an existing PISystem with the specified name.
Public method
Remove(PISystem)
Unregisters the specified PISystem.
Public method
RemoveAt
Unregisters an existing PISystem by removing the entry from the list of known PISystems on the local machine.
Public method
SetApplicationIdentity
Set the client application identity to identify an application to the servers to which it connects.
Public method
Sort
Sorts the items in the entire collection using the default comparer.
Public method
Sort(IComparerPISystem)
Sorts the items in the entire collection using the specified comparer.
Public method
Sort(Int32, Int32, IComparerPISystem)
Sorts the items in a range of items in the collection using the specified comparer.
Public method
ToString
Returns a String that represents the current object.
(Overrides ObjectToString.)

Extension Methods

  NameDescription
Public Extension Method
AggregatePISystem
Performs all requested aggregates on the specified items.
(Defined by AFAggregate.)
Public Extension Method
AggregateAsyncPISystem
Performs all requested aggregates on the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
BinnedSummaryPISystem, TBin
Generates a summary broken down by the specified bins for items matching the search criteria.
(Defined by AFAggregate.)
Public Extension Method
BinnedSummaryAsyncPISystem, TBin
Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
(Defined by AFAggregate.)
Public Extension MethodCode example
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.)
Public Extension Method
FrequencyDistributionPISystem
Generates a frequency distribution for the specified items.
(Defined by AFAggregate.)
Public Extension Method
FrequencyDistributionAsyncPISystem
Generates a frequency distribution for the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
GroupedSummaryPISystem
Generates a summary broken down by group for the specified items.
(Defined by AFAggregate.)
Public Extension Method
GroupedSummaryAsyncPISystem
Generates a histogram for the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
HistogramPISystem, TBin
Generates a histogram for the specified items with the specified weighting.
(Defined by AFAggregate.)
Public Extension Method
HistogramAsyncPISystem, TBin
Generates a histogram for the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.)
Public Extension Method
SummaryPISystem(String, AFSummaryTypes)Overloaded.
Summarizes the specified items.
(Defined by AFAggregate.)
Public Extension Method
SummaryPISystem(String, AFSummaryTypes, String)Overloaded.
Summarizes the specified items with the specified weighting.
(Defined by AFAggregate.)
Public Extension Method
SummaryAsyncPISystem(String, AFSummaryTypes, CancellationToken)Overloaded.
Summarizes the specified items asynchronously.
(Defined by AFAggregate.)
Public Extension Method
SummaryAsyncPISystem(String, AFSummaryTypes, String, CancellationToken)Overloaded.
Summarizes the specified items with the specified weighting asynchronously.
(Defined by AFAggregate.)

See Also

TitleResults for “How to create a CRG?”Also Available in