Public Member Functions | Protected Member Functions | Protected Attributes
RTT::base::OperationBase Class Reference

#include <OperationBase.hpp>

Inheritance diagram for RTT::base::OperationBase:
Inheritance graph

List of all members.

Public Member Functions

const std::vector< std::string > & getDescriptions ()
getImplementation ()=0
virtual const
getImplementation () const =0
const std::string & getName ()
ExecutionEnginegetOwner () const
RTT_API OperationBase (const std::string &name)
bool ready () const
void setOwner (ExecutionEngine *ee)
virtual RTT_API ~OperationBase ()

Protected Member Functions

RTT_API void marg (const std::string &name, const std::string &description)
RTT_API void mdoc (const std::string &description)
virtual void ownerUpdated ()=0

Protected Attributes

std::vector< std::string > descriptions
std::string mname

Detailed Description

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.

Constructor & Destructor Documentation

RTT::base::OperationBase::OperationBase ( const std::string &  name)

Definition at line 54 of file OperationBase.cpp.

Definition at line 60 of file OperationBase.cpp.

Member Function Documentation

const std::vector<std::string>& RTT::base::OperationBase::getDescriptions ( ) [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.

A vector with all documented descriptions.

Definition at line 93 of file OperationBase.hpp.

const std::string& RTT::base::OperationBase::getName ( ) [inline]

Returns the name of this operation.

The name.

Definition at line 84 of file OperationBase.hpp.

Definition at line 122 of file OperationBase.hpp.

void RTT::base::OperationBase::marg ( const std::string &  name,
const std::string &  description 
) [protected]

Definition at line 68 of file OperationBase.cpp.

void RTT::base::OperationBase::mdoc ( const std::string &  description) [protected]

Definition at line 64 of file OperationBase.cpp.

virtual void RTT::base::OperationBase::ownerUpdated ( ) [protected, pure virtual]
bool RTT::base::OperationBase::ready ( ) const [inline]

An operation is ready if it has an implementation and is present in a TaskContext.

true if ready.

Definition at line 108 of file OperationBase.hpp.

Updates the owning ExecutionEngine that might execute this operation.


Definition at line 116 of file OperationBase.hpp.

Member Data Documentation

std::vector<std::string> RTT::base::OperationBase::descriptions [protected]

Definition at line 71 of file OperationBase.hpp.

std::string RTT::base::OperationBase::mname [protected]

Definition at line 70 of file OperationBase.hpp.

Definition at line 72 of file OperationBase.hpp.

The documentation for this class was generated from the following files:

Author(s): RTT Developers
autogenerated on Sat Jun 8 2019 18:46:37