Click or drag to resize
OSIsoft, LLC

AFAnalysisServiceQueueCalculation Method

This method queues analyses for calculation on PI Analysis Service for the given time range and mode.

Namespace:  OSIsoft.AF.Analysis
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.8.440
Syntax
public Object QueueCalculation(
	IEnumerable<AFAnalysis> analyses,
	AFTimeRange timeRange,
	AFAnalysisServiceCalculationMode mode
)

Parameters

analyses
Type: System.Collections.GenericIEnumerableAFAnalysis
Analyses to queue for calculation. Cannot be null nor empty.
timeRange
Type: OSIsoft.AF.TimeAFTimeRange
Time range to calculate.
mode
Type: OSIsoft.AF.AnalysisAFAnalysisServiceCalculationMode
Calculation mode to specify what to do with the existing data.

Return Value

Type: Object
A handle to the queued calculations.
Exceptions
ExceptionCondition
InvalidOperationExceptionThis exception is thrown when connection to the analysis service fails for any reason.
ArgumentNullExceptionThis exception is thrown when analyses is null.
ArgumentExceptionThis exception is thrown when the start time of timeRange is after its end time.
Remarks

This method queues the list of analyses on the analysis service service to be calculated. The operation is asynchronous and returning of the method does not indicate that queued analyses were calculated. The status can be queried in the upcoming releases using the returned handle.

Security note Security Note
You must have Execute security rights to queue a calculation.

Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5
See Also
Enabling Operational Intelligence