FSM::Transition Class Reference
#include <transition.h>
Inheritance diagram for FSM::Transition:
Detailed Description
Implements a state transition. If no target state name if given, the previously active state will be activated when the transition conditions are met.(C) 2006 Radon Labs GmbH
Public Member Functions | |
Transition () | |
constructor | |
virtual | ~Transition () |
destructor | |
void | OnActivate () |
called when parent states becomes active | |
void | OnDeactivate () |
called when parent states becomes inactive | |
void | Notify (const Ptr< Messaging::Message > &msg) |
notify FSMConditions about message | |
void | SetTargetState (const Util::String &n) |
set name of target state | |
const Util::String & | GetTargetState () const |
get name of target state | |
void | AddCondition (const Ptr< Conditions::Condition > &condition) |
add a condition to the transition's AND condition block | |
void | AddAction (const Ptr< Actions::ActionList > &action) |
add a transition action | |
bool | EvaluateConditions () |
evaluate transition conditions | |
void | ExecuteActions () |
execute actions associated with transition | |
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::Transition::OnActivate | ( | ) |
called when parent states becomes active
This method gets called when the parent state becomes active.
void FSM::Transition::OnDeactivate | ( | ) |
called when parent states becomes inactive
This method gets called when the parent state becomes inactive.
void FSM::Transition::Notify | ( | const Ptr< Messaging::Message > & | msg | ) |
notify FSMConditions about message
This method notifies FSMConditions about any incoming messages they are interested in.
bool FSM::Transition::EvaluateConditions | ( | ) |
evaluate transition conditions
This evaluates the state of all conditions and ANDs them together. If there are no Conditions, the transition is be true.
void FSM::Transition::ExecuteActions | ( | ) |
execute actions associated with transition
This executes all actions added to the transition.
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.