AFDataReference.SummaryAsync Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Returns several summaries for a single attribute over a single time range.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public virtual Task<IDictionary<AFSummaryTypes, AFValue>> SummaryAsync( AFTimeRange timeRange, AFSummaryTypes summaryType, AFCalculationBasis calculationBasis, AFTimestampCalculation timeType, CancellationToken cancellationToken )
Public Overridable Function SummaryAsync ( timeRange As AFTimeRange, summaryType As AFSummaryTypes, calculationBasis As AFCalculationBasis, timeType As AFTimestampCalculation, cancellationToken As CancellationToken ) As Task(Of IDictionary(Of AFSummaryTypes, AFValue)) Dim instance As AFDataReference Dim timeRange As AFTimeRange Dim summaryType As AFSummaryTypes Dim calculationBasis As AFCalculationBasis Dim timeType As AFTimestampCalculation Dim cancellationToken As CancellationToken Dim returnValue As Task(Of IDictionary(Of AFSummaryTypes, AFValue)) returnValue = instance.SummaryAsync(timeRange, summaryType, calculationBasis, timeType, cancellationToken)
public: virtual Task<IDictionary<AFSummaryTypes, AFValue^>^>^ SummaryAsync( AFTimeRange timeRange, AFSummaryTypes summaryType, AFCalculationBasis calculationBasis, AFTimestampCalculation timeType, CancellationToken cancellationToken )
abstract SummaryAsync : timeRange : AFTimeRange * summaryType : AFSummaryTypes * calculationBasis : AFCalculationBasis * timeType : AFTimestampCalculation * cancellationToken : CancellationToken -> Task<IDictionary<AFSummaryTypes, AFValue>> override SummaryAsync : timeRange : AFTimeRange * summaryType : AFSummaryTypes * calculationBasis : AFCalculationBasis * timeType : AFTimestampCalculation * cancellationToken : CancellationToken -> Task<IDictionary<AFSummaryTypes, AFValue>>
Parameters
- timeRange
- Type: OSIsoft.AF.TimeAFTimeRange
The time range over which to compute the summary. - summaryType
- Type: OSIsoft.AF.DataAFSummaryTypes
A flag which specifies one or more summaries to compute over the time range. - calculationBasis
- Type: OSIsoft.AF.DataAFCalculationBasis
Specifies the method of evaluating the data over the time range. - timeType
- Type: OSIsoft.AF.DataAFTimestampCalculation
A flag indicating what how to calculate a timestamp for each interval. - cancellationToken
- Type: System.ThreadingCancellationToken
A cancellation token used to abort processing before completion. Passing the default CancellationToken.None will run to completion or until the PIConnectionInfo.OperationTimeOut period elapses.
Return Value
Type: TaskIDictionaryAFSummaryTypes, AFValueReturns a task whose result is a dictionary of AFValue, indexed by the specific AFSummaryTypes.
Exceptions
| Exception | Condition |
|---|---|
| AggregateException | Asynchronous methods throw AggregateException on failure which will contain one or more exceptions containing the failure. |
Remarks
| 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. |