#include <StateInterface.hpp>
Public Member Functions | |
| virtual StateInterface * | copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &replacementdss) const =0 |
| virtual int | getEntryPoint () const =0 |
| virtual ProgramInterface * | getEntryProgram () const =0 |
| virtual ProgramInterface * | getExitProgram () const =0 |
| virtual ProgramInterface * | getHandleProgram () const =0 |
| virtual const std::string & | getName () const =0 |
| Get the name of this state. | |
| virtual ProgramInterface * | getRunProgram () const =0 |
| virtual void | loaded (ExecutionEngine *ee) |
| virtual | ~StateInterface () |
Detailed Description
A State contains an entry, run, handle and exit program.
The entry and exit programs will be called when the state is entered of left. The handle program will be called each time the state is requested and no transition is made. The run program will be called before any transition is evaluated.
Thus when we are in state A and want to switch to state B, the following happens :
* in State A :
* call A->run();
* if ( transition to B allowed )
* call A->onExit();
* call B->onEntry();
* return true;
* else
* call A->handle();
* return false;
* Error recovery can be handled inside these programs, if even that fails, the programs return false and the state machine containing this state is considered in error.
Definition at line 81 of file StateInterface.hpp.
Constructor & Destructor Documentation
| StateInterface::~StateInterface | ( | ) | [virtual] |
Definition at line 51 of file StateInterface.cpp.
Member Function Documentation
| virtual StateInterface* RTT::scripting::StateInterface::copy | ( | std::map< const base::DataSourceBase *, base::DataSourceBase * > & | replacementdss | ) | const [pure virtual] |
Implemented in RTT::scripting::StateDescription.
| virtual int RTT::scripting::StateInterface::getEntryPoint | ( | ) | const [pure virtual] |
Get the beginning definition of this State.
Implemented in RTT::scripting::StateDescription.
| virtual ProgramInterface* RTT::scripting::StateInterface::getEntryProgram | ( | ) | const [pure virtual] |
Get the entry program of this State.
Implemented in RTT::scripting::StateDescription.
| virtual ProgramInterface* RTT::scripting::StateInterface::getExitProgram | ( | ) | const [pure virtual] |
Get the exit program of this State.
Implemented in RTT::scripting::StateDescription.
| virtual ProgramInterface* RTT::scripting::StateInterface::getHandleProgram | ( | ) | const [pure virtual] |
Get the handle program of this State.
Implemented in RTT::scripting::StateDescription.
| virtual const std::string& RTT::scripting::StateInterface::getName | ( | ) | const [pure virtual] |
Get the name of this state.
Implemented in RTT::scripting::StateDescription.
| virtual ProgramInterface* RTT::scripting::StateInterface::getRunProgram | ( | ) | const [pure virtual] |
Get the run program of this State.
Implemented in RTT::scripting::StateDescription.
| void StateInterface::loaded | ( | ExecutionEngine * | ee | ) | [virtual] |
Definition at line 55 of file StateInterface.cpp.
The documentation for this class was generated from the following files: