AFGroupedResult(TGroup) Class
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
The result of a histogram aggregate.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.Data.AggregateAFAggregateResult
OSIsoft.AF.Data.AggregateAFGroupedResultTGroup
OSIsoft.AF.Data.AggregateAFAggregateResult
OSIsoft.AF.Data.AggregateAFGroupedResultTGroup
Namespace: OSIsoft.AF.Data.Aggregate
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFGroupedResult<TGroup> : AFAggregateResult
Public NotInheritable Class AFGroupedResult(Of TGroup) Inherits AFAggregateResult Dim instance As AFGroupedResult(Of TGroup)
generic<typename TGroup> public ref class AFGroupedResult sealed : public AFAggregateResult
[<SealedAttribute>] type AFGroupedResult<'TGroup> = class inherit AFAggregateResult end
Type Parameters
- TGroup
- The type to convert the field values to and group by.
The AFGroupedResultTGroup type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Error |
If the aggregate could not be computed, the error property will be set
(Inherited from AFAggregateResult.) |
| GroupedResults |
The results keyed by the group and containing the requested summaries in a dictionary.
If a summary request was specified, value dictionaries will hold the count for each group.
|
| InvalidCount |
The weighted value of all bins whose field value was invalid.
|
| OutOfRangeCount |
The weighted value of all items that fell below the lowest bin.
Since field values are assigned the largest bin not greater than the value, any field value beyond the largest bin is assigned to the last bin.
|
| Request |
The aggregation request that this result was generated for.
(Inherited from AFAggregateResult.) |
| Results |
An enumerable suitable for serialization or display in the UI.
The Values could be another IEnumerable{KeyValuePair{object, object}}
(Inherited from AFAggregateResult.) |
Methods
| Name | Description | |
|---|---|---|
 | 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.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |