RTT::detail::MethodBase< F > Struct Template Reference
The base class for all method implementations. More...
#include <rtt/MethodBase.hpp>
Public Types | |
|
typedef boost::shared_ptr < ActionInterface > | shared_ptr |
| Use this type for shared pointer storage of an ActionInterface object. | |
Public Member Functions | |
| virtual MethodBase< F > * | cloneI () const =0 |
| virtual bool | execute ()=0 |
| Execute the functionality of this action. | |
| virtual void | reset () |
| Reset this action. | |
| virtual bool | valid () const |
| Inspect if this action was executed and valid. | |
| virtual void | readArguments ()=0 |
| This is invoked some time before execute() at a time when the action may read its function arguments. | |
| virtual ActionInterface * | clone () const =0 |
| The Clone Software Pattern. | |
| virtual ActionInterface * | 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
template<class F>
struct RTT::detail::MethodBase< F >
The base class for all method implementations.
Both local and remove method implementations must inherit from this class.
Definition at line 54 of file MethodBase.hpp.
Member Function Documentation
| virtual ActionInterface* RTT::ActionInterface::copy | ( | std::map< const DataSourceBase *, DataSourceBase * > & | alreadyCloned | ) | const [virtual, inherited] |
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 in RTT::detail::DataSourceArgsEvent< SignatureT, FunctorT >, and RTT::DispatchAction.
| virtual bool RTT::ActionInterface::execute | ( | ) | [pure virtual, inherited] |
Execute the functionality of this action.
- Returns:
- true if the action was accepted, false otherwise
Implemented in RTT::detail::DataSourceArgsEvent< SignatureT, FunctorT >, RTT::DispatchAction, and RTT::detail::EventBase< Signature >.
| virtual void RTT::ActionInterface::reset | ( | ) | [virtual, inherited] |
| virtual bool RTT::ActionInterface::valid | ( | ) | const [virtual, inherited] |
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 in RTT::DispatchAction.
The documentation for this struct was generated from the following file:
- rtt/MethodBase.hpp
