Based on the software pattern 'composite', this class RTT_SCRIPTING_API allows composing command objects into one command object. More...

#include <rtt/scripting/CommandComposite.hpp>

Inheritance diagram for RTT::scripting::CommandComposite:

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

Public Member Functions
	CommandComposite ()

	CommandComposite (std::vector< base::ActionInterface * > cv)

	CommandComposite (const CommandComposite &orig)
	Copy-Construct a clone() of all commands. More...

virtual	~CommandComposite ()

virtual bool	execute ()
	Execute the functionality of all commands. More...

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

bool	valid () const
	Inspect if this action was executed and valid. More...

virtual void	add (base::ActionInterface *com)
	add a command to the vect More...

virtual base::ActionInterface *	clone () const
	The Clone Software Pattern. More...

virtual 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 void	reset ()
	Reset this action. More...

Detailed Description

Based on the software pattern 'composite', this class RTT_SCRIPTING_API allows composing command objects into one command object.

Definition at line 50 of file CommandComposite.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::CommandComposite::CommandComposite ( )

inline

Definition at line 54 of file CommandComposite.hpp.

RTT::scripting::CommandComposite::CommandComposite ( std::vector< base::ActionInterface * > cv )

inline

Definition at line 56 of file CommandComposite.hpp.

RTT::scripting::CommandComposite::CommandComposite ( const CommandComposite & orig )

inline

Copy-Construct a clone() of all commands.

Definition at line 63 of file CommandComposite.hpp.

virtual RTT::scripting::CommandComposite::~CommandComposite ( )

inlinevirtual

Definition at line 70 of file CommandComposite.hpp.

Member Function Documentation

virtual void RTT::scripting::CommandComposite::add ( base::ActionInterface * com )

inlinevirtual

add a command to the vect

Definition at line 106 of file CommandComposite.hpp.

Referenced by RTT::scripting::FunctionGraphBuilder::appendFunction(), copy(), RTT::scripting::StateGraphParser::getParserResult(), RTT::scripting::FunctionFactory::produce(), and RTT::scripting::StateGraphParser::storeOffset().

virtual base::ActionInterface* RTT::scripting::CommandComposite::clone ( ) const

inlinevirtual

The Clone Software Pattern.

Implements RTT::base::ActionInterface.

Definition at line 110 of file CommandComposite.hpp.

virtual base::ActionInterface* RTT::scripting::CommandComposite::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 115 of file CommandComposite.hpp.

References add().

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

inlinevirtual

Execute the functionality of all commands.

Commands will be executed in the order they have been added

Implements RTT::base::ActionInterface.

Definition at line 81 of file CommandComposite.hpp.

void RTT::scripting::CommandComposite::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 89 of file CommandComposite.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 RTT::scripting::CommandComposite::valid ( ) const

inlinevirtual

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 94 of file CommandComposite.hpp.

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

rtt/scripting/CommandComposite.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation