PIPoint.Summaries Method (IList(AFTimeIntervalDefinition), Boolean, AFSummaryTypes, AFCalculationBasis, AFTimestampCalculation)

public IDictionary<AFSummaryTypes, AFValues> Summaries(
	IList<AFTimeIntervalDefinition> intervalDefinitions,
	bool reverseTime,
	AFSummaryTypes summaryType,
	AFCalculationBasis calcBasis,
	AFTimestampCalculation timeType
)

Public Function Summaries ( 
	intervalDefinitions As IList(Of AFTimeIntervalDefinition),
	reverseTime As Boolean,
	summaryType As AFSummaryTypes,
	calcBasis As AFCalculationBasis,
	timeType As AFTimestampCalculation
) As IDictionary(Of AFSummaryTypes, AFValues)

Dim instance As PIPoint
Dim intervalDefinitions As IList(Of AFTimeIntervalDefinition)
Dim reverseTime As Boolean
Dim summaryType As AFSummaryTypes
Dim calcBasis As AFCalculationBasis
Dim timeType As AFTimestampCalculation
Dim returnValue As IDictionary(Of AFSummaryTypes, AFValues)

returnValue = instance.Summaries(intervalDefinitions, 
	reverseTime, summaryType, calcBasis, 
	timeType)

public:
IDictionary<AFSummaryTypes, AFValues^>^ Summaries(
	IList<AFTimeIntervalDefinition>^ intervalDefinitions, 
	bool reverseTime, 
	AFSummaryTypes summaryType, 
	AFCalculationBasis calcBasis, 
	AFTimestampCalculation timeType
)

member Summaries : 
        intervalDefinitions : IList<AFTimeIntervalDefinition> * 
        reverseTime : bool * 
        summaryType : AFSummaryTypes * 
        calcBasis : AFCalculationBasis * 
        timeType : AFTimestampCalculation -> IDictionary<AFSummaryTypes, AFValues> 

Parameters

intervalDefinitions

Type: System.Collections.GenericIListAFTimeIntervalDefinition
The list of time interval definitions used to produce the summary. The Range of each time interval definition within the list must be in consecutive order to produce the expected result. Any overlaps or gaps in the intervals will be ignored.

reverseTime

Type: SystemBoolean
If set to , the results in each collection of AFValues will be returned in reverse order.

summaryType

Type: OSIsoft.AF.DataAFSummaryTypes
A flag which specifies one or more summaries to compute for each interval over the time range

calcBasis

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 time stamp for each interval.

Return Value

Time-weighted totals are computed by integrating the rate tag values over the requested time range. If some of the data are bad in the time range, the calculated total is divided by the fraction of the time period for which there are good values. Mathematically, this approach is equivalent to assuming that during the period of bad data, the tag takes on the average values for the entire calculation time range. The use can use the PercentGood summary to determine if the calculation results are suitable for the application's purposes.

Notes to Callers
This method, property, or class is not available in the legacy .NET 3.5 version of the SDK.

AFSDK

Reference