RTT::CommandComposite Class Reference
Based on the software pattern 'composite', this class RTT_API allows composing command objects into one command object. More...
#include <rtt/CommandComposite.hpp>
Public Types | |
|
typedef boost::shared_ptr < ActionInterface > | shared_ptr |
| Use this type for shared pointer storage of an ActionInterface object. | |
Public Member Functions | |
| CommandComposite (std::vector< CommandInterface * > cv) | |
| CommandComposite (const CommandComposite &orig) | |
| Copy-Construct a clone() of all commands. | |
| virtual bool | execute () |
| Execute the functionality of all commands. | |
| void | readArguments () |
| This is invoked some time before execute() at a time when the action may read its function arguments. | |
| bool | valid () const |
| Inspect if this action was executed and valid. | |
| virtual void | add (CommandInterface *com) |
| add a command to the vect | |
| virtual CommandInterface * | clone () const |
| The Clone Software Pattern. | |
| virtual CommandInterface * | copy (std::map< const DataSourceBase *, DataSourceBase * > &alreadyCloned) const |
| When copying an Orocos program, we want identical DataSource's to be mapped to identical DataSources, in order for the program to work correctly. | |
| virtual void | reset () |
| Reset this action. | |
Detailed Description
Based on the software pattern 'composite', this class RTT_API allows composing command objects into one command object.
Definition at line 48 of file CommandComposite.hpp.
Member Function Documentation
| virtual void RTT::CommandComposite::add | ( | CommandInterface * | com | ) | [inline, virtual] |
add a command to the vect
Definition at line 104 of file CommandComposite.hpp.
Referenced by copy().
| virtual CommandInterface* RTT::CommandComposite::copy | ( | std::map< const DataSourceBase *, DataSourceBase * > & | alreadyCloned | ) | const [inline, virtual] |
When copying an Orocos program, we want identical 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 DataSource's onto their new replacements. This way, it is possible to check before cloning a 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 DataSource, it is important that you reimplement this function correctly though.
Reimplemented from RTT::ActionInterface.
Definition at line 113 of file CommandComposite.hpp.
References add().
| virtual bool RTT::CommandComposite::execute | ( | ) | [inline, virtual] |
Execute the functionality of all commands.
Commands will be executed in the order they have been added
Implements RTT::ActionInterface.
Definition at line 79 of file CommandComposite.hpp.
| virtual void RTT::ActionInterface::reset | ( | ) | [virtual, inherited] |
Reset this action.
Must be used after execute() failed.
Reimplemented in RTT::AsynchCommandDecorator, RTT::CommandCounter, RTT::CommandDataSource, RTT::CommandDataSourceBool, RTT::CommandDispatch, RTT::CommandExecFunction, RTT::Corba::CommandProxy, RTT::detail::DataSourceArgsCommand< CommandT, CommandF >, RTT::DispatchAction, RTT::DispatchInterface, RTT::TryCommand, and RTT::EvalCommand.
| bool RTT::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::ActionInterface.
Definition at line 92 of file CommandComposite.hpp.
The documentation for this class was generated from the following file:
