RTT::detail::EventBase< Signature > Class Template Reference
The base class of Event implementations. More...
#include <rtt/EventBase.hpp>
Public Types | |
|
typedef detail::SubscriberBase < Signature >::SlotFunction | SlotFunction |
|
typedef boost::shared_ptr < ActionInterface > | shared_ptr |
| Use this type for shared pointer storage of an ActionInterface object. | |
Public Member Functions | |
| void | readArguments () |
| This is invoked some time before execute() at a time when the action may read its function arguments. | |
| bool | execute () |
| Execute the functionality of this action. | |
| virtual int | arity () const =0 |
| virtual EventBase< Signature > * | cloneI () const =0 |
| Clone this implementation. | |
| virtual Handle | connect (const SlotFunction &f)=0 |
| Connect a function callback to this subscriber. | |
| virtual Handle | setup (const SlotFunction &f)=0 |
| Setup a function callback to this subscriber. | |
| virtual void | reset () |
| Reset this action. | |
| virtual bool | valid () const |
| Inspect if this action was executed and valid. | |
| 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<typename Signature>
class RTT::detail::EventBase< Signature >
The base class of Event implementations.
Definition at line 52 of file EventBase.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.
| bool RTT::detail::EventBase< Signature >::execute | ( | ) | [inline, virtual] |
Execute the functionality of this action.
- Returns:
- true if the action was accepted, false otherwise
Implements RTT::ActionInterface.
Definition at line 50 of file EventBase.hpp.
References RTT::detail::EventBase< Signature >::cloneI(), and RTT::detail::EventBase< Signature >::readArguments().
| 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 class was generated from the following file:
- rtt/EventBase.hpp
