EThreadEventMessageBase< T > Class Template Reference

A template class that all event message classes should derive from. More...

#include <etevent.h>

Inheritance diagram for EThreadEventMessageBase< T >:

Public Member Functions
	EThreadEventMessageBase ()
	Default constructor. More...
	EThreadEventMessageBase (const T &data)
	Copy constructor. More...
virtual	~EThreadEventMessageBase ()
	Class destructor. More...
T &	operator= (const T &data)
	Assignment operator. More...
T &	data ()
	Retrieves the data portion of the message. More...
UInt	getMessageId ()
	Retrieves the event message ID associated with this event message. More...
EThreadEventMessageBase &	setMessageId (UInt msgid)
	Sets the event message ID for this event message. More...
pVoid	getVoidPtr ()
	Retrieves the void pointer from the data portion of this event message. More...
Void	setVoidPtr (pVoid p)
	Sets the void pointer for this event message. More...
ETimer &	getTimer ()
	Retrieves the timer associated with this event message. More...
Public Member Functions inherited from _EThreadEventMessageBase
virtual	~_EThreadEventMessageBase ()
	Virtual class destructor. More...

Detailed Description

template<class T>
class EThreadEventMessageBase< T >

A template class that all event message classes should derive from.

Constructor & Destructor Documentation

EThreadEventMessageBase() [1/2]

template<class T >

EThreadEventMessageBase< T >::EThreadEventMessageBase ( )

inline

Default constructor.

EThreadEventMessageBase() [2/2]

template<class T >

EThreadEventMessageBase< T >::EThreadEventMessageBase ( const T &  data )

inline

Copy constructor.

Parameters

data	the T to copy.

~EThreadEventMessageBase()

template<class T >

virtual EThreadEventMessageBase< T >::~EThreadEventMessageBase ( )

inlinevirtual

Class destructor.

Member Function Documentation

data()

template<class T >

T& EThreadEventMessageBase< T >::data ( )

inline

Retrieves the data portion of the message.

Returns

a reference to the data portion of the message.

getMessageId()

template<class T >

UInt EThreadEventMessageBase< T >::getMessageId ( )

inline

Retrieves the event message ID associated with this event message.

Returns

the event message ID associated with this event message.

getTimer()

template<class T >

ETimer& EThreadEventMessageBase< T >::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()

template<class T >

pVoid EThreadEventMessageBase< T >::getVoidPtr ( )

inline

Retrieves the void pointer from the data portion of this event message.

Returns

the void pointer from the data portion of this event message.

operator=()

template<class T >

T& EThreadEventMessageBase< T >::operator= ( const T &  data )

inline

Assignment operator.

Parameters

data	the message object to copy.

setMessageId()

template<class T >

EThreadEventMessageBase& EThreadEventMessageBase< T >::setMessageId ( UInt  msgid )

inline

Sets the event message ID for this event message.

Parameters

msgid

the event message ID for this event message.

Returns

a reference to this object.

setVoidPtr()

template<class T >

Void EThreadEventMessageBase< T >::setVoidPtr ( pVoid  p )

inline

Sets the void pointer for this event message.

Parameters

p	the void pointer for this event message.

Returns

a reference to this object.

---

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

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