AFData.SummariesAsync Method

public Task<IDictionary<AFSummaryTypes, AFValues>> SummariesAsync(
	AFTimeRange timeRange,
	AFTimeSpan summaryDuration,
	AFSummaryTypes summaryType,
	AFCalculationBasis calculationBasis,
	AFTimestampCalculation timeType,
	CancellationToken cancellationToken = default
)

Public Function SummariesAsync ( 
	timeRange As AFTimeRange,
	summaryDuration As AFTimeSpan,
	summaryType As AFSummaryTypes,
	calculationBasis As AFCalculationBasis,
	timeType As AFTimestampCalculation,
	Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IDictionary(Of AFSummaryTypes, AFValues))

Dim instance As AFData
Dim timeRange As AFTimeRange
Dim summaryDuration As AFTimeSpan
Dim summaryType As AFSummaryTypes
Dim calculationBasis As AFCalculationBasis
Dim timeType As AFTimestampCalculation
Dim cancellationToken As CancellationToken
Dim returnValue As Task(Of IDictionary(Of AFSummaryTypes, AFValues))

returnValue = instance.SummariesAsync(timeRange, 
	summaryDuration, summaryType, calculationBasis, 
	timeType, cancellationToken)

public:
Task<IDictionary<AFSummaryTypes, AFValues^>^>^ SummariesAsync(
	AFTimeRange timeRange, 
	AFTimeSpan summaryDuration, 
	AFSummaryTypes summaryType, 
	AFCalculationBasis calculationBasis, 
	AFTimestampCalculation timeType, 
	CancellationToken cancellationToken = CancellationToken()
)

member SummariesAsync : 
        timeRange : AFTimeRange * 
        summaryDuration : AFTimeSpan * 
        summaryType : AFSummaryTypes * 
        calculationBasis : AFCalculationBasis * 
        timeType : AFTimestampCalculation * 
        ?cancellationToken : CancellationToken 
(* Defaults:
        let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IDictionary<AFSummaryTypes, AFValues>> 

Parameters

timeRange

Type: OSIsoft.AF.TimeAFTimeRange
The bounding time range over which the summary intervals are computed.

summaryDuration

Type: OSIsoft.AF.TimeAFTimeSpan

The duration of each summary interval. If specified in hours, minutes, seconds, or milliseconds, the summary durations will be evenly spaced UTC time intervals. Longer interval types are interpreted using wall clock rules and are time zone dependent. For example, an interval created with the string "24h" means using an evenly spaced 24 UTC hour interval between each event. On the other hand, an interval created with the string "1d" would return an interval shorter or longer than 24 hours if the interval encompasses a Daylight Savings Time change.

When a positive duration is specified, the summary calculation begins at the earliest bounding time in the timeRange and applies the duration repeatedly in time ascending direction to generate the summary intervals.

If a negative duration is specified, the summary calculation begins at the latest bounding time in the timeRange and applies the duration repeatedly in time descending direction to generate the summary intervals. Note that the order of values returned will still be reflected by the timeRange, regardless of the summary duration sign.

summaryType

Type: OSIsoft.AF.DataAFSummaryTypes
A flag which specifies one or more summaries to compute for each interval 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 (Optional)

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

AFSDK

Reference