Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFSummaryRequest.BinBy(TBin) Method (String, IEnumerable(TBin), UOM)

AFSummaryRequest.BinBy(TBin) Method (String, IEnumerable(TBin), UOM)

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFSummaryRequest.BinBy(TBin) Method (String, IEnumerable(TBin), UOM)
Creates a binning with this summary 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 AFBinningRequest<TBin> BinBy<TBin>(
	string field,
	IEnumerable<TBin> bins,
	UOM binUOM
)
where TBin : Object, IComparable<TBin>
Public Function BinBy(Of TBin As {Object, IComparable(Of TBin)}) ( 
	field As String,
	bins As IEnumerable(Of TBin),
	binUOM As UOM
) As AFBinningRequest(Of TBin)

Dim instance As AFSummaryRequest
Dim field As String
Dim bins As IEnumerable(Of TBin)
Dim binUOM As UOM
Dim returnValue As AFBinningRequest(Of TBin)

returnValue = instance.BinBy(field, bins, 
	binUOM)
public:
generic<typename TBin>
where TBin : Object, IComparable<TBin>
AFBinningRequest<TBin>^ BinBy(
	String^ field, 
	IEnumerable<TBin>^ bins, 
	UOM^ binUOM
)
member BinBy : 
        field : string * 
        bins : IEnumerable<'TBin> * 
        binUOM : UOM -> AFBinningRequest<'TBin>  when 'TBin : Object and IComparable<'TBin>

Parameters

field
Type: SystemString
The field whose values should be binned.
bins
Type: System.Collections.GenericIEnumerableTBin
The endpoints of the bins.
binUOM
Type: OSIsoft.AF.UnitsOfMeasureUOM
The units of measure for the bin values.

Type Parameters

TBin
The type of bins to partition by.

Return Value

Type: AFBinningRequestTBin
A summary request binned by values of the specified field.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9

See Also

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in