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

AF SDK Reference

AFAggregate.GroupedSummaryAsync(T) Method

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFAggregate.GroupedSummaryAsync(T) Method
Generates a histogram for the specified items asynchronously.

Namespace:  OSIsoft.AF.Data.Aggregate
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public static Task<AFGroupedResult<Object>> GroupedSummaryAsync<T>(
	this IEnumerable<T> items,
	string groupedField,
	string summaryField,
	AFSummaryTypes summaryTypes,
	CancellationToken cancellationToken
)
where T : AFObject
<ExtensionAttribute>
Public Shared Function GroupedSummaryAsync(Of T As AFObject) ( 
	items As IEnumerable(Of T),
	groupedField As String,
	summaryField As String,
	summaryTypes As AFSummaryTypes,
	cancellationToken As CancellationToken
) As Task(Of AFGroupedResult(Of Object))

Dim items As IEnumerable(Of T)
Dim groupedField As String
Dim summaryField As String
Dim summaryTypes As AFSummaryTypes
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of AFGroupedResult(Of Object))

returnValue = items.GroupedSummaryAsync(groupedField, 
	summaryField, summaryTypes, cancellationToken)
public:
[ExtensionAttribute]
generic<typename T>
where T : AFObject
static Task<AFGroupedResult<Object^>^>^ GroupedSummaryAsync(
	IEnumerable<T>^ items, 
	String^ groupedField, 
	String^ summaryField, 
	AFSummaryTypes summaryTypes, 
	CancellationToken cancellationToken
)
[<ExtensionAttribute>]
static member GroupedSummaryAsync : 
        items : IEnumerable<'T> * 
        groupedField : string * 
        summaryField : string * 
        summaryTypes : AFSummaryTypes * 
        cancellationToken : CancellationToken -> Task<AFGroupedResult<Object>>  when 'T : AFObject

Parameters

items
Type: System.Collections.GenericIEnumerableT
The items that should be summarized.
groupedField
Type: SystemString
The field whose value should be grouped.
summaryField
Type: SystemString
The field that should be summarized for each group.
summaryTypes
Type: OSIsoft.AF.DataAFSummaryTypes
The types of summaries to perform for each group.
cancellationToken
Type: System.ThreadingCancellationToken
A token to control cancellation of the aggregation request.

Type Parameters

T
The type of items to summarize

Return Value

Type: TaskAFGroupedResultObject
A result containing the grouped summary or an error if the summaries could not be performed.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableT. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Note Notes to Callers
This call might use a background task to complete some of its work. See the Threading Overview for some matters to consider when execution transitions to another thread.

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