Detailed Description

The base class for CYIState and CYIParallelState.

This class provides a common interface for compound states. That is, states that can have children and transitions out.

Inheritance diagram for yi::deprecated::CYICompoundState:

[legend]

Public Member Functions
virtual	~CYICompoundState ()

std::list< CYIAbstractState * >	GetStates ()

bool	AddTransition (CYITransition *pTransition)

bool	RemoveTransition (CYITransition *pTransition)

std::list< CYITransition * >	GetTransitions ()

Public Member Functions inherited from yi::deprecated::CYIAbstractState
virtual	~CYIAbstractState ()

CYICompoundState *	GetParent () const

CYIStateMachine *	GetMachine () const

const CYIString &	GetName () const

Public Member Functions inherited from CYIScriptableObject
	CYIScriptableObject ()

	CYIScriptableObject (const CYIScriptableObject &other)

CYIScriptableObject &	operator= (const CYIScriptableObject &other)

virtual	~CYIScriptableObject ()

CYIBindingImplementation *	GetBindingImplementation () const

void	SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)

virtual const CYIRuntimeTypeInfo *	GetRuntimeTypeInfoForScriptObject () const

Public Attributes
CYISignal	Finished

Public Attributes inherited from yi::deprecated::CYIAbstractState
CYISignal	StateEntered

CYISignal	StateExited

Protected Member Functions
	CYICompoundState (CYICompoundStatePriv priv, CYICompoundState parent=0, const CYIString &name="")

Protected Member Functions inherited from yi::deprecated::CYIAbstractState
virtual void	OnEntry (CYIEvent *e)

virtual void	OnExit (CYIEvent *e)

	CYIAbstractState (CYIAbstractStatePriv priv, CYICompoundState parent=0, const CYIString &name="")

Additional Inherited Members
Protected Attributes inherited from yi::deprecated::CYIAbstractState
CYIAbstractStatePriv *	m_pPriv

Constructor & Destructor Documentation

virtual yi::deprecated::CYICompoundState::~CYICompoundState ( )

virtual

yi::deprecated::CYICompoundState::CYICompoundState	(	CYICompoundStatePriv *	priv,
		CYICompoundState *	parent = `0`,
		const CYIString &	name = `""`
	)

protected

bool yi::deprecated::CYICompoundState::AddTransition ( CYITransition * pTransition )

Sets pTransition 's source state to this state.

std::list<CYIAbstractState *> yi::deprecated::CYICompoundState::GetStates ( )

Returns a list if the children states of this state.

std::list<CYITransition *> yi::deprecated::CYICompoundState::GetTransitions ( )

Returns a list of the transitions with this state as a source

bool yi::deprecated::CYICompoundState::RemoveTransition ( CYITransition * pTransition )

Sets pTransition 's source state to nullptr

CYISignal yi::deprecated::CYICompoundState::Finished

This signal is emmited when a child CYIFinalState is entered.

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