RTT::scripting::CallFunction Class Reference

#include <CallFunction.hpp>

Inheritance diagram for RTT::scripting::CallFunction:
Inheritance graph
[legend]

List of all members.

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)
 CallFunction (base::ActionInterface *init_com, boost::shared_ptr< ProgramInterface > foo, ExecutionEngine *p, ExecutionEngine *caller, internal::AssignableDataSource< ProgramInterface * > *v=0, internal::AssignableDataSource< bool > *a=0)
base::ActionInterfaceclone () const
base::ActionInterfaceclone () const
base::ActionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
base::ActionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
virtual bool execute ()
virtual bool execute ()
virtual void readArguments ()
virtual void readArguments ()
virtual void reset ()
virtual void reset ()
virtual bool valid () const
virtual bool valid () const
 ~CallFunction ()
 ~CallFunction ()

Private Member Functions

bool fooDone ()
bool fooDone ()

Private Attributes

boost::shared_ptr
< ProgramInterface
_foo
internal::AssignableDataSource
< ProgramInterface * >
::shared_ptr 
_v
bool isqueued
bool maccept
ExecutionEnginemcaller
base::ActionInterfaceminit
ExecutionEnginemrunner

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 56 of file install/include/rtt/scripting/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 86 of file install/include/rtt/scripting/CallFunction.hpp.

RTT::scripting::CallFunction::~CallFunction (  )  [inline]
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 86 of file rtt/scripting/CallFunction.hpp.

RTT::scripting::CallFunction::~CallFunction (  )  [inline]

Definition at line 98 of file rtt/scripting/CallFunction.hpp.


Member Function Documentation

base::ActionInterface* RTT::scripting::CallFunction::clone (  )  const [inline, virtual]

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 138 of file rtt/scripting/CallFunction.hpp.

base::ActionInterface* RTT::scripting::CallFunction::clone (  )  const [inline, virtual]

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 138 of file install/include/rtt/scripting/CallFunction.hpp.

base::ActionInterface* RTT::scripting::CallFunction::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned  )  const [inline]

Definition at line 144 of file rtt/scripting/CallFunction.hpp.

base::ActionInterface* RTT::scripting::CallFunction::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned  )  const [inline]
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 102 of file rtt/scripting/CallFunction.hpp.

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 102 of file install/include/rtt/scripting/CallFunction.hpp.

bool RTT::scripting::CallFunction::fooDone (  )  [inline, private]

Definition at line 74 of file rtt/scripting/CallFunction.hpp.

bool RTT::scripting::CallFunction::fooDone (  )  [inline, private]
virtual void RTT::scripting::CallFunction::readArguments (  )  [inline, virtual]

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 133 of file rtt/scripting/CallFunction.hpp.

virtual void RTT::scripting::CallFunction::readArguments (  )  [inline, virtual]

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 133 of file install/include/rtt/scripting/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 123 of file rtt/scripting/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 123 of file install/include/rtt/scripting/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 129 of file rtt/scripting/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 129 of file install/include/rtt/scripting/CallFunction.hpp.


Member Data Documentation

boost::shared_ptr< ProgramInterface > RTT::scripting::CallFunction::_foo [private]

_foo contains the exact same pointer as _v->get(), but also serves as a shared_ptr handle for cleanup after clone().

Definition at line 70 of file install/include/rtt/scripting/CallFunction.hpp.

_v is only necessary for the copy/clone semantics.

Definition at line 65 of file install/include/rtt/scripting/CallFunction.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:50:11 2013