AFAggregateResultCollection Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFAggregateResultCollection holds a set of multiple aggregates results.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.Data.AggregateAFAggregateResultCollection
OSIsoft.AF.Data.AggregateAFAggregateResultCollection
Namespace: OSIsoft.AF.Data.Aggregate
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFAggregateResultCollection : IReadOnlyList<AFAggregateResult>, IReadOnlyCollection<AFAggregateResult>, IEnumerable<AFAggregateResult>, IEnumerable
Public NotInheritable Class AFAggregateResultCollection Implements IReadOnlyList(Of AFAggregateResult), IReadOnlyCollection(Of AFAggregateResult), IEnumerable(Of AFAggregateResult), IEnumerable Dim instance As AFAggregateResultCollection
public ref class AFAggregateResultCollection sealed : IReadOnlyList<AFAggregateResult^>, IReadOnlyCollection<AFAggregateResult^>, IEnumerable<AFAggregateResult^>, IEnumerable
[<SealedAttribute>] type AFAggregateResultCollection = class interface IReadOnlyList<AFAggregateResult> interface IReadOnlyCollection<AFAggregateResult> interface IEnumerable<AFAggregateResult> interface IEnumerable end
The AFAggregateResultCollection type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Error |
The error that caused the entire aggregation to fail or if the entire aggregation did not fail.
|
| Item |
Gets the result by index.
The index positions will correspond to the order in which the requests were made.
|
| TotalCount |
The total count of items that were aggregated.
|
Methods
| Name | Description | |
|---|---|---|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetEnumerator |
Gets an enumerator to obtain all results in the order they were requested.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetResult(AFSummaryRequest) |
Gets the summary result for the specified request.
|
| GetResultTBin(AFBinningRequestTBin) |
Gets the binned result for the specified request.
|
| GetResultTGroup(AFGroupingRequestTGroup) |
Gets the grouped result for the specified request.
|
| GetResultT1, T2(AFCompoundPartitioningRequestT1, T2) |
Gets the result for a compound aggregate.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods
| Name | Description | |
|---|---|---|
  | ChunkedByAFAggregateResult |
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.) |