RTT::ExecutionAccess Class Reference
The ExecutionAccess provides access to programs and state machines loaded in the execution engine. More...
#include <rtt/ExecutionAccess.hpp>
Inheritance diagram for RTT::ExecutionAccess:
Public Member Functions | |
| ExecutionAccess (TaskContext *parent) | |
| bool | true_gen () const |
Script Program Commands | |
| bool | startProgram (const std::string &name) |
| Start a Program. | |
| bool | stopProgram (const std::string &name) |
| Stops the execution of a program. | |
| bool | pauseProgram (const std::string &name) |
| Pauses the execution of a running program. | |
| bool | stepProgram (const std::string &name) |
| Steps a single instruction of a paused program. | |
Script Program Methods | |
| virtual bool | hasProgram (const std::string &name) const |
| Check if a program is loaded. | |
| bool | isProgramRunning (const std::string &name) const |
| Inspect if a loaded program is in the running state. | |
| bool | isProgramPaused (const std::string &name) const |
| Inspect if a loaded program is in the paused state. | |
| bool | inProgramError (const std::string &name) const |
| Inspect if a loaded program is in the error state. | |
Script State Machine Commands | |
| bool | activateStateMachine (const std::string &name) |
| Activate a previously loaded StateMachine. | |
| bool | deactivateStateMachine (const std::string &name) |
| Deactivate a stopped StateMachine. | |
| bool | startStateMachine (const std::string &name) |
| Start a previously activated StateMachine. | |
| bool | pauseStateMachine (const std::string &name) |
| Pause a previously activated StateMachine. | |
| bool | stopStateMachine (const std::string &name) |
| Stops the execution of a StateMachine and enters the Final_State. | |
| bool | resetStateMachine (const std::string &name) |
| Resets the execution of a StateMachine and enters the Initial_State. | |
| bool | requestStateMachineState (const std::string &name, const std::string &state) |
| Request a state change in a state machine. | |
Script State Machine Methods | |
| virtual bool | hasStateMachine (const std::string &name) const |
| Check if a state machine is loaded. | |
| bool | isStateMachineActive (const std::string &name) const |
| Returns true if the state machine has been activated. | |
| bool | isStateMachineRunning (const std::string &name) const |
| Returns true if the state machine was successfully started. | |
| bool | inStateMachineError (const std::string &name) const |
| Returns true if the state machine is in error. | |
| bool | isStateMachinePaused (const std::string &name) const |
| Returns true if the state machine is paused. | |
| const std::string & | getStateMachineState (const std::string &name) const |
| Get the current state of a state machine. | |
| bool | inStateMachineState (const std::string &name, const std::string &state) const |
| Check if a state machine is in a given state. | |
Protected Attributes | |
| TaskContext * | tc |
Detailed Description
The ExecutionAccess provides access to programs and state machines loaded in the execution engine.
It can be found as the engine object of a TaskContext.
Definition at line 54 of file ExecutionAccess.hpp.
Member Function Documentation
| bool RTT::ExecutionAccess::activateStateMachine | ( | const std::string & | name | ) |
Activate a previously loaded StateMachine.
- Parameters:
-
name The name of the StateMachine.
| bool RTT::ExecutionAccess::deactivateStateMachine | ( | const std::string & | name | ) |
Deactivate a stopped StateMachine.
- Parameters:
-
name The name of the StateMachine.
| const std::string& RTT::ExecutionAccess::getStateMachineState | ( | const std::string & | name | ) | const |
Get the current state of a state machine.
- Parameters:
-
name The name of the StateMachine.
| virtual bool RTT::ExecutionAccess::hasProgram | ( | const std::string & | name | ) | const [virtual] |
Check if a program is loaded.
- Parameters:
-
name The name of the program.
- Returns:
- True if so.
| virtual bool RTT::ExecutionAccess::hasStateMachine | ( | const std::string & | name | ) | const [virtual] |
Check if a state machine is loaded.
- Parameters:
-
name The name of the state machine.
- Returns:
- True if so.
| bool RTT::ExecutionAccess::inProgramError | ( | const std::string & | name | ) | const |
Inspect if a loaded program is in the error state.
- Parameters:
-
name The name of the Program.
- Returns:
- true if so.
| bool RTT::ExecutionAccess::inStateMachineError | ( | const std::string & | name | ) | const |
Returns true if the state machine is in error.
- Parameters:
-
name The name of the StateMachine.
| bool RTT::ExecutionAccess::inStateMachineState | ( | const std::string & | name, | |
| const std::string & | state | |||
| ) | const |
Check if a state machine is in a given state.
- Parameters:
-
name The name of the StateMachine. state The state to enter.
- Returns:
- true if so.
| bool RTT::ExecutionAccess::isProgramPaused | ( | const std::string & | name | ) | const |
Inspect if a loaded program is in the paused state.
- Parameters:
-
name The name of the Program.
- Returns:
- true if so.
| bool RTT::ExecutionAccess::isProgramRunning | ( | const std::string & | name | ) | const |
Inspect if a loaded program is in the running state.
- Parameters:
-
name The name of the Program.
- Returns:
- true if so.
| bool RTT::ExecutionAccess::isStateMachineActive | ( | const std::string & | name | ) | const |
Returns true if the state machine has been activated.
- Parameters:
-
name The name of the StateMachine.
| bool RTT::ExecutionAccess::isStateMachinePaused | ( | const std::string & | name | ) | const |
Returns true if the state machine is paused.
- Parameters:
-
name The name of the StateMachine.
| bool RTT::ExecutionAccess::isStateMachineRunning | ( | const std::string & | name | ) | const |
Returns true if the state machine was successfully started.
- Parameters:
-
name The name of the StateMachine.
| bool RTT::ExecutionAccess::pauseProgram | ( | const std::string & | name | ) |
Pauses the execution of a running program.
- Parameters:
-
name The name of the Program.
| bool RTT::ExecutionAccess::pauseStateMachine | ( | const std::string & | name | ) |
Pause a previously activated StateMachine.
- Parameters:
-
name The name of the StateMachine.
| bool RTT::ExecutionAccess::requestStateMachineState | ( | const std::string & | name, | |
| const std::string & | state | |||
| ) |
Request a state change in a state machine.
- Parameters:
-
name The name of the StateMachine. state The state to enter.
- Returns:
- true if the state change request was accepted.
| bool RTT::ExecutionAccess::resetStateMachine | ( | const std::string & | name | ) |
Resets the execution of a StateMachine and enters the Initial_State.
- Parameters:
-
name The name of the StateMachine.
| bool RTT::ExecutionAccess::startProgram | ( | const std::string & | name | ) |
Start a Program.
- Parameters:
-
name The name of the Program.
| bool RTT::ExecutionAccess::startStateMachine | ( | const std::string & | name | ) |
Start a previously activated StateMachine.
- Parameters:
-
name The name of the StateMachine.
| bool RTT::ExecutionAccess::stepProgram | ( | const std::string & | name | ) |
Steps a single instruction of a paused program.
- Parameters:
-
name The name of the Program.
| bool RTT::ExecutionAccess::stopProgram | ( | const std::string & | name | ) |
Stops the execution of a program.
- Parameters:
-
name The name of the Program.
| bool RTT::ExecutionAccess::stopStateMachine | ( | const std::string & | name | ) |
Stops the execution of a StateMachine and enters the Final_State.
- Parameters:
-
name The name of the StateMachine.
The documentation for this class was generated from the following file:
