RTT::scripting::CommandDataSource Struct Reference

A Command which evaluates a base::DataSourceBase and always returns true. More...

#include <rtt/scripting/CommandDataSource.hpp>

Inheritance diagram for RTT::scripting::CommandDataSource:

Public Types
typedef boost::shared_ptr< ActionInterface >	shared_ptr
	Use this type for shared pointer storage of an ActionInterface object. More...

Public Member Functions
	CommandDataSource (base::DataSourceBase::shared_ptr dsb)
void	readArguments ()
	This is invoked some time before execute() at a time when the action may read its function arguments. More...
bool	execute ()
	Execute the functionality of this action. More...
void	reset ()
	Reset this action. 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...
virtual bool	valid () const
	Inspect if this action was executed and valid. More...

Public Attributes
base::DataSourceBase::shared_ptr	_dsb

Detailed Description

A Command which evaluates a base::DataSourceBase and always returns true.

Definition at line 51 of file CommandDataSource.hpp.

Member Typedef Documentation

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::CommandDataSource::CommandDataSource ( base::DataSourceBase::shared_ptr  dsb )

inline

Definition at line 55 of file CommandDataSource.hpp.

Referenced by clone(), and copy().

Member Function Documentation

base::ActionInterface* RTT::scripting::CommandDataSource::clone ( ) const

inlinevirtual

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 71 of file CommandDataSource.hpp.

References CommandDataSource().

base::ActionInterface* RTT::scripting::CommandDataSource::copy ( std::map< const base::DataSourceBase *, base::DataSourceBase * > &  alreadyCloned ) const

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 75 of file CommandDataSource.hpp.

References CommandDataSource().

bool RTT::scripting::CommandDataSource::execute ( )

inlinevirtual

Execute the functionality of this action.

Returns

true if the action was accepted, false otherwise

Implements RTT::base::ActionInterface.

Definition at line 62 of file CommandDataSource.hpp.

void RTT::scripting::CommandDataSource::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 58 of file CommandDataSource.hpp.

void RTT::scripting::CommandDataSource::reset ( )

inlinevirtual

Reset this action.

Must be used after execute() failed.

Reimplemented from RTT::base::ActionInterface.

Definition at line 67 of file CommandDataSource.hpp.

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

base::DataSourceBase::shared_ptr RTT::scripting::CommandDataSource::_dsb

Definition at line 54 of file CommandDataSource.hpp.

---

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

• rtt/scripting/CommandDataSource.hpp