ApparatusFramework::TimerMsg Class Reference
[Pattern Services]

#include <PatternServices/current/include/TimerMgr.h>

Inheritance diagram for ApparatusFramework::TimerMsg:
ApparatusFramework::Msg

List of all members.

Public Member Functions

 TimerMsg (const MsgId msgId, const TimerId timerId)
virtual ~TimerMsg ()
virtual Msgclone ()
virtual int toString (char *pBuffer, const int32 bufferLen) const

Public Attributes

TimerId m_theTimerId

Detailed Description

TimerMsg This class is a child of Msg adding the TimerId as new member. All messages from TimerMgr which are sent, when a timeout has run out are of this type.

Definition at line 127 of file TimerMgr.h.


Constructor & Destructor Documentation

ApparatusFramework::TimerMsg::TimerMsg ( const MsgId  msgId,
const TimerId  timerId 
)

constructors, destructors Constructs a new TimerMsg object.

Parameters:
msgId An integer that becomes the message id for the message that is sent from the timer manager (a constant value stored by TimerMgr).
timerId The id of the timer that has run out.
virtual ApparatusFramework::TimerMsg::~TimerMsg (  )  [virtual]

A virtual destructor for the timer message.


Member Function Documentation

virtual Msg* ApparatusFramework::TimerMsg::clone (  )  [virtual]

methods Returns a new generated copy of TimerMsg as a pointer to Msg.

Returns:
Pointer to the copy of this.

Implements ApparatusFramework::Msg.

virtual int ApparatusFramework::TimerMsg::toString ( char *  pBuffer,
const int32  bufferLen 
) const [virtual]

Dumps the content of this message into a string for debug reasons.

Parameters:
pBuffer Buffer for the string representation.
bufferLen Size of the buffer.
Returns:
Number of characters that (would) have been printed to pBuffer or -1 on failure.

Reimplemented from ApparatusFramework::Msg.


Member Data Documentation

fields Where the timer id is stored that has been assigned in the constructor.

Definition at line 158 of file TimerMgr.h.

© 2004-2010 bbv Software Services AG / Apparatus Services