RTT::base::OperationBase Class Reference

#include <OperationBase.hpp>

Inheritance diagram for RTT::base::OperationBase:

[legend]

List of all members.

Public Member Functions
const std::vector< std::string > &	getDescriptions ()
const std::vector< std::string > &	getDescriptions ()
virtual const DisposableInterface::shared_ptr	getImplementation () const =0
virtual DisposableInterface::shared_ptr	getImplementation ()=0
virtual const DisposableInterface::shared_ptr	getImplementation () const =0
virtual DisposableInterface::shared_ptr	getImplementation ()=0
const std::string &	getName ()
const std::string &	getName ()
RTT_API	OperationBase (const std::string &name)
RTT_API	OperationBase (const std::string &name)
bool	ready () const
bool	ready () const
void	setOwner (ExecutionEngine *ee)
void	setOwner (ExecutionEngine *ee)
virtual RTT_API	~OperationBase ()
virtual RTT_API	~OperationBase ()
Protected Member Functions
RTT_API void	marg (const std::string &name, const std::string &description)
RTT_API void	marg (const std::string &name, const std::string &description)
RTT_API void	mdoc (const std::string &description)
RTT_API void	mdoc (const std::string &description)
virtual void	ownerUpdated ()=0
virtual void	ownerUpdated ()=0
Protected Attributes
std::vector< std::string >	descriptions
std::string	mname
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 64 of file install/include/rtt/base/OperationBase.hpp.

---

Constructor & Destructor Documentation

RTT::base::OperationBase::OperationBase

(

const std::string &

name

)

Definition at line 49 of file OperationBase.cpp.

RTT::base::OperationBase::~OperationBase

(

)

[virtual]

Definition at line 55 of file OperationBase.cpp.

RTT_API RTT::base::OperationBase::OperationBase

(

const std::string &

name

)

virtual RTT_API RTT::base::OperationBase::~OperationBase

(

)

[virtual]

---

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.

Returns:

A vector with all documented descriptions.

Definition at line 92 of file rtt/base/OperationBase.hpp.

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.

Returns:

A vector with all documented descriptions.

Definition at line 90 of file install/include/rtt/base/OperationBase.hpp.

virtual const DisposableInterface::shared_ptr RTT::base::OperationBase::getImplementation

(

)

const [pure virtual]

Implemented in RTT::Operation< Signature >, RTT::Operation< Signature >, RTT::Operation< void(double)>, RTT::Operation< void(double)>, RTT::Operation< double &(const double &)>, RTT::Operation< double &(const double &)>, RTT::Operation< const double &(void)>, RTT::Operation< const double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(double &)>, RTT::Operation< double(double &)>, RTT::Operation< double(void)>, RTT::Operation< double(void)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int)>, and RTT::Operation< double(int)>.

virtual DisposableInterface::shared_ptr RTT::base::OperationBase::getImplementation

(

)

[pure virtual]

Returns the implementation object of this operation.

Returns:

Implemented in RTT::Operation< Signature >, RTT::Operation< Signature >, RTT::Operation< void(double)>, RTT::Operation< void(double)>, RTT::Operation< double &(const double &)>, RTT::Operation< double &(const double &)>, RTT::Operation< const double &(void)>, RTT::Operation< const double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(double &)>, RTT::Operation< double(double &)>, RTT::Operation< double(void)>, RTT::Operation< double(void)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int)>, and RTT::Operation< double(int)>.

virtual const DisposableInterface::shared_ptr RTT::base::OperationBase::getImplementation

(

)

const [pure virtual]

Implemented in RTT::Operation< Signature >, RTT::Operation< Signature >, RTT::Operation< void(double)>, RTT::Operation< void(double)>, RTT::Operation< double &(const double &)>, RTT::Operation< double &(const double &)>, RTT::Operation< const double &(void)>, RTT::Operation< const double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(double &)>, RTT::Operation< double(double &)>, RTT::Operation< double(void)>, RTT::Operation< double(void)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int)>, and RTT::Operation< double(int)>.

virtual DisposableInterface::shared_ptr RTT::base::OperationBase::getImplementation

(

)

[pure virtual]

Returns the implementation object of this operation.

Returns:

Implemented in RTT::Operation< Signature >, RTT::Operation< Signature >, RTT::Operation< void(double)>, RTT::Operation< void(double)>, RTT::Operation< double &(const double &)>, RTT::Operation< double &(const double &)>, RTT::Operation< const double &(void)>, RTT::Operation< const double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(double &)>, RTT::Operation< double(double &)>, RTT::Operation< double(void)>, RTT::Operation< double(void)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int)>, and RTT::Operation< double(int)>.

const std::string& RTT::base::OperationBase::getName

(

void

)

[inline]

Returns the name of this operation.

Returns:

The name.

Definition at line 83 of file rtt/base/OperationBase.hpp.

const std::string& RTT::base::OperationBase::getName

(

)

[inline]

Returns the name of this operation.

Returns:

The name.

Definition at line 81 of file install/include/rtt/base/OperationBase.hpp.

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

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

Definition at line 63 of file OperationBase.cpp.

RTT_API void RTT::base::OperationBase::mdoc

(

const std::string &

description

)

[protected]

void RTT::base::OperationBase::mdoc

(

const std::string &

description

)

[protected]

Definition at line 59 of file OperationBase.cpp.

virtual void RTT::base::OperationBase::ownerUpdated

(

)

[protected, pure virtual]

Implemented in RTT::Operation< Signature >, RTT::Operation< Signature >, RTT::Operation< void(double)>, RTT::Operation< void(double)>, RTT::Operation< double &(const double &)>, RTT::Operation< double &(const double &)>, RTT::Operation< const double &(void)>, RTT::Operation< const double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(double &)>, RTT::Operation< double(double &)>, RTT::Operation< double(void)>, RTT::Operation< double(void)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int)>, and RTT::Operation< double(int)>.

virtual void RTT::base::OperationBase::ownerUpdated

(

)

[protected, pure virtual]

Implemented in RTT::Operation< Signature >, RTT::Operation< Signature >, RTT::Operation< void(double)>, RTT::Operation< void(double)>, RTT::Operation< double &(const double &)>, RTT::Operation< double &(const double &)>, RTT::Operation< const double &(void)>, RTT::Operation< const double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double &(void)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double, bool, std::string)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(int, double, bool)>, RTT::Operation< double(double &)>, RTT::Operation< double(double &)>, RTT::Operation< double(void)>, RTT::Operation< double(void)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int, double, bool, std::string, float)>, RTT::Operation< double(int)>, and RTT::Operation< double(int)>.

bool RTT::base::OperationBase::ready

(

void

)

const [inline]

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

Returns:

true if ready.

Definition at line 107 of file rtt/base/OperationBase.hpp.

bool RTT::base::OperationBase::ready

(

)

const [inline]

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

Returns:

true if ready.

Definition at line 105 of file install/include/rtt/base/OperationBase.hpp.

void RTT::base::OperationBase::setOwner

(

ExecutionEngine *

ee

)

[inline]

Updates the owning ExecutionEngine that might execute this operation.

Parameters:

ee

Definition at line 115 of file rtt/base/OperationBase.hpp.

void RTT::base::OperationBase::setOwner

(

ExecutionEngine *

ee

)

[inline]

Updates the owning ExecutionEngine that might execute this operation.

Parameters:

ee

Definition at line 113 of file install/include/rtt/base/OperationBase.hpp.

---

Member Data Documentation

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

Definition at line 68 of file install/include/rtt/base/OperationBase.hpp.

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

Definition at line 67 of file install/include/rtt/base/OperationBase.hpp.

ExecutionEngine * RTT::base::OperationBase::mowner [protected]

Definition at line 69 of file install/include/rtt/base/OperationBase.hpp.

---

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

• install/include/rtt/base/OperationBase.hpp
• rtt/base/OperationBase.hpp
• OperationBase.cpp