EpcTools
An event based multi-threaded C++ development framework.
Public Member Functions | List of all members
EThreadEventMessageData Class Reference

An event message data object that provides access to a union over 8 bytes of data. More...

#include <etevent.h>

Inheritance diagram for EThreadEventMessageData:
EThreadEventMessageDataBase

Public Member Functions

 EThreadEventMessageData ()
 Default constructor. More...
 
 EThreadEventMessageData (UInt msgid)
 Class constructor. More...
 
 EThreadEventMessageData (UInt msgid, EThreadEventMessageData &data)
 Class constructor. More...
 
 EThreadEventMessageData (UInt msgid, pVoid v)
 Class constructor. More...
 
 EThreadEventMessageData (UInt msgid, LongLong v)
 Class constructor. More...
 
 EThreadEventMessageData (UInt msgid, ULongLong v)
 Class constructor. More...
 
 EThreadEventMessageData (UInt msgid, Long v1, Long v2)
 Class constructor. More...
 
 EThreadEventMessageData (UInt msgid, ULong v1, ULong v2)
 Class constructor. More...
 
 EThreadEventMessageData (UInt msgid, Short v1, Short v2, Short v3, Short v4)
 Class constructor. More...
 
 EThreadEventMessageData (UInt msgid, UShort v1, UShort v2, UShort v3, UShort v4)
 Class constructor. More...
 
 EThreadEventMessageData (UInt msgid, Char v1, Char v2, Char v3, Char v4, Char v5, Char v6, Char v7, Char v8)
 Class constructor. More...
 
 EThreadEventMessageData (UInt msgid, UChar v1, UChar v2, UChar v3, UChar v4, UChar v5, UChar v6, UChar v7, UChar v8)
 Class constructor. More...
 
DataUnion & data ()
 Retrieves the data union object. More...
 
pVoid getVoidPtr ()
 Retrieves the void pointer. More...
 
Void setVoidPtr (pVoid p)
 Sets the void pointer. More...
 
- Public Member Functions inherited from EThreadEventMessageDataBase
 EThreadEventMessageDataBase ()
 Default constructor. More...
 
 EThreadEventMessageDataBase (UInt msgid)
 Class constructor. More...
 
UInt getMessageId ()
 Retrieves the event message ID. More...
 
EThreadEventMessageDataBasesetMessageId (UInt msgid)
 Sets the event message ID. More...
 
ETimergetTimer ()
 Retrieves the timer associated with this event message. More...
 

Detailed Description

An event message data object that provides access to a union over 8 bytes of data.

Constructor & Destructor Documentation

◆ EThreadEventMessageData() [1/12]

EThreadEventMessageData::EThreadEventMessageData ( )
inline

Default constructor.

◆ EThreadEventMessageData() [2/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid)
inline

Class constructor.

Parameters
msgidthe event message id.

◆ EThreadEventMessageData() [3/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid,
EThreadEventMessageData data 
)
inline

Class constructor.

Parameters
msgidthe event message id.
dataa data object to include in the message (contains the union definition).

◆ EThreadEventMessageData() [4/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid,
pVoid  v 
)
inline

Class constructor.

Parameters
msgidthe event message id.
va 64-bit signed integer to include in the event message.

◆ EThreadEventMessageData() [5/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid,
LongLong  v 
)
inline

Class constructor.

Parameters
msgidthe event message id.
va 64-bit signed integer to include in the event message.

◆ EThreadEventMessageData() [6/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid,
ULongLong  v 
)
inline

Class constructor.

Parameters
msgidthe event message id.
va 64-bit unsigned integer to include in the event message.

◆ EThreadEventMessageData() [7/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid,
Long  v1,
Long  v2 
)
inline

Class constructor.

Parameters
msgidthe event message id.
v1the first 32-bit signed integer to include in the event message.
v2the second 32-bit signed integer to include in the event message.

◆ EThreadEventMessageData() [8/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid,
ULong  v1,
ULong  v2 
)
inline

Class constructor.

Parameters
msgidthe event message id.
v1the first 32-bit unsigned integer to include in the event message.
v2the second 32-bit unsigned integer to include in the event message.

◆ EThreadEventMessageData() [9/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid,
Short  v1,
Short  v2,
Short  v3,
Short  v4 
)
inline

Class constructor.

Parameters
msgidthe event message id.
v1the first 16-bit signed integer to include in the event message.
v2the second 16-bit signed integer to include in the event message.
v3the third 16-bit signed integer to include in the event message.
v4the fourth 16-bit signed integer to include in the event message.

◆ EThreadEventMessageData() [10/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid,
UShort  v1,
UShort  v2,
UShort  v3,
UShort  v4 
)
inline

Class constructor.

Parameters
msgidthe event message id.
v1the first 16-bit unsigned integer to include in the event message.
v2the second 16-bit unsigned integer to include in the event message.
v3the third 16-bit unsigned integer to include in the event message.
v4the fourth 16-bit unsigned integer to include in the event message.

◆ EThreadEventMessageData() [11/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid,
Char  v1,
Char  v2,
Char  v3,
Char  v4,
Char  v5,
Char  v6,
Char  v7,
Char  v8 
)
inline

Class constructor.

Parameters
msgidthe event message id.
v1the first 8-bit signed integer to include in the event message.
v2the second 8-bit signed integer to include in the event message.
v3the third 8-bit signed integer to include in the event message.
v4the fourth 8-bit signed integer to include in the event message.
v5the fifth 8-bit signed integer to include in the event message.
v6the sixth 8-bit signed integer to include in the event message.
v7the seventh 8-bit signed integer to include in the event message.
v8the eighth 8-bit signed integer to include in the event message.

◆ EThreadEventMessageData() [12/12]

EThreadEventMessageData::EThreadEventMessageData ( UInt  msgid,
UChar  v1,
UChar  v2,
UChar  v3,
UChar  v4,
UChar  v5,
UChar  v6,
UChar  v7,
UChar  v8 
)
inline

Class constructor.

Parameters
msgidthe event message id.
v1the first 8-bit unsigned integer to include in the event message.
v2the second 8-bit unsigned integer to include in the event message.
v3the third 8-bit unsigned integer to include in the event message.
v4the fourth 8-bit unsigned integer to include in the event message.
v5the fifth 8-bit unsigned integer to include in the event message.
v6the sixth 8-bit unsigned integer to include in the event message.
v7the seventh 8-bit unsigned integer to include in the event message.
v8the eighth 8-bit unsigned integer to include in the event message.

Member Function Documentation

◆ data()

DataUnion& EThreadEventMessageData::data ( )
inline

Retrieves the data union object.

Returns
a reference to the data union object.

◆ getVoidPtr()

pVoid EThreadEventMessageData::getVoidPtr ( )
inlinevirtual

Retrieves the void pointer.

Returns
the void pointer.

Implements EThreadEventMessageDataBase.

◆ setVoidPtr()

Void EThreadEventMessageData::setVoidPtr ( pVoid  p)
inlinevirtual

Sets the void pointer.

Parameters
pthe void pointer.
Returns
a reference to this object.

Implements EThreadEventMessageDataBase.


The documentation for this class was generated from the following file: