wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface Class Reference

Export the state interface to let others derive from this :).

#include <fsm/FSM.hpp>

Inheritance diagram for wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface:

[legend]

Collaboration diagram for wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface:

[legend]

List of all members.

Public Member Functions
virtual void	exitState ()
	exitState is called when exiting a state
std::string	getStateName () const
	Returns the name of the current state.
virtual void	initState ()
	initState is called when entering a new state
	StateInterface (FSMType *_fsm, const std::string &_stateName)
	Each state will automatically get the FSM it belongs to.
VariablesType &	vars ()
	Returns a reference to the VARIABLES of the FSM.
Protected Member Functions
virtual FSMType *	getFSM () const
	Returns the FSM this state is part of.
Private Types
typedef FSM< SIGNALS, VARIABLES >	FSMType
	The basic FSM this state will operate on.
Private Attributes
FSMType *	fsm
	This state is part of this FSM.
std::string	stateName
	Name of current state.
Friends
class	wns::fsm::FSMConfigCreator

---

Detailed Description

template<typename SIGNALS, typename VARIABLES>
class wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface

Definition at line 77 of file FSM.hpp.

---

Member Typedef Documentation

template<typename SIGNALS, typename VARIABLES>

typedef FSM<SIGNALS, VARIABLES> wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface::FSMType [private]

Definition at line 86 of file FSM.hpp.

---

Constructor & Destructor Documentation

template<typename SIGNALS, typename VARIABLES>

wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface::StateInterface	(	FSMType *	_fsm,
		const std::string &	_stateName
	)			[inline, explicit]

Definition at line 93 of file FSM.hpp.

---

Member Function Documentation

template<typename SIGNALS, typename VARIABLES>

virtual void wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface::exitState

(

)

[inline, virtual]

Definition at line 109 of file FSM.hpp.

template<typename SIGNALS, typename VARIABLES>

virtual FSMType* wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface::getFSM

(

)

const [inline, protected, virtual]

Definition at line 137 of file FSM.hpp.

template<typename SIGNALS, typename VARIABLES>

std::string wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface::getStateName

(

)

const [inline]

Definition at line 116 of file FSM.hpp.

template<typename SIGNALS, typename VARIABLES>

virtual void wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface::initState

(

)

[inline, virtual]

Definition at line 102 of file FSM.hpp.

template<typename SIGNALS, typename VARIABLES>

VariablesType& wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface::vars

(

)

[inline]

Note:

: This function is provided for convenience only.

Definition at line 127 of file FSM.hpp.

---

Friends And Related Function Documentation

template<typename SIGNALS, typename VARIABLES>

friend class wns::fsm::FSMConfigCreator [friend]

Definition at line 81 of file FSM.hpp.

---

Member Data Documentation

template<typename SIGNALS, typename VARIABLES>

FSMType* wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface::fsm [private]

Definition at line 146 of file FSM.hpp.

template<typename SIGNALS, typename VARIABLES>

std::string wns::fsm::FSM< SIGNALS, VARIABLES >::StateInterface::stateName [private]

Definition at line 151 of file FSM.hpp.

---

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

• framework/library/src/fsm/FSM.hpp