Orocos Real-Time Toolkit
2.8.3
|
This base class serves as a template-less handle for operation objects and also stores the name and documentation of an operation. More...
#include <rtt/base/OperationBase.hpp>
Public Member Functions | |
RTT_API | OperationBase (const std::string &name) |
virtual RTT_API | ~OperationBase () |
const std::string & | getName () |
Returns the name of this operation. More... | |
const std::vector< std::string > & | getDescriptions () |
Returns all the documented descriptions of this operation, as a single list, starting with the operation's description, followed by the name, description pairs of each argument. More... | |
virtual DisposableInterface::shared_ptr | getImplementation ()=0 |
Returns the implementation object of this operation. More... | |
virtual const DisposableInterface::shared_ptr | getImplementation () const =0 |
bool | ready () const |
An operation is ready if it has an implementation and is present in a TaskContext. More... | |
void | setOwner (ExecutionEngine *ee) |
Updates the owning ExecutionEngine that might execute this operation. More... | |
ExecutionEngine * | getOwner () const |
Protected Member Functions | |
RTT_API void | mdoc (const std::string &description) |
RTT_API void | marg (const std::string &name, const std::string &description) |
virtual void | ownerUpdated ()=0 |
Protected Attributes | |
std::string | mname |
std::vector< std::string > | descriptions |
ExecutionEngine * | mowner |
This base class serves as a template-less handle for operation objects and also stores the name and documentation of an operation.
Definition at line 67 of file OperationBase.hpp.
RTT::base::OperationBase::OperationBase | ( | const std::string & | name | ) |
Definition at line 54 of file OperationBase.cpp.
References descriptions.
|
virtual |
Definition at line 60 of file OperationBase.cpp.
|
inline |
Returns all the documented descriptions of this operation, as a single list, starting with the operation's description, followed by the name, description pairs of each argument.
In case no argument was documented, only the description of the operation is returned.
Definition at line 93 of file OperationBase.hpp.
References descriptions, and getImplementation().
Referenced by RTT::internal::OperationInterfacePartHelper::description(), RTT::internal::OperationInterfacePartFusedDS< Signature, ObjT >::description(), RTT::internal::OperationInterfacePartHelper::getArgumentList(), and RTT::internal::OperationInterfacePartFusedDS< Signature, ObjT >::getArgumentList().
|
pure virtual |
Returns the implementation object of this operation.
Implemented in RTT::Operation< Signature >, RTT::Operation< bool(std::string)>, and RTT::Operation< bool(std::string) >.
Referenced by RTT::Service::addLocalOperation(), getDescriptions(), and ready().
|
pure virtual |
Implemented in RTT::Operation< Signature >, RTT::Operation< bool(std::string)>, and RTT::Operation< bool(std::string) >.
|
inline |
Returns the name of this operation.
Definition at line 84 of file OperationBase.hpp.
References mname.
Referenced by RTT::Service::addLocalOperation(), RTT::Service::addOperation(), RTT::Service::addOperationDS(), RTT::Service::addSynchronousOperation(), RTT::internal::OperationInterfacePartFused< bool(std::string)>::getName(), RTT::internal::SynchronousOperationInterfacePartFused< Signature >::getName(), and RTT::internal::OperationInterfacePartFusedDS< Signature, ObjT >::getName().
|
inline |
Definition at line 122 of file OperationBase.hpp.
References mowner.
|
protected |
Definition at line 68 of file OperationBase.cpp.
References descriptions.
Referenced by RTT::Operation< bool(std::string) >::arg().
|
protected |
Definition at line 64 of file OperationBase.cpp.
References descriptions.
Referenced by RTT::Operation< bool(std::string) >::doc().
|
protectedpure virtual |
Referenced by setOwner().
|
inline |
An operation is ready if it has an implementation and is present in a TaskContext.
Definition at line 108 of file OperationBase.hpp.
References getImplementation().
|
inline |
Updates the owning ExecutionEngine that might execute this operation.
ee |
Definition at line 116 of file OperationBase.hpp.
References ownerUpdated().
Referenced by RTT::Service::addLocalOperation().
|
protected |
Definition at line 71 of file OperationBase.hpp.
Referenced by getDescriptions(), marg(), mdoc(), and OperationBase().
|
protected |
Definition at line 70 of file OperationBase.hpp.
Referenced by getName().
|
protected |
Definition at line 72 of file OperationBase.hpp.
Referenced by RTT::Operation< bool(std::string) >::calls(), RTT::Operation< bool(std::string) >::getOperationCaller(), and getOwner().