stmg::ArrayEvent Class Reference

Array event. More...

Inheritance diagram for stmg::ArrayEvent:

Classes
struct	Dimension
struct	Init
struct	LocalInit

Public Types
enum	{   MESSAGE_ARRAY_GET = 100, MESSAGE_ARRAY_GET_1 = 101, MESSAGE_ARRAY_GET_2 = 102, MESSAGE_ARRAY_GET_3 = 103,   MESSAGE_ARRAY_GET_4 = 104, MESSAGE_ARRAY_GET_5 = 105 }
enum	{   LISTENER_GROUP_ARRAY_RESULT = 10, LISTENER_GROUP_ARRAY_RESULT_1 = 11, LISTENER_GROUP_ARRAY_RESULT_2 = 12, LISTENER_GROUP_ARRAY_RESULT_3 = 13,   LISTENER_GROUP_ARRAY_RESULT_4 = 14, LISTENER_GROUP_ARRAY_RESULT_5 = 15 }
Public Types inherited from stmg::Event
enum	MSG_FILTER_VALUE_OP {   MSG_FILTER_VALUE_OP_FIRST = 0, MSG_FILTER_VALUE_OP_UNCHANGED = 0, MSG_FILTER_VALUE_OP_SET = 1, MSG_FILTER_VALUE_OP_MULT_ADD = 2,   MSG_FILTER_VALUE_OP_DIV_ADD = 3, MSG_FILTER_VALUE_OP_PERCENT_ADD = 4, MSG_FILTER_VALUE_OP_PERMILL_ADD = 5, MSG_FILTER_VALUE_OP_MOD_ADD = 6,   MSG_FILTER_VALUE_OP_MIN_ADD = 7, MSG_FILTER_VALUE_OP_MAX_ADD = 8, MSG_FILTER_VALUE_OP_LAST = 8 }
	Value filter. More...
enum	{ LISTENER_GROUP_FINISHED = 0 }

Public Member Functions
	ArrayEvent (Init &&oInit) noexcept
	Constructor. More...
void	trigger (int32_t nMsg, int32_t nValue, Event *p0TriggeringEvent) noexcept override
	The trigger function. More...
Public Member Functions inherited from stmg::Event
virtual	~Event () noexcept=default
virtual void	addMsgFilter (int32_t nInFromMsg, int32_t nInToMsg, int32_t nInFromValue, int32_t nInToValue, bool bOutMsgDefined, int32_t nOutMsg, MSG_FILTER_VALUE_OP eOutValueOperator, int32_t nOutValueOperand, int32_t nOutValueAdd) noexcept
	Add a message filter. More...
virtual void	addListener (int32_t nGroupId, Event *p0ListenerEvent, int32_t nMsg) noexcept
	Adds a listener to the event. More...
bool	isActive () const noexcept
	Tells whether the event is active. More...
int32_t	getTriggerTime () const noexcept
	The triggering time. More...
int32_t	getPriority () const noexcept
	The priority. More...
int32_t	getDebugTag () const noexcept
	The debug tag. More...

Protected Member Functions
void	reInit (Init &&oInit) noexcept
	See constructor. More...
Protected Member Functions inherited from stmg::Event
	Event (Init &&oInit) noexcept
	Constructor. More...
void	reInit (Init &&oInit) noexcept
	Reinitialization. More...
virtual void	informListeners (int32_t nGroupId, int32_t nValue) noexcept
	Calls the trigger function of a group of listeners. More...
const Level &	level () const noexcept
	The level this event belongs to. More...
Level &	level () noexcept
	The level this event belongs to. More...

Detailed Description

Array event.

Allows to index values in a possibly multi dimensional array. The index can only be a variable or nValue passed to trigger() function. The addressed value is sent to listeners.

If any index is out of bounds the default value is returned.

Five channels are available.

Example: if an instance is triggered with MESSAGE_ARRAY_GET_3, the result will be sent to LISTENER_GROUP_ARRAY_RESULT_3 listeners.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MESSAGE_ARRAY_GET	Get value. Channel 0.
MESSAGE_ARRAY_GET_1	Get value. Channel 1.
MESSAGE_ARRAY_GET_2	Get value. Channel 2.
MESSAGE_ARRAY_GET_3	Get value. Channel 3.
MESSAGE_ARRAY_GET_4	Get value. Channel 4.
MESSAGE_ARRAY_GET_5	Get value. Channel 5.

anonymous enum

anonymous enum

Enumerator
LISTENER_GROUP_ARRAY_RESULT	The value. Channel 0.
LISTENER_GROUP_ARRAY_RESULT_1	The value. Channel 1.
LISTENER_GROUP_ARRAY_RESULT_2	The value. Channel 2.
LISTENER_GROUP_ARRAY_RESULT_3	The value. Channel 3.
LISTENER_GROUP_ARRAY_RESULT_4	The value. Channel 4.
LISTENER_GROUP_ARRAY_RESULT_5	The value. Channel 5.

Constructor & Destructor Documentation

ArrayEvent()

stmg::ArrayEvent::ArrayEvent ( Init &&  oInit )

explicitnoexcept

Constructor.

Parameters

oInit

Initialization data.

Member Function Documentation

reInit()

void stmg::ArrayEvent::reInit ( Init &&  oInit )

protectednoexcept

See constructor.

trigger()

void stmg::ArrayEvent::trigger ( int32_t  nMsg, int32_t  nValue, Event *  p0TriggeringEvent  )

overridevirtualnoexcept

The trigger function.

This function provides the functionality of the event and can be called in two ways.

It can be called by an event through informListeners() this event was listening to. Note: events can listen to themselves.

It can also be called by the timer if the event was active.

When this function is called the event has already been deactivated by the level (if it was active in the first place).

When this function is called the filters of this event have already been applied.

Parameters

nMsg	The message received.
nValue	The value received.
p0TriggeringEvent	The triggering event or null if triggered by timer.

Implements stmg::Event.