RTT::base::ActionInterface Class Reference

Based on the software pattern 'command', this interface allows execution of action objects. More...

#include <ActionInterface.hpp>

Inheritance diagram for RTT::base::ActionInterface:

Public Types
typedef boost::shared_ptr < ActionInterface >	shared_ptr
typedef boost::shared_ptr < ActionInterface >	shared_ptr
Public Member Functions
virtual ActionInterface *	clone () const =0
virtual ActionInterface *	clone () const =0
virtual ActionInterface *	copy (std::map< const DataSourceBase , DataSourceBase > &alreadyCloned) const
virtual ActionInterface *	copy (std::map< const DataSourceBase , DataSourceBase > &alreadyCloned) const
virtual bool	execute ()=0
virtual bool	execute ()=0
virtual void	readArguments ()=0
virtual void	readArguments ()=0
virtual void	reset ()
virtual void	reset ()
virtual bool	valid () const
virtual bool	valid () const
virtual	~ActionInterface ()
virtual	~ActionInterface ()

Detailed Description

Based on the software pattern 'command', this interface allows execution of action objects.

The action may return true or false to indicate if it was accepted (true) or rejected (false).

Copy versus clone semantics

Copy is used to copy a whole tree of actions,: storing common information in web of internal::DataSource's. The internal::DataSource 'web' will be copied such that an entirely new action tree references the new DataSources.

When clone is used, the Datasources remain: in place, and only the action is cloned, thus, the original and the clone point to the same DataSource. The deletion of DataSources must thus be managed with smart pointers. A clone is thus used for within the existing internal::DataSource web.

Definition at line 66 of file install/include/rtt/base/ActionInterface.hpp.

Member Typedef Documentation

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

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

Definition at line 78 of file rtt/base/ActionInterface.hpp.

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

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

Definition at line 51 of file install/include/rtt/base/ActionInterface.hpp.

Constructor & Destructor Documentation

RTT::ActionInterface::~ActionInterface ( ) [virtual]

Definition at line 45 of file ActionInterface.cpp.

virtual RTT::base::ActionInterface::~ActionInterface ( ) [virtual]

Member Function Documentation

virtual ActionInterface* RTT::base::ActionInterface::clone ( ) const [pure virtual]

The Clone Software Pattern.

virtual ActionInterface* RTT::base::ActionInterface::clone ( ) const [pure virtual]

The Clone Software Pattern.

virtual ActionInterface* RTT::base::ActionInterface::copy ( std::map< const DataSourceBase *, DataSourceBase * > & alreadyCloned ) const [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.

ActionInterface * RTT::ActionInterface::copy ( std::map< const DataSourceBase *, DataSourceBase * > & alreadyCloned ) const [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.

Definition at line 58 of file ActionInterface.cpp.

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

Execute the functionality of this action.

Returns:: true if the action was accepted, false otherwise

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

Execute the functionality of this action.

Returns:: true if the action was accepted, false otherwise

virtual void RTT::base::ActionInterface::readArguments ( ) [pure virtual]

This is invoked some time before execute() at a time when the action may read its function arguments.

virtual void RTT::base::ActionInterface::readArguments ( ) [pure virtual]

This is invoked some time before execute() at a time when the action may read its function arguments.

virtual void RTT::base::ActionInterface::reset ( ) [virtual]

Reset this action. Must be used after execute() failed.

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

void RTT::ActionInterface::reset ( ) [virtual]

Reset this action. Must be used after execute() failed.

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

Definition at line 48 of file ActionInterface.cpp.

virtual bool RTT::base::ActionInterface::valid ( ) const [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 in RTT::scripting::CallFunction, RTT::scripting::CommandBinary, RTT::scripting::CommandComposite, RTT::scripting::TryCommand, RTT::scripting::CallFunction, RTT::scripting::CommandBinary, RTT::scripting::CommandComposite, and RTT::scripting::TryCommand.

bool RTT::ActionInterface::valid ( ) const [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 in RTT::scripting::CallFunction, RTT::scripting::CommandBinary, RTT::scripting::CommandComposite, RTT::scripting::TryCommand, RTT::scripting::CallFunction, RTT::scripting::CommandBinary, RTT::scripting::CommandComposite, and RTT::scripting::TryCommand.

Definition at line 51 of file ActionInterface.cpp.

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