CALCONDEMANDSTAT action

Function
Recalculation (calculation) of the values of:
  • statistical historical value
  • calculated historical value
statistical historical value or a calculated historical value - the parameter Compute on demand must be checked in its configuration.
Declaration
 CALCONDEMANDSTAT archIdent, timeFromIdent_TmA, timeToIdent_TmA, bCalcDepend[, statusIdent_Int]
Parameters
archIdentinReference to one value of historical value, column or row of structured historical value (see Note).
timeFromItemIdent_TmAinIdentifier of AbsTime type - interval beginning.
timeToItemIdent_TmAinIdentifier of AbsTime type - interval end.
bCalcDependinIdentifier of Bool type - recalculation of dependent OnDemand archives.
statusIdent_IntoutCalculation (action) success.
Description

The action sends requests to the D2000 Archiv process to recalculate the statistical values of:

  1. one historical value (archIdent) - the value of the parameter bCalcDepend = @FALSE. The Archiv process will calculate only the specified historical value (archIdent),
  2. one historical value (archIdent) and all the historical values depending on it (in dependence on a value of the parameter bCalcDepend) - the value of the parameter bCalcDepend = @TRUE. The D2000 Archiv process will calculate the specified object (archIdent) and all archive objects that directly or indirectly depend on it.

All the calculations are being executed for the time interval specified by the parameters timeFromIdent_TmA and timeToIdent_TmA.
Note: future calculations are disabled, if timeToIdent_TmA is also greater than the current time, only upto the current time is calculated.

If the optional parameter statusIdent_Int is entered, the action will be terminated after terminating all required calculations on the Archiv process.

The parameter statusIdent_Int can get one of the following values:

  • _ERR_TRANS_ABORT
  • _ERR_TRANS_ERROR
  • _ERR_TRANS_IGNORED
  • _ERR_NO_ERROR
Note
The archIdent parameter can also contain the reference to a part (row or column) or entire structured historical value.
Example:
  • H.ColArchiv - reference to the entire structured historical value
  • H.ColArchiv[2] - reference to all values of structured historical value within the row of 2
  • H.ColArchiv^ColName - reference to all values of structured historical value within the ColName column
Example
 TIME _bt 
 TIME _et 
 INT  _retCode 
 
 _bt := %StrToTime("00:00:00 16-10-2003")
 _et := %StrToTime("00:00:00 17-10-2003")
 
 CALCONDEMANDSTAT H.Primary, _bt, _et, @FALSE, _retCode
 
IF _retCode = _ERR_NO_ERROR THEN
   ; calculation executed
 ELSE
   ; an error occurred
 ENDIF

Related pages:

Script actions

Napíšte komentár