TimeArrived

(Engine-Level Function)

Description: Indicates whether a given time has occurred.
Returns: Boolean
Usage: Steady State only.
Function Groups: Time and Date
Related to: CurrentTime | TimeOut
Format: TimeArrived(TriggerTime)
Parameters:  
TriggerTime
Required. A UTC timestamp, specifying when the TimeArrived function will become true..

Example:

  If TimeArrived(Timestamp);
  [
    Timestamp = Invalid;
     ...
  ]

This statement will trigger when the current time reaches the specified timestamp (Timestamp must be changed or invalidated in the corresponding script, otherwise the statement will trigger repeatedly). This example is exactly equivalent to the hypothetical statement:

   If CurrentTime(1) >= Timestamp;

Except that CurrentTime may not be used in steady state.