PIPointList.Summary Method

public IEnumerable<IDictionary<AFSummaryTypes, AFValue>> Summary(
	AFTimeRange timeRange,
	AFSummaryTypes summaryTypes,
	AFCalculationBasis calculationBasis,
	AFTimestampCalculation timeType,
	PIPagingConfiguration pagingConfig
)

Public Function Summary ( 
	timeRange As AFTimeRange,
	summaryTypes As AFSummaryTypes,
	calculationBasis As AFCalculationBasis,
	timeType As AFTimestampCalculation,
	pagingConfig As PIPagingConfiguration
) As IEnumerable(Of IDictionary(Of AFSummaryTypes, AFValue))

Dim instance As PIPointList
Dim timeRange As AFTimeRange
Dim summaryTypes As AFSummaryTypes
Dim calculationBasis As AFCalculationBasis
Dim timeType As AFTimestampCalculation
Dim pagingConfig As PIPagingConfiguration
Dim returnValue As IEnumerable(Of IDictionary(Of AFSummaryTypes, AFValue))

returnValue = instance.Summary(timeRange, 
	summaryTypes, calculationBasis, 
	timeType, pagingConfig)

public:
IEnumerable<IDictionary<AFSummaryTypes, AFValue^>^>^ Summary(
	AFTimeRange timeRange, 
	AFSummaryTypes summaryTypes, 
	AFCalculationBasis calculationBasis, 
	AFTimestampCalculation timeType, 
	PIPagingConfiguration^ pagingConfig
)

member Summary : 
        timeRange : AFTimeRange * 
        summaryTypes : AFSummaryTypes * 
        calculationBasis : AFCalculationBasis * 
        timeType : AFTimestampCalculation * 
        pagingConfig : PIPagingConfiguration -> IEnumerable<IDictionary<AFSummaryTypes, AFValue>> 

Parameters

timeRange

Type: OSIsoft.AF.TimeAFTimeRange
The time range over which to compute the summary.

summaryTypes

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

calculationBasis

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.

pagingConfig

Type: OSIsoft.AF.PIPIPagingConfiguration
Contains the paging configuration parameters for the request.

Return Value

An enumerable of summary results for each PIPoint in the list. The results are not guaranteed to match the order of the PIPointList, and duplicate points in the list will not produce a duplicate result. The results can be mapped back to the corresponding PI Point using the PIPoint property on each result.

The order of the results are predictable; however, if you need the results in the same order as the attribute list, then consider using a dictionary keyed by PI Point to construct a list in the same order.

The points in the list are broken up by their corresponding PI Data Archive. A bulk call is made against each PI Data Archive in parallel. The results are made available as they are returned from the PI Data Archive in the order that the bulk calls were made.

The following example shows a list of points including duplicates from three different PI Data Archives:

This table shows the order that the results would be returned:

Since the first point is on the Contoso PI Data Archive, it is the first PI Data Archive to receive a bulk call; therefore, all Contoso point results will be returned first. Duplicate points do not produce a duplicate result, so the duplicate Contoso Lobby_Room_Temperature does not produce a second return value. After the Contoso results have been returned, the Northwind results are returned followed by the AdventureWorks results.

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 not available in the legacy .NET 3.5 version of the SDK.

Important
This method will use a single bulk Remote Procedure Call if the PI Data Archive supports it, otherwise it will issue individual RPCs in parallel. Results are available for enumeration as they returned from the PI Data Archive.

Important
When individual RPCs are issued in parallel, each RPC is made using the caller's security context. When making these calls while impersonating, the thread or runtime must be configured to propagate the impersonation across these asynchronous points (see the SecurityContext documentation for details).

Important
The returned enumerable collection can be enumerated one time. As the collection is enumerated, the internal data structures are disposed. Any attempt to reset or enumerate a second time will result in an exception.

Notes to Callers
This call might use a background task to complete some of its work. See the Threading Overview for some matters to consider when execution transitions to another thread.

AFSDK

Reference