RTT::scripting::CommandFunction Class Reference

A functor with the base::ActionInterface, for the case where the functor is a bool(void). More...

#include <rtt/scripting/CommandFunctors.hpp>

Inheritance diagram for RTT::scripting::CommandFunction:

Public Types
typedef boost::function< bool(void)>	Function
typedef boost::shared_ptr< ActionInterface >	shared_ptr
	Use this type for shared pointer storage of an ActionInterface object. More...

Public Member Functions
	CommandFunction (Function impl)
virtual void	readArguments ()
	This is invoked some time before execute() at a time when the action may read its function arguments. More...
virtual bool	execute ()
	Execute the functionality of this action. More...
virtual CommandFunction *	clone () const
	The Clone Software Pattern. More...
virtual void	reset ()
	Reset this action. More...
virtual bool	valid () const
	Inspect if this action was executed and valid. More...
virtual ActionInterface *	copy (std::map< const DataSourceBase *, 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...

Public Attributes
Function	com

Detailed Description

A functor with the base::ActionInterface, for the case where the functor is a bool(void).

Definition at line 57 of file CommandFunctors.hpp.

Member Typedef Documentation

typedef boost::function<bool(void)> RTT::scripting::CommandFunction::Function

Definition at line 61 of file CommandFunctors.hpp.

typedef boost::shared_ptr<ActionInterface> RTT::base::ActionInterface::shared_ptr

inherited

Use this type for shared pointer storage of an ActionInterface object.

Definition at line 78 of file ActionInterface.hpp.

Constructor & Destructor Documentation

RTT::scripting::CommandFunction::CommandFunction ( Function  impl )

inline

Definition at line 68 of file CommandFunctors.hpp.

Referenced by clone().

Member Function Documentation

virtual CommandFunction* RTT::scripting::CommandFunction::clone ( ) const

inlinevirtual

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 77 of file CommandFunctors.hpp.

References CommandFunction().

ActionInterface * ActionInterface::copy ( std::map< const DataSourceBase *, DataSourceBase * > &  alreadyCloned ) const

virtualinherited

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 in RTT::scripting::CallFunction, RTT::scripting::EvalCommand, RTT::scripting::CommandComposite, RTT::scripting::CommandDataSourceBool, RTT::internal::AssignCommand< T, S >, RTT::scripting::TryCommand, RTT::scripting::CommandBinary, and RTT::scripting::CommandDataSource.

Definition at line 60 of file ActionInterface.cpp.

References RTT::base::ActionInterface::clone().

Referenced by RTT::internal::DataSourceCommand::copy(), RTT::scripting::CommandBinary::copy(), RTT::scripting::TryCommand::copy(), RTT::internal::ActionAliasDataSource< T >::copy(), and RTT::internal::ActionAliasAssignableDataSource< T >::copy().

virtual bool RTT::scripting::CommandFunction::execute ( )

inlinevirtual

Execute the functionality of this action.

Returns

true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 75 of file CommandFunctors.hpp.

References com.

virtual void RTT::scripting::CommandFunction::readArguments ( )

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 73 of file CommandFunctors.hpp.

void ActionInterface::reset ( )

virtualinherited

Reset this action.

Must be used after execute() failed.

Reimplemented in RTT::scripting::EvalCommand, RTT::scripting::CallFunction, RTT::scripting::CommandDataSourceBool, RTT::scripting::TryCommand, RTT::scripting::CommandBinary, RTT::scripting::CommandCounter, and RTT::scripting::CommandDataSource.

Definition at line 50 of file ActionInterface.cpp.

Referenced by RTT::scripting::StateMachine::activate(), RTT::internal::ActionAliasDataSource< T >::evaluate(), RTT::internal::ActionAliasAssignableDataSource< T >::evaluate(), RTT::internal::ActionAliasDataSource< T >::get(), RTT::internal::ActionAliasAssignableDataSource< T >::get(), RTT::internal::DataSourceCommand::reset(), RTT::scripting::CommandBinary::reset(), RTT::scripting::TryCommand::reset(), and RTT::scripting::VertexNode::startExecution().

bool ActionInterface::valid ( ) const

virtualinherited

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 in RTT::scripting::CallFunction, RTT::scripting::CommandComposite, RTT::scripting::TryCommand, and RTT::scripting::CommandBinary.

Definition at line 53 of file ActionInterface.cpp.

Referenced by RTT::scripting::VertexNode::isValid(), RTT::scripting::CommandBinary::valid(), and RTT::scripting::TryCommand::valid().

Member Data Documentation

Function RTT::scripting::CommandFunction::com

Definition at line 63 of file CommandFunctors.hpp.

Referenced by execute().

---

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

• rtt/scripting/CommandFunctors.hpp