ERC CISST - cisst software

---

mtsCallableReadMethod< _classType, _returnType > Class Template Reference
[Multi Task Support]

Inheritance diagram for mtsCallableReadMethod< _classType, _returnType >:

[legend]Collaboration diagram for mtsCallableReadMethod< _classType, _returnType >:

[legend]List of all members.

---

Detailed Description

template<class _classType, class _returnType>
class mtsCallableReadMethod< _classType, _returnType >

Definition at line 42 of file mtsCallableReadMethod.h.

Public Types

• typedef mtsCallableReadBase BaseType
• typedef _returnType ReturnType
• typedef _classType ClassType
• typedef mtsCallableReadMethod<
  ClassType, ReturnType > ThisType
• typedef bool(_classType::*) ActionType (ReturnType &argument) const

Public Member Functions

• mtsCallableReadMethod (void)
• mtsCallableReadMethod (ActionType action, ClassType *classInstantiation)
• virtual ~mtsCallableReadMethod ()
• mtsExecutionResult Execute (mtsGenericObject &argument)
• void ToStream (std::ostream &outputStream) const

Protected Attributes

• ActionType Action
• ClassType * ClassInstantiation

Classes

• class ConditionalCast
• class ConditionalCast< true, _dummy >

---

Member Typedef Documentation

template<class _classType, class _returnType>

typedef _classType mtsCallableReadMethod< _classType, _returnType >::ClassType

Typedef for the specific interface.

Definition at line 49 of file mtsCallableReadMethod.h.

template<class _classType, class _returnType>

typedef mtsCallableReadMethod<ClassType, ReturnType> mtsCallableReadMethod< _classType, _returnType >::ThisType

This type.

Definition at line 52 of file mtsCallableReadMethod.h.

template<class _classType, class _returnType>

typedef bool(_classType::*) mtsCallableReadMethod< _classType, _returnType >::ActionType(ReturnType &argument) const

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

Definition at line 56 of file mtsCallableReadMethod.h.

---

Constructor & Destructor Documentation

template<class _classType, class _returnType>

mtsCallableReadMethod< _classType, _returnType >::mtsCallableReadMethod

(

void

)

[inline]

The constructor. Does nothing.

Definition at line 123 of file mtsCallableReadMethod.h.

template<class _classType, class _returnType>

mtsCallableReadMethod< _classType, _returnType >::mtsCallableReadMethod	(	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

Definition at line 130 of file mtsCallableReadMethod.h.

template<class _classType, class _returnType>

virtual mtsCallableReadMethod< _classType, _returnType >::~mtsCallableReadMethod

(

)

[inline, virtual]

The destructor. Does nothing

Definition at line 137 of file mtsCallableReadMethod.h.

---

Member Function Documentation

template<class _classType, class _returnType>

mtsExecutionResult mtsCallableReadMethod< _classType, _returnType >::Execute

(

mtsGenericObject &

argument

)

[inline, virtual]

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

Implements mtsCallableReadBase.

Definition at line 140 of file mtsCallableReadMethod.h.

References mtsCallableReadMethod< _classType, _returnType >::Action, and mtsCallableReadMethod< _classType, _returnType >::ClassInstantiation.

template<class _classType, class _returnType>

void mtsCallableReadMethod< _classType, _returnType >::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

Human readable description

Implements mtsCallableReadBase.

Definition at line 146 of file mtsCallableReadMethod.h.

References mtsObjectName().

---

Member Data Documentation

template<class _classType, class _returnType>

ActionType mtsCallableReadMethod< _classType, _returnType >::Action [protected]

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

Definition at line 65 of file mtsCallableReadMethod.h.

Referenced by mtsCallableReadMethod< _classType, _returnType >::Execute().

template<class _classType, class _returnType>

ClassType* mtsCallableReadMethod< _classType, _returnType >::ClassInstantiation [protected]

Stores the receiver object of the command.

Definition at line 68 of file mtsCallableReadMethod.h.

Referenced by mtsCallableReadMethod< _classType, _returnType >::Execute().

---

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

• mtsCallableReadMethod.h

---