The event-related commands
You can use event-related commands to perform actions on your event pool of the current activity. You can define input and composite events, control timers and timer events, manipulate events, and check whether an event has fired.
Use these commands to define user events other than activity
completion and timer events:
- DEFINE INPUT EVENT
- Defines an input event.
- DEFINE COMPOSITE EVENT
- Defines a composite event.
Use these commands to control timers and timer events:
- DEFINE TIMER
- Defines a timer, and associates an event with it.
- FORCE TIMER
- Forces early expiry of a timer, and causes the associated event of the timer to fire.
- CHECK TIMER
- Returns the status of a timer and, if the timer has expired, deletes its associated event.
- DELETE TIMER
- Deletes a timer and its associated event (if any).
Use these commands to manipulate events:
- ADD SUBEVENT
- Adds a subevent to a composite event.
- REMOVE SUBEVENT
- Removes a subevent from a composite event.
- DELETE EVENT
- Removes an input or composite event from the event pool of the
current activity.
Note: DELETE EVENT cannot be used to delete activity completion events (which are implicitly deleted when a response from the completed activity has been acknowledged by a CHECK ACTIVITY command, or when a DELETE ACTIVITY command is issued), timer events, or system events.
- RETRIEVE REATTACH EVENT
- Retrieves the name of an event that caused the current activity to be reattached and, if the event is atomic, resets its fire status to NOTFIRED.
- RETRIEVE SUBEVENT
- Retrieves the name of the next subevent in a subevent queue of the composite event, and resets the retrieved fire status of the sub-event to NOTFIRED.
Use this command to check whether an event has fired:
- TEST EVENT
- Tests whether an event has fired.