Based on the software pattern 'composite', this class RTT_SCRIPTING_API allows composing command objects into one command object. More...
#include <CommandComposite.hpp>
Public Member Functions | |
| virtual void | add (base::ActionInterface *com) |
| virtual base::ActionInterface * | clone () const |
| CommandComposite () | |
| CommandComposite (std::vector< base::ActionInterface * > cv) | |
| CommandComposite (const CommandComposite &orig) | |
| virtual base::ActionInterface * | copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const |
| virtual bool | execute () |
| void | readArguments () |
| bool | valid () const |
| virtual | ~CommandComposite () |
Private Attributes | |
| std::vector < base::ActionInterface * > | vect |
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 | ( | ) | [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 | ( | ) | [inline, virtual] |
Definition at line 70 of file CommandComposite.hpp.
Member Function Documentation
| virtual void RTT::scripting::CommandComposite::add | ( | base::ActionInterface * | com | ) | [inline, virtual] |
add a command to the vect
Definition at line 106 of file CommandComposite.hpp.
| virtual base::ActionInterface* RTT::scripting::CommandComposite::clone | ( | ) | const [inline, virtual] |
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 [inline, virtual] |
Definition at line 115 of file CommandComposite.hpp.
| virtual bool RTT::scripting::CommandComposite::execute | ( | ) | [inline, virtual] |
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 | ( | ) | [inline, virtual] |
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 [inline, 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 from RTT::base::ActionInterface.
Definition at line 94 of file CommandComposite.hpp.
Member Data Documentation
std::vector<base::ActionInterface*> RTT::scripting::CommandComposite::vect [private] |
Definition at line 124 of file CommandComposite.hpp.
The documentation for this class was generated from the following file: