public IDictionary<AFSummaryTypes, AFValue> Summary( AFTimeRange timeRange, AFSummaryTypes summaryType, AFCalculationBasis calcBasis, AFTimestampCalculation timeType )
Public Function Summary ( timeRange As AFTimeRange, summaryType As AFSummaryTypes, calcBasis As AFCalculationBasis, timeType As AFTimestampCalculation ) As IDictionary(Of AFSummaryTypes, AFValue) Dim instance As PIPoint Dim timeRange As AFTimeRange Dim summaryType As AFSummaryTypes Dim calcBasis As AFCalculationBasis Dim timeType As AFTimestampCalculation Dim returnValue As IDictionary(Of AFSummaryTypes, AFValue) returnValue = instance.Summary(timeRange, summaryType, calcBasis, timeType)
public: IDictionary<AFSummaryTypes, AFValue^>^ Summary( AFTimeRange timeRange, AFSummaryTypes summaryType, AFCalculationBasis calcBasis, AFTimestampCalculation timeType )
member Summary : timeRange : AFTimeRange * summaryType : AFSummaryTypes * calcBasis : AFCalculationBasis * timeType : AFTimestampCalculation -> IDictionary<AFSummaryTypes, AFValue>
Count is the only summary type supported on non-numeric attributes. Requesting a summary for any other type will generate an error.
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 only available in the .NET 4 version of the SDK.|