#include <StateMachine.h>

Classes
struct	StateMachineFlags

Public Types
typedef StateMachineImpl	Context
typedef IState	StateInterface
typedef StateBase < StateMachineImpl, IState >	StateBaseClass

Public Member Functions
	~StateMachine ()
bool	initialize (bool force=false)
void	finalize (bool finalizeSubStateMachines=true)
bool	isReady () const
bool	isInitialized () const
bool	isInitalizing () const
bool	isFinalized () const
bool	isFinalizing () const
StateBaseClass *	getState () const
bool	initializeImpl (bool force)
void	finalizeImpl (bool finalizeSubStateMachines)
void	subStateMachineCompleted (StateBaseClass *state)
void	subStateMachineCompletedImpl (StateBaseClass *state)

Protected Member Functions
	StateMachine ()
void	changeState (typename StateMachine< StateMachineImpl, IState >::StateBaseClass *newState)
void	setState (StateBaseClass *newState)
StateBaseClass *	getInitialState () const
StateBaseClass *	getInitialStateImpl () const
bool	isReadyImpl () const
void	exitCurrentState ()
void	enterNewState ()

Friends
class	StateBase< StateMachineImpl, IState >

Detailed Description

template<class StateMachineImpl, class IState>
class sttcl::StateMachine< StateMachineImpl, IState >

Represents the base class for a state machine.

Template Parameters:

StateMachineImpl	Specifies the class implementing the state machine.
IState	Specifies the internal interface of state implementations for the state machine.

Member Typedef Documentation

template<class StateMachineImpl, class IState>

typedef StateMachineImpl sttcl::StateMachine< StateMachineImpl, IState >::Context

The state machine implementation type.

Reimplemented in sttcl::Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, and sttcl::CompositeState< Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, RegionContainerImpl, IInnerState, HistoryType, ActiveState< Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, RegionContainerImpl, IInnerState, StateThreadType, TimeDurationType, SemaphoreType, MutexType >, StateMachine< RegionImpl, IInnerState > >.

template<class StateMachineImpl, class IState>

typedef StateBase<StateMachineImpl,IState> sttcl::StateMachine< StateMachineImpl, IState >::StateBaseClass

The internal state implementation base type.

Reimplemented in sttcl::Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >.

template<class StateMachineImpl, class IState>

typedef IState sttcl::StateMachine< StateMachineImpl, IState >::StateInterface

The internal state implementation interface.

Reimplemented in sttcl::Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, and sttcl::CompositeState< Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, RegionContainerImpl, IInnerState, HistoryType, ActiveState< Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, RegionContainerImpl, IInnerState, StateThreadType, TimeDurationType, SemaphoreType, MutexType >, StateMachine< RegionImpl, IInnerState > >.

Constructor & Destructor Documentation

template<class StateMachineImpl, class IState>

sttcl::StateMachine< StateMachineImpl, IState >::~StateMachine ( )

inline

Destructor for class StateMachine.

template<class StateMachineImpl, class IState>

sttcl::StateMachine< StateMachineImpl, IState >::StateMachine ( )

inlineprotected

Constructor for class StateMachine.

Member Function Documentation

template<class StateMachineImpl, class IState>

void sttcl::StateMachine< StateMachineImpl, IState >::changeState ( typename StateMachine< StateMachineImpl, IState >::StateBaseClass * newState )

protected

Changes the state machines current state.

Parameters:

newState The new target state.

template<class StateMachineImpl , class IState >

void sttcl::StateMachine< StateMachineImpl, IState >::enterNewState ( )

protected

template<class StateMachineImpl , class IState >

void sttcl::StateMachine< StateMachineImpl, IState >::exitCurrentState ( )

protected

template<class StateMachineImpl, class IState>

void sttcl::StateMachine< StateMachineImpl, IState >::finalize ( bool finalizeSubStateMachines = true )

inline

Finalizes the state machine.

Parameters:

finalizeSubStateMachines Indicates to finalize any sub state machines.

template<class StateMachineImpl, class IState>

void sttcl::StateMachine< StateMachineImpl, IState >::finalizeImpl ( bool finalizeSubStateMachines )

inline

Default implementation for the finalize() method.

Parameters:

finalizeSubStateMachines Indicates to finalize any sub state machines.

Reimplemented in sttcl::Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, and sttcl::CompositeState< Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, RegionContainerImpl, IInnerState, HistoryType, ActiveState< Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, RegionContainerImpl, IInnerState, StateThreadType, TimeDurationType, SemaphoreType, MutexType >, StateMachine< RegionImpl, IInnerState > >.

template<class StateMachineImpl, class IState>

StateBaseClass* sttcl::StateMachine< StateMachineImpl, IState >::getInitialState ( ) const

inlineprotected

Gets the initial state of the state machine.

Returns:: The initial state of the state machine.

template<class StateMachineImpl, class IState>

StateBaseClass* sttcl::StateMachine< StateMachineImpl, IState >::getInitialStateImpl ( ) const

inlineprotected

Default implementation for getInitialState().

Returns:: The initial state of the state machine.

template<class StateMachineImpl, class IState>

StateBaseClass* sttcl::StateMachine< StateMachineImpl, IState >::getState ( ) const

inline

Gets the current state.

Returns:: The current state.

template<class StateMachineImpl, class IState>

bool sttcl::StateMachine< StateMachineImpl, IState >::initialize ( bool force = false )

inline

Initializes the state machine.

Parameters:

force Indicates to finalize the state machine before (re-)initializing.

Returns:: The ready state of the state machine.

template<class StateMachineImpl, class IState>

bool sttcl::StateMachine< StateMachineImpl, IState >::initializeImpl ( bool force )

inline

Default implementation for the initialize() method.

Parameters:

force Indicates to finalize the state machine before (re-)initializing.

Returns:: The ready state of the state machine.

Reimplemented in sttcl::Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, and sttcl::CompositeState< Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, RegionContainerImpl, IInnerState, HistoryType, ActiveState< Region< RegionImpl, RegionContainerImpl, IInnerState, EventArgs, HistoryType, StateThreadType, TimeDurationType, SemaphoreType, MutexType, EventQueueType >, RegionContainerImpl, IInnerState, StateThreadType, TimeDurationType, SemaphoreType, MutexType >, StateMachine< RegionImpl, IInnerState > >.

template<class StateMachineImpl, class IState>

bool sttcl::StateMachine< StateMachineImpl, IState >::isFinalized ( ) const

inline

Indicates that the state machine is finalized.

Returns:: true if the state machine is finalized, false otherwise.

template<class StateMachineImpl, class IState>

bool sttcl::StateMachine< StateMachineImpl, IState >::isFinalizing ( ) const

inline

Indicates that the state machine is currently finalizing.

Returns:: true if the state machine is currently finalizing, false otherwise.

template<class StateMachineImpl, class IState>

bool sttcl::StateMachine< StateMachineImpl, IState >::isInitalizing ( ) const

inline

Indicates that the state machine is currently initializing.

Returns:: true if the state machine is currently initializing, false otherwise.

template<class StateMachineImpl, class IState>

bool sttcl::StateMachine< StateMachineImpl, IState >::isInitialized ( ) const

inline

Indicates that the state machine is initialized.

Returns:: true if the state machine is initialized, false otherwise.

template<class StateMachineImpl, class IState>

bool sttcl::StateMachine< StateMachineImpl, IState >::isReady ( ) const

inline

Indicates that the state machine is ready to process events.

Returns:: true if the state machine is ready to process events, false otherwise.

template<class StateMachineImpl, class IState>

bool sttcl::StateMachine< StateMachineImpl, IState >::isReadyImpl ( ) const

inlineprotected

Default implementation for isReady().

Returns:: true if the state machine is ready to process events, false otherwise.

template<class StateMachineImpl, class IState>

void sttcl::StateMachine< StateMachineImpl, IState >::setState ( StateBaseClass * newState )

inlineprotected

Sets the state machines current state without calling any state operations.

Parameters:

newState

template<class StateMachineImpl, class IState>

void sttcl::StateMachine< StateMachineImpl, IState >::subStateMachineCompleted ( StateBaseClass * state )

inline

Called by a contained (composite) state when its sub state machine is completed (finalized).

Parameters:

state A pointer to the contained (composite) state.

template<class StateMachineImpl, class IState>

void sttcl::StateMachine< StateMachineImpl, IState >::subStateMachineCompletedImpl ( StateBaseClass * state )

inline

The default implementation of the subStateMachineCompleted method.

Parameters:

state A pointer to the contained (composite) state.

Friends And Related Function Documentation

template<class StateMachineImpl, class IState>

friend class StateBase< StateMachineImpl, IState >

friend

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

include/StateMachine.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

template<class StateMachineImpl, class IState> class sttcl::StateMachine< StateMachineImpl, IState >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

template<class StateMachineImpl, class IState>
class sttcl::StateMachine< StateMachineImpl, IState >