Click or drag to resize
OSIsoft, LLC

PIPointFilteredSummaries Method (IListAFTimeIntervalDefinition, Boolean, String, AFSummaryTypes, AFCalculationBasis, AFSampleType, AFTimeSpan, AFTimestampCalculation)

This method, when supplied a filter expression that evaluates to true or false, evaluates it over the time range on the passed in intervalDefinitions. For the time ranges where the expression evaluates to true, the method calculates the requested summaries on the PI point.

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.6.195
Syntax
public IDictionary<AFSummaryTypes, AFValues> FilteredSummaries(
	IList<AFTimeIntervalDefinition> intervalDefinitions,
	bool reverseTime,
	string filterExpression,
	AFSummaryTypes summaryType,
	AFCalculationBasis calcBasis,
	AFSampleType sampleType,
	AFTimeSpan sampleInterval,
	AFTimestampCalculation timeType
)

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.
filterExpression
Type: SystemString
A filter expression that follows the performance equation syntax.
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.
sampleType
Type: OSIsoft.AF.DataAFSampleType
Together with the sampleInterval, specifies how and how often the filter expression is evaluated.
sampleInterval
Type: OSIsoft.AF.TimeAFTimeSpan
When the sampleType is Interval, it specifies how often the filter expression is evaluated when computing the summary for an interval.
timeType
Type: OSIsoft.AF.DataAFTimestampCalculation
An enumeration value that specifies how the time stamp is calculated.

Return Value

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

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 user 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

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