mtsCallableReadBase Class Reference

#include <mtsCallableReadBase.h>

Inheritance diagram for mtsCallableReadBase:

Public Member Functions
	mtsCallableReadBase (void)
virtual	~mtsCallableReadBase ()
virtual mtsExecutionResult	Execute (mtsGenericObject &result)=0
virtual void	ToStream (std::ostream &outputStream) const =0

Detailed Description

A base class command object with an execute method that uses a placeholder to retrieve some data. This pure virtual base class is derived to support either global functions or methods with the signature "void method(_resultType & result) const"

Constructor & Destructor Documentation

mtsCallableReadBase::mtsCallableReadBase ( void  )

inline

The constructor. Does nothing

virtual mtsCallableReadBase::~mtsCallableReadBase ( )

inlinevirtual

The destructor. Does nothing

Member Function Documentation

virtual mtsExecutionResult mtsCallableReadBase::Execute ( mtsGenericObject &  result )

pure virtual

The execute method. Abstract method to be implemented by derived classes to run the actual operation on the receiver.

Implemented in mtsCallableReadMethodGeneric< _classType >, mtsCallableReadMethod< _classType, _resultType >, and mtsCallableReadReturnVoidMethod< _classType, _returnType >.

virtual void mtsCallableReadBase::ToStream ( std::ostream &  outputStream ) const

pure virtual

Human readable description

Implemented in mtsCallableReadMethodGeneric< _classType >, mtsCallableReadMethod< _classType, _resultType >, and mtsCallableReadReturnVoidMethod< _classType, _returnType >.

---

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

• /home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsCallableReadBase.h