sStateMgrIf_c Class Reference

#include <dol/sLib/s_StateInterfaces.hpp>

Inheritance diagram for sStateMgrIf_c:

Description

The interface for state managers.

A state manager handles execution of and transitioning between state IDs.

Definition at line 61 of file s_StateInterfaces.hpp.

Public Member Functions
virtual void	initializeState ()=0
	Initializes the current state.
virtual void	executeState ()=0
	Executes the current state.
virtual void	finalizeState ()=0
	Prepares the current state for termination.
virtual void	changeState (const sStateIDIf_c &newStateID)=0
	Transitions to a new state ID.
virtual void	refreshState ()=0
	Marks the current state to be executed again.
virtual sStateIf_c *	getState () const =0
	Gets the state holder.
virtual const sStateIDIf_c *	getNewStateID () const =0
	Gets the next state ID.
virtual const sStateIDIf_c *	getStateID () const =0
	Gets the current state ID.
virtual const sStateIDIf_c *	getOldStateID () const =0
	Gets the previous state ID.

Constructor & Destructor Documentation

~sStateMgrIf_c()

virtual sStateMgrIf_c::~sStateMgrIf_c ( )

inlinevirtual

Definition at line 63 of file s_StateInterfaces.hpp.

Member Function Documentation

initializeState()

virtual void sStateMgrIf_c::initializeState ( )

pure virtual

Initializes the current state.

Implemented in sStateMgr_c< T, Method, Factory, Check >, sStateMgr_c< dYesNoWindow_c, sStateMethodUsr_FI_c, sFStateFct_c, sStateIDChk_c >, and sStateMgr_c< T, Method, sFStateFct_c, sStateIDChk_c >.

executeState()

virtual void sStateMgrIf_c::executeState ( )

pure virtual

Executes the current state.

Implemented in sStateMgr_c< T, Method, Factory, Check >, sStateMgr_c< dYesNoWindow_c, sStateMethodUsr_FI_c, sFStateFct_c, sStateIDChk_c >, and sStateMgr_c< T, Method, sFStateFct_c, sStateIDChk_c >.

finalizeState()

virtual void sStateMgrIf_c::finalizeState ( )

pure virtual

Prepares the current state for termination.

Implemented in sStateMgr_c< T, Method, Factory, Check >, sStateMgr_c< dYesNoWindow_c, sStateMethodUsr_FI_c, sFStateFct_c, sStateIDChk_c >, and sStateMgr_c< T, Method, sFStateFct_c, sStateIDChk_c >.

changeState()

virtual void sStateMgrIf_c::changeState ( const sStateIDIf_c &  newStateID )

pure virtual

Transitions to a new state ID.

Implemented in sStateMgr_c< T, Method, Factory, Check >, sStateMgr_c< dYesNoWindow_c, sStateMethodUsr_FI_c, sFStateFct_c, sStateIDChk_c >, and sStateMgr_c< T, Method, sFStateFct_c, sStateIDChk_c >.

refreshState()

virtual void sStateMgrIf_c::refreshState ( )

pure virtual

Marks the current state to be executed again.

Implemented in sStateMgr_c< T, Method, Factory, Check >, sStateMgr_c< dYesNoWindow_c, sStateMethodUsr_FI_c, sFStateFct_c, sStateIDChk_c >, and sStateMgr_c< T, Method, sFStateFct_c, sStateIDChk_c >.

getState()

virtual sStateIf_c * sStateMgrIf_c::getState ( ) const

pure virtual

Gets the state holder.

Implemented in sStateMgr_c< T, Method, Factory, Check >, sStateMgr_c< dYesNoWindow_c, sStateMethodUsr_FI_c, sFStateFct_c, sStateIDChk_c >, and sStateMgr_c< T, Method, sFStateFct_c, sStateIDChk_c >.

getNewStateID()

virtual const sStateIDIf_c * sStateMgrIf_c::getNewStateID ( ) const

pure virtual

Gets the next state ID.

Implemented in sStateMgr_c< T, Method, Factory, Check >, sStateMgr_c< dYesNoWindow_c, sStateMethodUsr_FI_c, sFStateFct_c, sStateIDChk_c >, and sStateMgr_c< T, Method, sFStateFct_c, sStateIDChk_c >.

getStateID()

virtual const sStateIDIf_c * sStateMgrIf_c::getStateID ( ) const

pure virtual

Gets the current state ID.

Implemented in sStateMgr_c< T, Method, Factory, Check >, sStateMgr_c< dYesNoWindow_c, sStateMethodUsr_FI_c, sFStateFct_c, sStateIDChk_c >, and sStateMgr_c< T, Method, sFStateFct_c, sStateIDChk_c >.

getOldStateID()

virtual const sStateIDIf_c * sStateMgrIf_c::getOldStateID ( ) const

pure virtual

Gets the previous state ID.

Implemented in sStateMgr_c< T, Method, Factory, Check >, sStateMgr_c< dYesNoWindow_c, sStateMethodUsr_FI_c, sFStateFct_c, sStateIDChk_c >, and sStateMgr_c< T, Method, sFStateFct_c, sStateIDChk_c >.