statecontroller Namespace Reference

This namespace defines everything that is required for the State Controller Library. More...

Classes
class	GenState
	Specialises the State class using templates to take care of the most common overloads. More...
class	State
	Implements a state that a state controller can be in. More...
class	StateQueue
	Implements a dynamic State queue. More...
class	StateController
	Base class for all state controllers. More...

Typedefs
typedef boost::shared_ptr< State >	StatePtr
	Used to represent a Boost shared pointer to a State object.
typedef boost::shared_ptr < State const >	StateConstPtr
	Used to represent a Boost shared pointer to a constant State object.
typedef std::size_t	index_t
	Used to represent an array/vector/queue index (this MUST be an unsigned type)
typedef unsigned int	cycle_t
	Used to count the number of executed state controller cycles.
typedef bool	action_t
	Used to represent the state transition actions (HOLD_THIS_STATE and PROCEED_NEXT_STATE)
typedef int	ret_t
	Used to represent the return codes from state controller functions.

Enumerations
enum	SCReturnID {   SCR_OK = 0, SCR_TERMINATED, SCR_NULL_STATE, SCR_NOT_MY_STATE,   SCR_BAD_CALLBACK }
	Used to specify return values and error codes of state controller functions. More...

Variables
const StatePtr	nullStatePtr = boost::shared_ptr<State>()
	Null StatePtr.
const index_t	nullIndex = (index_t) -1
	Null index_t (nullIndex is guaranteed to exceed std::vector::max_size(), so there is no loss here)
const action_t	HOLD_THIS_STATE = true
	Specifies that the state controller should remain in its current state in the next step, instead of advancing the queue.
const action_t	PROCEED_NEXT_STATE = false
	Specifies that the state controller should advance the queue and retrieve a new State in the next step.

Detailed Description

This namespace defines everything that is required for the State Controller Library.

Enumeration Type Documentation

enum statecontroller::SCReturnID

Used to specify return values and error codes of state controller functions.

Enumerator
SCR_OK	Signals successful execution of function.
SCR_TERMINATED	Signals a clean termination of the state controller.
SCR_NULL_STATE	Signals that a null state was encountered (where it wasn't expected)
SCR_NOT_MY_STATE	Signals that a state was encountered that belongs to another state controller instance (or none at all)
SCR_BAD_CALLBACK	Signals that a callback tried to call a function in StateController that it isn't supposed to.