sttcl::internal::CompositeStateBase< InnerStateType > Class Template Reference

#include <CompositeState.h>

Inheritance diagram for sttcl::internal::CompositeStateBase< InnerStateType >:

List of all members.

Protected Member Functions
	CompositeStateBase ()
	~CompositeStateBase ()
void	saveCurrentState (InnerStateType *currentState)
InnerStateType *	getStateHistory ()
template<class CompositeStateImpl >
InnerStateType *	resumeStateHistory (CompositeStateImpl *compositeState)
template<class CompositeStateImpl >
InnerStateType *	finalizeStateHistory (CompositeStateImpl *compositeState)

---

Detailed Description

template<class InnerStateType>
class sttcl::internal::CompositeStateBase< InnerStateType >

Represents the default base class for a composite state.

Template Parameters:

InnerStateType

The state base class type of the composite states inner states.

---

Constructor & Destructor Documentation

template<class InnerStateType >

sttcl::internal::CompositeStateBase< InnerStateType >::CompositeStateBase ( )

inlineprotected

Constructor for class CompositeStateBase.

template<class InnerStateType >

sttcl::internal::CompositeStateBase< InnerStateType >::~CompositeStateBase ( )

inlineprotected

Destructor for class CompositeStateBase.

---

Member Function Documentation

template<class InnerStateType >

template<class CompositeStateImpl >

InnerStateType* sttcl::internal::CompositeStateBase< InnerStateType >::finalizeStateHistory ( CompositeStateImpl *  compositeState )

inlineprotected

Resets the state history.

Template Parameters:

CompositeStateImpl

The composite state implementation class.

Parameters:

compositeState

A pointer to the composite state implementation.

Returns:

The current inner state of the composite state.

template<class InnerStateType >

InnerStateType* sttcl::internal::CompositeStateBase< InnerStateType >::getStateHistory ( )

inlineprotected

Gets the last saved state.

Returns:

template<class InnerStateType >

template<class CompositeStateImpl >

InnerStateType* sttcl::internal::CompositeStateBase< InnerStateType >::resumeStateHistory ( CompositeStateImpl *  compositeState )

inlineprotected

Resumes the state history.

Template Parameters:

CompositeStateImpl

The composite state implementation class.

Parameters:

compositeState

A pointer to the composite state implementation.

Returns:

The current inner state of the composite state.

template<class InnerStateType >

void sttcl::internal::CompositeStateBase< InnerStateType >::saveCurrentState ( InnerStateType *  currentState )

inlineprotected

Saves the current inner state of the composite state.

Parameters:

currentState

---

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

• include/CompositeState.h