AFBinningRequest(TBin) Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines a histogram to build from a set of objects.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.Data.AggregateAFAggregateRequest
OSIsoft.AF.Data.AggregateAFBinningRequestTBin
OSIsoft.AF.Data.AggregateAFAggregateRequest
OSIsoft.AF.Data.AggregateAFBinningRequestTBin
Namespace: OSIsoft.AF.Data.Aggregate
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public sealed class AFBinningRequest<TBin> : AFAggregateRequest where TBin : Object, IComparable<TBin>
Public NotInheritable Class AFBinningRequest(Of TBin As {Object, IComparable(Of TBin)}) Inherits AFAggregateRequest Dim instance As AFBinningRequest(Of TBin)
generic<typename TBin> where TBin : Object, IComparable<TBin> public ref class AFBinningRequest sealed : public AFAggregateRequest
[<SealedAttribute>] type AFBinningRequest<'TBin when 'TBin : Object and IComparable<'TBin>> = class inherit AFAggregateRequest end
Type Parameters
- TBin
- The type of bin that the object field will be sorted in.
The AFBinningRequestTBin type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AFBinningRequestTBin(String, IEnumerableTBin) |
Creates a histogram request on the specified field and using the specified bins.
|
| AFBinningRequestTBin(String, IEnumerableTBin, UOM) |
Creates a histogram request on the specified field and using the specified bins.
|
Properties
| Name | Description | |
|---|---|---|
 | Bins |
The bins use for the histogram.
|
| BinUOM |
The unit of measure of the bins.
|
| Description |
A description of this aggregate.
(Overrides AFAggregateRequestDescription.) |
| Field |
The field that will be aggregated
(Inherited from AFAggregateRequest.) |
| SubAggregate |
The summary that will be performed on the binned data.
(Overrides AFAggregateRequestSubAggregate.) |
| SummaryRequest |
The summary that will be performed on each bin or if only a count is desired.
|
Methods
| Name | Description | |
|---|---|---|
| BinByTPrimaryBin(String, IEnumerableTPrimaryBin) |
Creates a compound grouping with this aggregate partitioned into bins of the specified field.
|
| BinByTPrimaryBin(String, IEnumerableTPrimaryBin, 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.
|
| GroupByTGroup(String) |
Creates a compound grouping with this aggregate grouped by values of the specified field.
|
| GroupByTGroup(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.) |