You.i Engine
Public Member Functions | Protected Member Functions | List of all members
yi::deprecated::CYIState Class Reference

Detailed Description

A basic state in the state machine.

This is the most general kind of state. One child state can be active at any given time.

#include <deprecated/YiState.h>

Inheritance diagram for yi::deprecated::CYIState:
Inheritance graph
[legend]

Public Member Functions

 CYIState (CYICompoundState *pParent=0, const CYIString &name="")
 
virtual ~CYIState ()
 
bool SetInitialState (CYIAbstractState *pState)
 
CYIAbstractState * GetInitialState ()
 
bool SetErrorState (CYIAbstractState *pState)
 
CYIAbstractState * GetErrorState ()
 
- Public Member Functions inherited from yi::deprecated::CYICompoundState
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
 

Protected Member Functions

 CYIState (CYIStatePriv *priv, CYICompoundState *parent)
 
- Protected Member Functions inherited from yi::deprecated::CYICompoundState
 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

- Public Attributes inherited from yi::deprecated::CYICompoundState
CYISignal Finished
 
- Public Attributes inherited from yi::deprecated::CYIAbstractState
CYISignal StateEntered
 
CYISignal StateExited
 
- Protected Attributes inherited from yi::deprecated::CYIAbstractState
CYIAbstractStatePriv * m_pPriv
 

Constructor & Destructor Documentation

yi::deprecated::CYIState::CYIState ( CYICompoundState *  pParent = 0,
const CYIString &  name = "" 
)

Create a state with pParent as a parent. This is the only chance to set the parent of this state. A name can be set for debugging purposes.

virtual yi::deprecated::CYIState::~CYIState ( )
virtual
yi::deprecated::CYIState::CYIState ( CYIStatePriv *  priv,
CYICompoundState *  parent 
)
protected

Member Function Documentation

CYIAbstractState* yi::deprecated::CYIState::GetErrorState ( )

Returns the error state of this state.

CYIAbstractState* yi::deprecated::CYIState::GetInitialState ( )

Returns the initial state of this state.

bool yi::deprecated::CYIState::SetErrorState ( CYIAbstractState *  pState)

pState will be entered if an error condition is encountered during exeution. pState must be a child of this state. Returns false if pState is not a child, and the error state is not modified.

bool yi::deprecated::CYIState::SetInitialState ( CYIAbstractState *  pState)

pState will be the state entered when this state is entered. pState must be a child of this state. Returns false if pState is not a child, and the initial state is not modified.

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