AFGroupingRequest(TGroup) Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines summaries to be performed on a grouped field.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.Data.AggregateAFAggregateRequest
OSIsoft.AF.Data.AggregateAFGroupingRequestTGroup
OSIsoft.AF.Data.AggregateAFAggregateRequest
OSIsoft.AF.Data.AggregateAFGroupingRequestTGroup
Namespace: OSIsoft.AF.Data.Aggregate
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFGroupingRequest<TGroup> : AFAggregateRequest
Public NotInheritable Class AFGroupingRequest(Of TGroup) Inherits AFAggregateRequest Dim instance As AFGroupingRequest(Of TGroup)
generic<typename TGroup> public ref class AFGroupingRequest sealed : public AFAggregateRequest
[<SealedAttribute>] type AFGroupingRequest<'TGroup> = class inherit AFAggregateRequest end
Type Parameters
- TGroup
- The type to convert the field values to and group by.
The AFGroupingRequestTGroup type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFGroupingRequestTGroup(String) |
Creates a histogram request on the specified field and using the specified bins.
|
| AFGroupingRequestTGroup(String, Int32) |
Creates a histogram request on the specified field and using the specified bins.
|
Properties
| Name | Description | |
|---|---|---|
 | Description |
A description of this aggregate.
(Overrides AFAggregateRequestDescription.) |
| Field |
The field that will be aggregated
(Inherited from AFAggregateRequest.) |
| MaximumGroups |
The maximum number of groups permitted. Any groups beyond this limit will register as out of range.
|
| SubAggregate |
The summary that will be performed on the grouped data.
(Overrides AFAggregateRequestSubAggregate.) |
| SummaryRequest |
The summary that should be performed on each group.
|
Methods
| Name | Description | |
|---|---|---|
| BinByTBin(String, IEnumerableTBin) |
Creates a compound grouping with this aggregate partitioned into bins of the specified field.
|
| BinByTBin(String, IEnumerableTBin, UOM) |
Creates a compound grouping with this aggregate partitioned into bins of the specified field.
|
| 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.) |
| GroupBy(String) |
Creates a compound grouping with this aggregate grouped by values of the specified field.
|
| GroupByTPrimaryGroup(String) |
Creates a compound grouping with this aggregate grouped by values of the specified field.
|
| GroupByTPrimaryGroup(String, Int32) |
Creates a compound grouping with this aggregate grouped by values of the specified field.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |