AFBinningRequest(TBin).BinBy(TPrimaryBin) Method (String, IEnumerable(TPrimaryBin), UOM)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Creates a compound grouping with this aggregate partitioned into bins of the specified field.
Namespace: OSIsoft.AF.Data.Aggregate
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFCompoundPartitioningRequest<AFRange<TPrimaryBin>, AFRange<TBin>> BinBy<TPrimaryBin>( string field, IEnumerable<TPrimaryBin> bins, UOM binUOM ) where TPrimaryBin : Object, IComparable<TPrimaryBin>
Public Function BinBy(Of TPrimaryBin As {Object, IComparable(Of TPrimaryBin)}) ( field As String, bins As IEnumerable(Of TPrimaryBin), binUOM As UOM ) As AFCompoundPartitioningRequest(Of AFRange(Of TPrimaryBin), AFRange(Of TBin)) Dim instance As AFBinningRequest Dim field As String Dim bins As IEnumerable(Of TPrimaryBin) Dim binUOM As UOM Dim returnValue As AFCompoundPartitioningRequest(Of AFRange(Of TPrimaryBin), AFRange(Of TBin)) returnValue = instance.BinBy(field, bins, binUOM)
public: generic<typename TPrimaryBin> where TPrimaryBin : Object, IComparable<TPrimaryBin> AFCompoundPartitioningRequest<AFRange<TPrimaryBin>^, AFRange<TBin>^>^ BinBy( String^ field, IEnumerable<TPrimaryBin>^ bins, UOM^ binUOM )
member BinBy : field : string * bins : IEnumerable<'TPrimaryBin> * binUOM : UOM -> AFCompoundPartitioningRequest<AFRange<'TPrimaryBin>, AFRange<'TBin>> when 'TPrimaryBin : Object and IComparable<'TPrimaryBin>
Parameters
- field
- Type: SystemString
The field whose values should be binned. - bins
- Type: System.Collections.GenericIEnumerableTPrimaryBin
The endpoints of the bins. - binUOM
- Type: OSIsoft.AF.UnitsOfMeasureUOM
The units of measure for the bin values.
Type Parameters
- TPrimaryBin
- The type of bins to partition by.
Return Value
Type: AFCompoundPartitioningRequestAFRangeTPrimaryBin, AFRangeTBinAn aggregate request grouped by a compound key of two fields.