FSM::State Class Reference
#include <state.h>
Inheritance diagram for FSM::State:
Detailed Description
Implements a state of a state machine.(C) 2009 Radon Labs GmbH
Public Member Functions | |
| State () | |
| constructor | |
| virtual | ~State () |
| destructor | |
| void | SetName (const Util::String &n) |
| set name of the state | |
| const Util::String & | GetName () const |
| get name of the state | |
| void | AddEntryAction (const Ptr< Actions::ActionList > &action) |
| add a state entry action | |
| void | AddFrameAction (const Ptr< Actions::ActionList > &action) |
| add a state frame action | |
| void | AddExitAction (const Ptr< Actions::ActionList > &action) |
| add a state exit action | |
| void | AddTransition (const Ptr< Transition > &transition) |
| add a transition object to the state | |
| void | OnEntry () |
| called when state is entered | |
| void | OnFrame () |
| called per-frame while state is active | |
| void | OnExit () |
| called when state is left | |
| void | Notify (const Ptr< Messaging::Message > &msg) |
| notify the state about incoming message | |
| Ptr< Transition > | EvaluateTransitions () |
| evaluate transitions, return first transition which evaluates true | |
| int | GetNumTransitions () const |
| get number of transitions | |
| const Ptr< Transition > & | GetTransitionAtIndex (int index) const |
| get pointer to transition at index | |
| const Ptr< Actions::SequenceAction > & | GetFrameActions () const |
| get all frame actions | |
| int | GetRefCount () const |
| get the current refcount | |
| void | AddRef () |
| increment refcount by one | |
| void | Release () |
| decrement refcount and destroy object if refcount is zero | |
| bool | IsInstanceOf (const Rtti &rtti) const |
| return true if this object is instance of given class | |
| bool | IsInstanceOf (const Util::String &className) const |
| return true if this object is instance of given class by string | |
| bool | IsInstanceOf (const Util::FourCC &classFourCC) const |
| return true if this object is instance of given class by fourcc | |
| bool | IsA (const Rtti &rtti) const |
| return true if this object is instance of given class, or a derived class | |
| bool | IsA (const Util::String &rttiName) const |
| return true if this object is instance of given class, or a derived class, by string | |
| bool | IsA (const Util::FourCC &rttiFourCC) const |
| return true if this object is instance of given class, or a derived class, by fourcc | |
| const Util::String & | GetClassName () const |
| get the class name | |
| Util::FourCC | GetClassFourCC () const |
| get the class FourCC code | |
Static Public Member Functions | |
| static void | DumpRefCountingLeaks () |
| dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!) | |
Member Function Documentation
| void FSM::State::OnEntry | ( | ) |
called when state is entered
Executes the entry actions. This method is called once by the state machine when the state becomes the active state.
| void FSM::State::OnFrame | ( | ) |
called per-frame while state is active
Executes the frame actions. This method is called once per frame by the state machine while this state is the active state.
| void FSM::State::OnExit | ( | ) |
called when state is left
Executes the exit actions. This method is called once per frame by the state machine before this state becomes inactive.
| void FSM::State::Notify | ( | const Ptr< Messaging::Message > & | msg | ) |
notify the state about incoming message
Notifies the state about any incoming messages. The method call is simply forwarded to all FrameActions and Transitions. Usually, only FSMActions and FSMConditions are interested about messages.
| Ptr< Transition > FSM::State::EvaluateTransitions | ( | ) |
evaluate transitions, return first transition which evaluates true
This evaluates all transitions. The first which evaluates to true will be returned, or 0 if no transition evaluates to true. The caller must care about executing the transition actions and switching states.
| int Core::RefCounted::GetRefCount | ( | ) | const [inline, inherited] |
get the current refcount
Return the current refcount of the object.
| void Core::RefCounted::AddRef | ( | ) | [inline, inherited] |
increment refcount by one
Increment the refcount of the object.
| void Core::RefCounted::Release | ( | ) | [inline, inherited] |
decrement refcount and destroy object if refcount is zero
Decrement the refcount and destroy object if refcount is zero.
| const Util::String & Core::RefCounted::GetClassName | ( | ) | const [inline, inherited] |
get the class name
Get the class name of the object.
| Util::FourCC Core::RefCounted::GetClassFourCC | ( | ) | const [inline, inherited] |
get the class FourCC code
Get the class FourCC of the object.
| void Core::RefCounted::DumpRefCountingLeaks | ( | ) | [static, inherited] |
dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)
This method should be called as the very last before an application exits.