EThreadEventMessageDataBase Class Reference

The base class that all event message data objects should be derived from. More...

#include <etevent.h>

Inheritance diagram for EThreadEventMessageDataBase:

Public Member Functions
	EThreadEventMessageDataBase ()
	Default constructor. More...
	EThreadEventMessageDataBase (UInt msgid)
	Class constructor. More...
UInt	getMessageId ()
	Retrieves the event message ID. More...
EThreadEventMessageDataBase &	setMessageId (UInt msgid)
	Sets the event message ID. More...
virtual pVoid	getVoidPtr ()=0
	Retrieves the void pointer. More...
virtual Void	setVoidPtr (pVoid p)=0
	Sets the void pointer. More...
ETimer &	getTimer ()
	Retrieves the timer associated with this event message. More...

Detailed Description

The base class that all event message data objects should be derived from.

This class contains functionality that should be provided by all event message data objects.

Constructor & Destructor Documentation

EThreadEventMessageDataBase() [1/2]

EThreadEventMessageDataBase::EThreadEventMessageDataBase ( )

inline

Default constructor.

EThreadEventMessageDataBase() [2/2]

EThreadEventMessageDataBase::EThreadEventMessageDataBase ( UInt  msgid )

inline

Class constructor.

Parameters

msgid

the event message ID.

Member Function Documentation

getMessageId()

UInt EThreadEventMessageDataBase::getMessageId ( )

inline

Retrieves the event message ID.

Returns

the event message ID.

getTimer()

ETimer& EThreadEventMessageDataBase::getTimer ( )

inline

Retrieves the timer associated with this event message.

This timer is started when the message is inserted into the thread event queue.

Returns

the timer associated with this event message.

getVoidPtr()

virtual pVoid EThreadEventMessageDataBase::getVoidPtr ( )

pure virtual

Retrieves the void pointer.

This virtual method must be defined in the derived class.

Returns

the void pointer.

Implemented in EThreadEventMessageData.

setMessageId()

EThreadEventMessageDataBase& EThreadEventMessageDataBase::setMessageId ( UInt  msgid )

inline

Sets the event message ID.

Parameters

msgid

the event message ID.

Returns

a reference to this object.

setVoidPtr()

virtual Void EThreadEventMessageDataBase::setVoidPtr ( pVoid  p )

pure virtual

Sets the void pointer.

Parameters

p	the void pointer.

Returns

a reference to this object.

Implemented in EThreadEventMessageData.

---

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

• /home/vagrant/share/code/epctools/include/epc/etevent.h