Click or drag to resize
OSIsoft, LLC

PIPointSummary Method

Returns several summaries over a single time range.

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version:
public IDictionary<AFSummaryTypes, AFValue> Summary(
	AFTimeRange timeRange,
	AFSummaryTypes summaryType,
	AFCalculationBasis calcBasis,
	AFTimestampCalculation timeType


Type: OSIsoft.AF.TimeAFTimeRange
The time range over which to compute the summary.
Type: OSIsoft.AF.DataAFSummaryTypes
A flag which specifies one or more summaries to compute over the time range.
Type: OSIsoft.AF.DataAFCalculationBasis
Specifies the method of evaluating the data over the time range.
Type: OSIsoft.AF.DataAFTimestampCalculation
A flag indicating what how to calculate a time stamp for each interval.

Return Value

Type: IDictionaryAFSummaryTypes, AFValue
A dictionary of AFValue, indexed by the specific AFSummaryTypes.
ArgumentOutOfRangeException The summaryType cannot be None.
PIExceptionError returned by the PI Data Archive.

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.

Note Notes to Callers
This method, property, or class is only available in the .NET 4 version of the SDK.

Version Information


Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5
See Also
Enabling Operational Intelligence