Orocos Real-Time Toolkit
2.8.3
|
An action which calls a FunctionFraph for execution in a ExecutionEngine. More...
#include <rtt/scripting/CallFunction.hpp>
Public Types | |
typedef boost::shared_ptr< ActionInterface > | shared_ptr |
Use this type for shared pointer storage of an ActionInterface object. More... | |
Public Member Functions | |
CallFunction (base::ActionInterface *init_com, boost::shared_ptr< ProgramInterface > foo, ExecutionEngine *p, ExecutionEngine *caller, internal::AssignableDataSource< ProgramInterface * > *v=0, internal::AssignableDataSource< bool > *a=0) | |
Create a Command to send a function to a ExecutionEngine. More... | |
~CallFunction () | |
virtual bool | execute () |
Execute the functionality of this action. More... | |
virtual void | reset () |
Reset this action. More... | |
virtual bool | valid () const |
Inspect if this action was executed and valid. More... | |
virtual void | readArguments () |
This is invoked some time before execute() at a time when the action may read its function arguments. More... | |
base::ActionInterface * | clone () const |
The Clone Software Pattern. More... | |
base::ActionInterface * | copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const |
When copying an Orocos program, we want identical internal::DataSource's to be mapped to identical DataSources, in order for the program to work correctly. More... | |
An action which calls a FunctionFraph for execution in a ExecutionEngine.
Script functions are always executed in the thread of the component.
It is an DataSource such that it can be executed by program scripts.
Definition at line 62 of file CallFunction.hpp.
|
inherited |
Use this type for shared pointer storage of an ActionInterface object.
Definition at line 78 of file ActionInterface.hpp.
|
inline |
Create a Command to send a function to a ExecutionEngine.
init_com | The command to execute before sending the function into the processor, in order to initialise it. |
foo | The function to run in the processor. |
p | The target processor which will run the function. |
v | Implementation specific parameter to support copy/clone semantics. |
Definition at line 92 of file CallFunction.hpp.
|
inline |
Definition at line 104 of file CallFunction.hpp.
|
inlinevirtual |
The Clone Software Pattern.
Implements RTT::base::ActionInterface.
Definition at line 145 of file CallFunction.hpp.
References RTT::internal::DataSource< T >::get().
|
inlinevirtual |
When copying an Orocos program, we want identical internal::DataSource's to be mapped to identical DataSources, in order for the program to work correctly.
This is different from the clone function, where we simply want a new Action that can replace the old one directly.
This function takes a map that maps the old internal::DataSource's onto their new replacements. This way, it is possible to check before cloning a internal::DataSource, whether it has already been copied, and if so, reuse the existing copy.
To keep old source working, the standard implementation of this function simply calls the clone function. If your ActionInterface uses a internal::DataSource, it is important that you reimplement this function correctly though.
Reimplemented from RTT::base::ActionInterface.
Definition at line 151 of file CallFunction.hpp.
References RTT::internal::AssignableDataSource< T >::copy().
|
inlinevirtual |
Execute the functionality of this action.
Implements RTT::base::ActionInterface.
Definition at line 108 of file CallFunction.hpp.
References RTT::ExecutionEngine::runFunction(), and RTT::ExecutionEngine::waitForFunctions().
|
inlinevirtual |
This is invoked some time before execute() at a time when the action may read its function arguments.
Implements RTT::base::ActionInterface.
Definition at line 140 of file CallFunction.hpp.
|
inlinevirtual |
Reset this action.
Must be used after execute() failed.
Reimplemented from RTT::base::ActionInterface.
Definition at line 130 of file CallFunction.hpp.
References RTT::ExecutionEngine::removeFunction().
|
inlinevirtual |
Inspect if this action was executed and valid.
This method may not be called before execute(). The default implementation returns always true, i.e. after execute(), it was executed. Override this method if it has more complex state semantics.
Reimplemented from RTT::base::ActionInterface.
Definition at line 136 of file CallFunction.hpp.