Function & Argument Type(s)

Description

Example

cancelSimEvent

(String block_name, String name, int id)

Cancel a scheduled delay in the TIMEQ of a Script or Smart_Controller block.  The block_name is the name of the Script block; name is the TIMEQ name and the id is the unique identifier for the scheduled event. Returns true if the scheduled simulation event exists.  Else false

test  =  cancelSimEvent ("VM1","TQ1",234)

cancelSimEvent

(String block_name, String name, double time)

Cancel a scheduled delay in the TIMEQ of a Script or Smart_Controller block.  The block_name is the name of the Script; name is the TIMEQ name and the time is in seconds, where the time is added to the current time. The unique scheduled event is the one at that time- TNOW + time. Returns true if the scheduled simulation event exists.  Else false

test  =  cancelSimEvent ("VM1","TQ1",24.5)

cancelSimEvent

(String block_name, String name)

Cancel a scheduled delay in the TIMEQ of a Script or Smart_Controller block, and disable an active WAIT in the Script or Smart_Controller block.  The block_name is the name of the Script; and the name is the TIMEQ name.  For the WAIT, the name can be any string value. Returns true if the scheduled simulation event exists.  Else false

test  =  cancelSimEvent ("VM1","TQ1")

StringName.event()

Generate an event named “My_Event_Name” by appending event() to the name.  This is faster than newEvent(“My_Event_Name”) RegEx function.

StringName  =  “My_Event_Name”

StringName.event()

newEvent

(string Event Name)

Return Type: None

Create an event in any block. Can combine a parameter + string to equate to a string. 

newEvent(“Clock”)

WAIT

(string Event Name)

Return Type: None

Used in Script block to wait on a event. 

WAIT("Clock")