RTT::DispatchAction Class Reference
An action which invokes a dispatch command in execute(). More...
#include <rtt/DispatchAction.hpp>
Public Types | |
|
typedef boost::shared_ptr < ActionInterface > | shared_ptr |
| Use this type for shared pointer storage of an ActionInterface object. | |
Public Member Functions | |
| DispatchAction (DispatchInterface *di) | |
| void | reset () |
| Reset this action. | |
| bool | execute () |
| Execute the functionality of this action. | |
| bool | valid () const |
| Inspect if this action was executed and valid. | |
| void | readArguments () |
| This is invoked some time before execute() at a time when the action may read its function arguments. | |
| virtual DispatchAction * | clone () const |
| The Clone Software Pattern. | |
| virtual DispatchAction * | 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. | |
Detailed Description
An action which invokes a dispatch command in execute().
Definition at line 50 of file DispatchAction.hpp.
Member Function Documentation
| virtual DispatchAction* RTT::DispatchAction::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 87 of file DispatchAction.hpp.
| bool RTT::DispatchAction::execute | ( | ) | [inline, virtual] |
Execute the functionality of this action.
- Returns:
- true if the action was accepted, false otherwise
Implements RTT::ActionInterface.
Definition at line 65 of file DispatchAction.hpp.
| void RTT::DispatchAction::reset | ( | ) | [inline, virtual] |
Reset this action.
Must be used after execute() failed.
Reimplemented from RTT::ActionInterface.
Definition at line 63 of file DispatchAction.hpp.
| bool RTT::DispatchAction::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 79 of file DispatchAction.hpp.
The documentation for this class was generated from the following file:
