Orocos Real-Time Toolkit
2.8.3
|
#include <rtt/scripting/CommandBinary.hpp>
Public Types | |
typedef boost::shared_ptr< ActionInterface > | shared_ptr |
Use this type for shared pointer storage of an ActionInterface object. More... | |
Public Member Functions | |
CommandBinary (base::ActionInterface *f, base::ActionInterface *s) | |
virtual | ~CommandBinary () |
void | readArguments () |
This is invoked some time before execute() at a time when the action may read its function arguments. More... | |
virtual bool | valid () const |
Inspect if this action was executed and valid. More... | |
virtual bool | execute () |
Execute the functionality of this action. More... | |
virtual void | reset () |
Reset this action. More... | |
virtual base::ActionInterface * | clone () const |
The Clone Software Pattern. More... | |
virtual base::ActionInterface * | copy (std::map< const base::DataSourceBase *, base::DataSourceBase * > &alreadyCloned) const |
When copying an Orocos program, we want identical internal::DataSource's to be mapped to identical DataSources, in order for the program to work correctly. More... | |
Public Attributes | |
base::ActionInterface * | _f |
base::ActionInterface * | _s |
Definition at line 50 of file CommandBinary.hpp.
|
inherited |
Use this type for shared pointer storage of an ActionInterface object.
Definition at line 78 of file ActionInterface.hpp.
|
inline |
Definition at line 54 of file CommandBinary.hpp.
|
inlinevirtual |
Definition at line 56 of file CommandBinary.hpp.
|
inlinevirtual |
The Clone Software Pattern.
Implements RTT::base::ActionInterface.
Definition at line 78 of file CommandBinary.hpp.
References RTT::base::ActionInterface::clone(), and CommandBinary().
|
inlinevirtual |
When copying an Orocos program, we want identical internal::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 internal::DataSource's onto their new replacements. This way, it is possible to check before cloning a internal::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 internal::DataSource, it is important that you reimplement this function correctly though.
Reimplemented from RTT::base::ActionInterface.
Definition at line 81 of file CommandBinary.hpp.
References CommandBinary(), and RTT::base::ActionInterface::copy().
|
inlinevirtual |
Execute the functionality of this action.
Implements RTT::base::ActionInterface.
Definition at line 71 of file CommandBinary.hpp.
References RTT::base::ActionInterface::execute().
|
inlinevirtual |
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 61 of file CommandBinary.hpp.
References RTT::base::ActionInterface::readArguments().
|
inlinevirtual |
Reset this action.
Must be used after execute() failed.
Reimplemented from RTT::base::ActionInterface.
Definition at line 74 of file CommandBinary.hpp.
References RTT::base::ActionInterface::reset().
|
inlinevirtual |
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 67 of file CommandBinary.hpp.
References RTT::base::ActionInterface::valid().
base::ActionInterface* RTT::scripting::CommandBinary::_f |
Definition at line 52 of file CommandBinary.hpp.
Referenced by ~CommandBinary().
base::ActionInterface* RTT::scripting::CommandBinary::_s |
Definition at line 53 of file CommandBinary.hpp.
Referenced by ~CommandBinary().