mtsCallableReadMethodGeneric< _classType > Class Template Reference

#include <mtsCallableReadMethod.h>

Inheritance diagram for mtsCallableReadMethodGeneric< _classType >:

Public Types
typedef mtsCallableReadBase	BaseType
typedef _classType	ClassType
typedef mtsCallableReadMethodGeneric< ClassType >	ThisType
typedef bool(_classType::*)	ActionType(mtsGenericObject &result) const

Public Member Functions
	mtsCallableReadMethodGeneric (void)
	mtsCallableReadMethodGeneric (ActionType action, ClassType *classInstantiation)
virtual	~mtsCallableReadMethodGeneric ()
mtsExecutionResult	Execute (mtsGenericObject &result)
void	ToStream (std::ostream &outputStream) const
Public Member Functions inherited from mtsCallableReadBase
	mtsCallableReadBase (void)
virtual	~mtsCallableReadBase ()

Protected Attributes
ActionType	Action
ClassType *	ClassInstantiation

Member Typedef Documentation

ActionType

template<class _classType>

typedef bool(_classType::*) mtsCallableReadMethodGeneric< _classType >::ActionType(mtsGenericObject &result) const

Typedef for pointer to member function (method) of a specific class (_classType).

BaseType

template<class _classType>

typedef mtsCallableReadBase mtsCallableReadMethodGeneric< _classType >::BaseType

ClassType

template<class _classType>

typedef _classType mtsCallableReadMethodGeneric< _classType >::ClassType

Typedef for the specific interface.

ThisType

template<class _classType>

typedef mtsCallableReadMethodGeneric<ClassType> mtsCallableReadMethodGeneric< _classType >::ThisType

This type.

Constructor & Destructor Documentation

mtsCallableReadMethodGeneric() [1/2]

template<class _classType>

mtsCallableReadMethodGeneric< _classType >::mtsCallableReadMethodGeneric ( void )

inline

The constructor. Does nothing.

mtsCallableReadMethodGeneric() [2/2]

template<class _classType>

mtsCallableReadMethodGeneric< _classType >::mtsCallableReadMethodGeneric ( ActionType action, ClassType * classInstantiation )

inline

The constructor.

Parameters

action	Pointer to the member function that is to be called by the invoker of the command
classInstantiation	Pointer to the receiver of the command

~mtsCallableReadMethodGeneric()

template<class _classType>

virtual mtsCallableReadMethodGeneric< _classType >::~mtsCallableReadMethodGeneric ( )

inlinevirtual

The destructor. Does nothing

Member Function Documentation

Execute()

template<class _classType>

mtsExecutionResult mtsCallableReadMethodGeneric< _classType >::Execute ( mtsGenericObject & result )

inlinevirtual

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

Implements mtsCallableReadBase.

ToStream()

template<class _classType>

void mtsCallableReadMethodGeneric< _classType >::ToStream ( std::ostream & outputStream ) const

inlinevirtual

Human readable description

Implements mtsCallableReadBase.

Member Data Documentation

Action

template<class _classType>

ActionType mtsCallableReadMethodGeneric< _classType >::Action

protected

The pointer to member function of the receiver class that is to be invoked for a particular instance of the command.

ClassInstantiation

template<class _classType>

ClassType* mtsCallableReadMethodGeneric< _classType >::ClassInstantiation

protected

Stores the receiver object of the command.

---

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

• tmp/cisst-saw/cisst/cisstMultiTask/mtsCallableReadMethod.h