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>

Inheritance diagram for RTT::base::OperationBase:

List of all members.

Public Member Functions
RTT_API	OperationBase (const std::string &name)
const std::string &	getName ()
	Returns the name of this operation.
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.
virtual DisposableInterface::shared_ptr	getImplementation ()=0
	Returns the implementation object of this operation.
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.
void	setOwner (ExecutionEngine *ee)
	Updates the owning ExecutionEngine that might execute this operation.
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

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 66 of file OperationBase.hpp.

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.