Public Member Functions | Private Attributes | List of all members
RTT::scripting::CommandComposite Class Reference

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

#include <CommandComposite.hpp>

Inheritance diagram for RTT::scripting::CommandComposite:
Inheritance graph

Public Member Functions

virtual void add (base::ActionInterface *com)
virtual base::ActionInterfaceclone () const
 CommandComposite ()
 CommandComposite (std::vector< base::ActionInterface * > cv)
 CommandComposite (const CommandComposite &orig)
virtual base::ActionInterfacecopy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const
virtual bool execute ()
void readArguments ()
bool valid () const
virtual ~CommandComposite ()
- Public Member Functions inherited from RTT::base::ActionInterface
virtual ActionInterfacecopy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const
virtual void reset ()
virtual ~ActionInterface ()

Private Attributes

std::vector< base::ActionInterface * > vect

Additional Inherited Members

- Public Types inherited from RTT::base::ActionInterface
typedef boost::shared_ptr< ActionInterfaceshared_ptr

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.

Constructor & Destructor Documentation

RTT::scripting::CommandComposite::CommandComposite ( )

Definition at line 54 of file CommandComposite.hpp.

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

Definition at line 56 of file CommandComposite.hpp.

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

Copy-Construct a clone() of all commands

Definition at line 63 of file CommandComposite.hpp.

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

Definition at line 70 of file CommandComposite.hpp.

Member Function Documentation

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

add a command to the vect

Definition at line 106 of file CommandComposite.hpp.

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

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

Definition at line 115 of file CommandComposite.hpp.

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

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 ( )

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.

bool RTT::scripting::CommandComposite::valid ( ) const

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.

Member Data Documentation

std::vector<base::ActionInterface*> RTT::scripting::CommandComposite::vect

Definition at line 124 of file CommandComposite.hpp.

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

Author(s): RTT Developers
autogenerated on Fri Oct 25 2019 03:59:47