Class EventApiEventInput

• Defined in File EventApi.h

Nested Relationships

Nested Types

• Union EventApiEventInput::InputFunctionArguments

Inheritance Relationships

Base Type

• public EventInput (Class EventInput)

Class Documentation

class EventApiEventInput : public EventInput

This class defines event input functions that can be processed by the Event module. Also see Event Inputs.

Public Types

enum EventApiEventInputType

This enumerator class enumerates the types of event input functions that can be processed by this module.

Values:

enumerator None

The input function has no condition. The event never triggers.

enumerator AnotherEvent

This input function triggers the event when another event triggers. This event also triggers if the condition for the other event is satisfied at the time that this event is enabled.

The parameters for this input function are specified in the AnotherEvent structure of input.

enumerator DelayAnotherEvent

This input function triggers the event when the input function of another event remains continuously triggered for the specified amount of time.

The parameters for this input function are specified in the DelayAnotherEvent structure of input.

enumerator OrEvent

This input function triggers the event when either of two other events triggers.

The parameters for this input function are specified in the OrEvent structure of input.

enumerator AndEvent

This input function triggers the event when both of two other events trigger.

The parameters for this input function are specified in the AndEvent structure of input.

enumerator XorEvent

This input function triggers the event when one but not both of two other events triggers.

The parameters for this input function are specified in the XorEvent structure of input.

enumerator DeviceCloseEvent

This input function triggers the event when the specified device closes.

The parameters for this input function are specified in the DeviceCloseEvent structure of input.

enumerator DeviceTimeoutEvent

This input function triggers the event when the watchdog timer of the specified device indicates that the device has timed out.

The parameters for this input function are specified in the DeviceTimeoutEvent structure of input.

Public Functions

EventApiEventInput()

virtual int GetInputModuleId()

Return the ModuleId of the Event module.

virtual WMX3APIFUNC GetInputData(unsigned char *buff, int buffSize, int *dataSize, char *initialState)

Convert the values specified in other member variables of the class inheriting this class to a binary representation that can be sent to the engine.

Convert the values specified in other member variables of the class inheriting this class to a binary representation that can be sent to the engine.

Parameters:

• buff – [out] A pointer to a buffer that will contain the binary representation of the member variables.

• buffSize – [in] The size of the buffer in bytes.

• dataSize – [out] A pointer to an int that will contain the size of the binary representation of the member variables, in bytes. This size of the buffer will be occupied.

• initialState – [out] A pointer to a char that will contain the initialState (triggered or untriggered) of the input function. This determines whether the event can trigger when the event is enabled.

virtual WMX3APIFUNC SetInputData(int moduleId, unsigned char *data, int dataSize)

Convert the binary representation of the values specified in other members of the class inheriting this class and copies them back to the other members.

Convert the binary representation of the values specified in other members of the class inheriting this class and copies them back to the other members.

Parameters:

• moduleId – [in] The ID of the module that defines the binary representation of the member variables.

• data – [in] A pointer to a buffer that contains the binary representation of the member variables.

• dataSize – [in] The size of the buffer in bytes.

Public Members

EventApiEventInputType inputFunction

Specifies the event input function.

union wmx3Api::EventApiEventInput::InputFunctionArguments input

Specifies the arguments for the event input function.

union InputFunctionArguments

This union defines the structs containing arguments for each input function.

Public Functions

InputFunctionArguments()

Public Members

struct wmx3Api::EventApiEventInput::InputFunctionArguments::None none

struct wmx3Api::EventApiEventInput::InputFunctionArguments::AnotherEvent anotherEvent

struct wmx3Api::EventApiEventInput::InputFunctionArguments::DelayAnotherEvent delayAnotherEvent

struct wmx3Api::EventApiEventInput::InputFunctionArguments::OrEvent orEvent

struct wmx3Api::EventApiEventInput::InputFunctionArguments::AndEvent andEvent

struct wmx3Api::EventApiEventInput::InputFunctionArguments::XorEvent xorEvent

struct wmx3Api::EventApiEventInput::InputFunctionArguments::DeviceCloseEvent deviceCloseEvent

struct wmx3Api::EventApiEventInput::InputFunctionArguments::DeviceTimeoutEvent deviceTimeoutEvent

struct AndEvent

This structure contains arguments for the AndEvent input function.

Public Members

unsigned int eventID[2]

The event ID of the two other events.

unsigned char invert[2]

If set to 1, the triggered state for the other event of that index is inverted. If set to 0, the triggered state is processed normally.

unsigned char invertResult

If set to 1, the condition for this event to trigger is inverted. If set to 0, this event triggers normally.

struct AnotherEvent

This structure contains arguments for the AnotherEvent input function.

Public Members

unsigned int eventID

The event ID of the other event.

unsigned char invert

If set to 1, this event will trigger when the condition for the other event is not satisfied. If set to 0, this event triggers normally.

struct DelayAnotherEvent

This structure contains arguments for the DelayAnotherEvent input function.

Public Members

unsigned int eventID

The event ID of the other event.

unsigned char invert

If set to 1, this event will trigger when the condition for the other event is not satisfied for the specified time. If set to 0, this event triggers normally.

unsigned int delayTime

The time that the other event remains triggered until this event is triggered, in milliseconds.

struct DeviceCloseEvent

This structure contains arguments for the DeviceCloseEvent input function.

Public Members

int deviceId

The device ID number of the device that triggers the event.

struct DeviceTimeoutEvent

This structure contains arguments for the DeviceTimeoutEvent input function.

Public Members

int deviceId

The device ID number of the device that triggers the event.

struct None

This structure contains arguments for the None input function.

Public Members

unsigned int reserved

Reserved.

struct OrEvent

This structure contains arguments for the OrEvent input function.

Public Members

unsigned int eventID[2]

The event ID of the two other events.

unsigned char invert[2]

If set to 1, the triggered state for the other event of that index is inverted. If set to 0, the triggered state is processed normally.

unsigned char invertResult

If set to 1, the condition for this event to trigger is inverted. If set to 0, this event triggers normally.

struct XorEvent

This structure contains arguments for the XorEvent input function.

Public Members

unsigned int eventID[2]

The event ID of the two other events.

unsigned char invert[2]

If set to 1, the triggered state for the other event of that index is inverted. If set to 0, the triggered state is processed normally.

unsigned char invertResult

If set to 1, the condition for this event to trigger is inverted. If set to 0, this event triggers normally.