yi::deprecated::CYIAbstractState Class Reference

Detailed Description

The base class for state types in CYIStateMachine.

This class provides a common interface for any state. States have a parent, and are usually part of a CYIStateMachine.

States can be given a name for debugging purposes.

Entered and Exited callbacks are provided in the form of signals and virtual methods.

#include <deprecated/YiAbstractState.h>

Inheritance diagram for yi::deprecated::CYIAbstractState:

Public Member Functions
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	StateEntered
CYISignal	StateExited

Protected Member Functions
virtual void	OnEntry (CYIEvent *e)
virtual void	OnExit (CYIEvent *e)
	CYIAbstractState (CYIAbstractStatePriv *priv, CYICompoundState *parent=0, const CYIString &name="")

Protected Attributes
CYIAbstractStatePriv *	m_pPriv

Friends
class	CYIState
class	CYIParallelState
class	CYIHistoryState
class	CYITransition
class	CYIAbstractSignalTransition
class	CYIAbstractStatePriv

Constructor & Destructor Documentation

virtual yi::deprecated::CYIAbstractState::~CYIAbstractState ( )

virtual

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

protected

Member Function Documentation

CYIStateMachine* yi::deprecated::CYIAbstractState::GetMachine

(

)

const

Returns the CYIStateMachine this state belongs to. Can be nullptr if not part of any machine.

const CYIString& yi::deprecated::CYIAbstractState::GetName

(

)

const

Returns the name of this state.

CYICompoundState* yi::deprecated::CYIAbstractState::GetParent

(

)

const

Returns the parent of this state machine. Can be nullptr if no parent is set.

virtual void yi::deprecated::CYIAbstractState::OnEntry ( CYIEvent *  e )

protectedvirtual

This virtual method is called when the state is entered.

virtual void yi::deprecated::CYIAbstractState::OnExit ( CYIEvent *  e )

protectedvirtual

This virtual method is called when the state is exited.

Friends And Related Function Documentation

friend class CYIAbstractSignalTransition

friend

friend class CYIAbstractStatePriv

friend

friend class CYIHistoryState

friend

friend class CYIParallelState

friend

friend class CYIState

friend

friend class CYITransition

friend

Member Data Documentation

CYIAbstractStatePriv* yi::deprecated::CYIAbstractState::m_pPriv

protected

CYISignal yi::deprecated::CYIAbstractState::StateEntered

Triggered when this state is entered.

CYISignal yi::deprecated::CYIAbstractState::StateExited

Triggered when this state is exited.

---

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

• deprecated/YiAbstractState.h