Click or drag to resize
OSIsoft, LLC

AFDataSummary Method

Returns several summaries for a single attribute over a single time range.

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

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

Return Value

Type: IDictionaryAFSummaryTypes, AFValue
A dictionary of AFValue, indexed by the specific AFSummaryTypes.
Exceptions
ExceptionCondition
ArgumentOutOfRangeException The summaryType cannot be None.
NotSupportedException The data reference does not support this method.
Remarks

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 PercentGood summary can be used to determine if the calculation results are suitable for the application's purposes.

For time-weight totals, if the time unit rate of the attribute cannot be determined, then the value will be totaled assuming a unit of "per day" and no unit of measure will be assigned to the value. If the measured time component of the tag is not based on a day, the user of the data must convert the totalized value to the correct units. For example, if the rate tag was gallons/minute, the conversion can be accomplished using UOMDatabase.UOMs["minute"].Convert(value, UOMDatabase.UOMs["day"].

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

Security note Security Note
You must have ReadData security rights to read a data value.

Version Information

AFSDK

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