ApparatusFramework::DynamicState Class Reference
[Pattern Services]

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

List of all members.

Public Member Functions

 DynamicState ()
virtual ~DynamicState ()
virtual void onEvent (Msg *pMsg)
const char * getName () const
void * operator new (const size_t aSize, const DynamicState *theCurrentState)
void operator delete (void *anItem, const DynamicState *theCurrentState)
void operator delete (void *anItem)

Protected Attributes

const char * m_pName

Detailed Description

class DynamicState The class state implements the basic state for all states used in state machines. The state class can be user defined inherited. Hierarchical states are not supported. The user of the class state has to inherit from it and must implement the method OnEntry and the constructor (to set the states name)..

Hints:

Definition at line 73 of file DynamicState.h.


Constructor & Destructor Documentation

ApparatusFramework::DynamicState::DynamicState (  ) 

constructors, destructors State Constructs a new state object.

virtual ApparatusFramework::DynamicState::~DynamicState (  )  [virtual]

~State destroys a state object and releases all the associated ressources.


Member Function Documentation

const char* ApparatusFramework::DynamicState::getName (  )  const [inline]

getName This method returns the name of the state.

Returns:
The name of the state.

Definition at line 98 of file DynamicState.h.

References m_pName.

virtual void ApparatusFramework::DynamicState::onEvent ( Msg pMsg  )  [virtual]

modifiers onEvent This method is automatically executed if the state machine handels the received message. Every inherited class of the class state has to implement this method.

Parameters:
pMsg message to be handled
void ApparatusFramework::DynamicState::operator delete ( void *  anItem  )  [inline]

operator delete destroy a state object

Parameters:
anItem Object to be detroyed

Definition at line 116 of file DynamicState.h.

void ApparatusFramework::DynamicState::operator delete ( void *  anItem,
const DynamicState theCurrentState 
) [inline]

operator delete destroy a state object

Parameters:
anItem Object to be detroyed
theCurrentState Pointer to the location, where the state object is

Definition at line 111 of file DynamicState.h.

References BBV_UNUSED_ARG.

void* ApparatusFramework::DynamicState::operator new ( const size_t  aSize,
const DynamicState theCurrentState 
)

operator new creates a new state object at a defined location.

Parameters:
aSize Size of the object to be created
theCurrentState Pointer to the location, where the state will be created (the location of the prev. state)
Returns:
Pointer to the created state.

Member Data Documentation

fields m_pName Holds a reference to the name of the state.

Definition at line 124 of file DynamicState.h.

Referenced by getName().

© 2004-2010 bbv Software Services AG / Apparatus Services