Class EventOption

• Defined in File EventApi.h

Class Documentation

class EventOption

This class contains the options of an event.

Public Functions

EventOption()

Public Members

bool singleShot

If this value is set to 1, the event will automatically clear itself after it is triggered. The event ID of that event may be reused by a newly defined event. The event will not clear itself if the event output function failed to execute because of an error, so that the event can attempt to execute the output function again during the next communication cycle. If this value is set to 0, the event will not clear itself.

bool disableAfterActivate

If this value is set to 1, the enabled state of the event will automatically change to 0 after it is triggered. The event will remain defined, but will not trigger again until it is reenabled with the EnableEvent function. The event will not disable itself if the event output function failed to execute because of an error, so that the event can attempt to execute the output function again during the next communication cycle. If this value is set to 0, the event will remain enabled after it is triggered. The event may trigger again if the event condition becomes FALSE, and then becomes TRUE again.

bool enable

If this value is set to 1, the event will start enabled after being defined. The event may immediately trigger. If this value is set to 0, the event will start disabled and must be enabled with the EnableEvent function before it can trigger.