Overview

Events allow a specific action to automatically execute when a condition is satisfied.

Up to maxEvents events may be defined at any time.

The following figure shows the parts that comprise an event.

../_images/WMXDOC_FUNC_EVT_image0.png

Event ID

The Event ID is an identification number that uniquely identifies an event.

For detailed specifications, see ID Numbers.

Event Input

The event input is represented by the EventInput class.

This defines the condition that will trigger the event. One of several classes that inherit EventInput is used (the EventInput class cannot be directly instantiated). Each class is defined in a separate module, and contains several types of conditions.

These classes are shown in the following figure.

../_images/WMXDOC_FUNC_EVT_image1.png

A description of each class and the input types defined in that class are listed below.

Event Output

The event output is represented by the EventOutput class.

This defines the action to execute when the event triggers. One of several classes that inherit EventOutput is used (the EventOutput class cannot directly be instantiated). Each class is defined in a separate module, and contains several types of actions.

These classes are shown in the following figure.

../_images/WMXDOC_FUNC_EVT_image2.png

A description of each class and the output types defined in that class are listed below.

Event Option

Event options are specified using the EventOption class.

This class is optional and may be omitted when defining the event, in which case the event will be defined with all options disabled.

Note that if the event is defined without setting the enable option, the event will not trigger until it is enabled with the EnableEvent function.

After defining the above values, the event can be registered with the SetEvent function.