Public Member Functions | Protected Attributes
RTT::base::ExecutableInterface Class Reference

#include <ExecutableInterface.hpp>

Inheritance diagram for RTT::base::ExecutableInterface:
Inheritance graph

List of all members.

Public Member Functions

 ExecutableInterface ()
virtual bool execute ()=0
ExecutionEnginegetEngine ()
bool isLoaded ()
void loaded (ExecutionEngine *ee)
virtual void loading ()
void unloaded ()
virtual void unloading ()
virtual ~ExecutableInterface ()

Protected Attributes


Detailed Description

Objects that implement this interface are to be executed in the ExecutionEngine. One can insert and remove objects that implement this interface safely in and out the ExecutionEngine.

Be careful that all these functions may be called from a hard real-time context.

Definition at line 58 of file ExecutableInterface.hpp.

Constructor & Destructor Documentation

Definition at line 80 of file ExecutableInterface.hpp.

Definition at line 81 of file ExecutableInterface.hpp.

Member Function Documentation

virtual bool RTT::base::ExecutableInterface::execute ( ) [pure virtual]

Executes a piece of functionality. Called by the ExecutionEngine directly.

false if this object should no longer be executed.

Implemented in RTT::scripting::StateMachine, RTT::scripting::FunctionGraph, and RTT::scripting::ProgramInterface.

Returns the ExecutionEngine this object is loaded into or null otherwise.


Definition at line 102 of file ExecutableInterface.hpp.

Returns true if this object is loaded in an ExecutionEngine.

true if so.

Definition at line 95 of file ExecutableInterface.hpp.

Called by the ExecutionEngine ee to tell this object it is being loaded. The engine pointer is set first and the user's loading() function is called next.

eeThe pointer to the engine calling us.

Definition at line 70 of file ExecutableInterface.hpp.

virtual void RTT::base::ExecutableInterface::loading ( ) [inline, virtual]

Informs this object that it got loaded in an ExecutionEngine. Called by load() after the engine pointer is set.

Reimplemented in RTT::scripting::StateMachine, and RTT::scripting::FunctionGraph.

Definition at line 89 of file ExecutableInterface.hpp.

Called by the ExecutionEngine ee to tell this object it is being unloaded. The user's loading() function is called first and the engine pointer is cleared next.

Definition at line 78 of file ExecutableInterface.hpp.

virtual void RTT::base::ExecutableInterface::unloading ( ) [inline, virtual]

Informs this object that it got unloaded from an ExecutionEngine. Called by unload() before the engine pointer is cleared.

Reimplemented in RTT::scripting::StateMachine, RTT::scripting::FunctionGraph, and RTT::scripting::ParsedStateMachine.

Definition at line 118 of file ExecutableInterface.hpp.

Member Data Documentation

Definition at line 61 of file ExecutableInterface.hpp.

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

Author(s): RTT Developers
autogenerated on Thu Jan 2 2014 11:35:43