RTT::scripting::CallFunction Class Reference

An action which calls a FunctionFraph for execution in a ExecutionEngine. More...

#include <rtt/scripting/CallFunction.hpp>

Inheritance diagram for RTT::scripting::CallFunction:

List of all members.

Public Types
typedef boost::shared_ptr < ActionInterface >	shared_ptr
	Use this type for shared pointer storage of an ActionInterface object.
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.
virtual bool	execute ()
	Execute the functionality of this action.
virtual void	reset ()
	Reset this action.
virtual bool	valid () const
	Inspect if this action was executed and valid.
virtual void	readArguments ()
	This is invoked some time before execute() at a time when the action may read its function arguments.
base::ActionInterface *	clone () const
	The Clone Software Pattern.
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.

---

Detailed Description

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.

---

Constructor & Destructor Documentation

RTT::scripting::CallFunction::CallFunction	(	base::ActionInterface *	init_com,
		boost::shared_ptr< ProgramInterface >	foo,
		ExecutionEngine *	p,
		ExecutionEngine *	caller,
		internal::AssignableDataSource< ProgramInterface * > *	v = 0,
		internal::AssignableDataSource< bool > *	a = 0
	)		[inline]

Create a Command to send a function to a ExecutionEngine.

Parameters:

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.

---

Member Function Documentation

base::ActionInterface* RTT::scripting::CallFunction::copy

(

std::map< const base::DataSourceBase *, base::DataSourceBase * > &

alreadyCloned

)

const [inline, virtual]

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(), and RTT::internal::AssignableDataSource< T >::set().

virtual bool RTT::scripting::CallFunction::execute

(

)

[inline, virtual]

Execute the functionality of this action.

Returns:

true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 108 of file CallFunction.hpp.

virtual void RTT::scripting::CallFunction::reset

(

)

[inline, virtual]

Reset this action.

Must be used after execute() failed.

Reimplemented from RTT::base::ActionInterface.

Definition at line 130 of file CallFunction.hpp.

virtual bool RTT::scripting::CallFunction::valid

(

)

const [inline, virtual]

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.

---

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

• rtt/scripting/CallFunction.hpp