AFSummaryRequest Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines a set of summaries to perform on a set of objects.
Inheritance Hierarchy
Namespace: OSIsoft.AF.Data.Aggregate
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFSummaryRequest : AFAggregateRequest
Public NotInheritable Class AFSummaryRequest Inherits AFAggregateRequest Dim instance As AFSummaryRequest
public ref class AFSummaryRequest sealed : public AFAggregateRequest
[<SealedAttribute>] type AFSummaryRequest = class inherit AFAggregateRequest end
The AFSummaryRequest type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFSummaryRequest(String, AFSummaryTypes) |
Computes desired summaries on the specified field.
|
| AFSummaryRequest(String, AFSummaryTypes, String) |
Computes desired summaries on the specified field and weighted by the specified field.
|
Properties
| Name | Description | |
|---|---|---|
 | Description |
A description of the summary.
(Overrides AFAggregateRequestDescription.) |
| Field |
The field that will be aggregated
(Inherited from AFAggregateRequest.) |
| SubAggregate |
If this aggregate will be further aggregated, the sub-aggregate is defined here.
(Inherited from AFAggregateRequest.) |
| SummaryTypes |
The requested summary types.
|
| WeightField |
The field used in weighting each item.
If null, no weighting will be applied.
|
Methods
| Name | Description | |
|---|---|---|
| BinByTBin(String, IEnumerableTBin) |
Creates a binning with this summary partitioned into bins of the specified field.
|
| BinByTBin(String, IEnumerableTBin, UOM) |
Creates a binning with this summary 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 grouping with this summary grouped by values of the specified field.
|
| GroupByTGroup(String) |
Creates a grouping with this summary grouped by values of the specified field.
|
| GroupByTGroup(String, Int32) |
Creates a grouping with this summary grouped by values of the specified field.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |