ERC CISST - cisst software

---

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

Inheritance diagram for mtsCallableReadReturnVoidMethod< _classType, _returnType >:

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

[legend]List of all members.

---

Detailed Description

template<class _classType, class _returnType>
class mtsCallableReadReturnVoidMethod< _classType, _returnType >

Definition at line 42 of file mtsCallableReadReturnVoidMethod.h.

Public Types

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

Public Member Functions

• mtsCallableReadReturnVoidMethod (void)
• mtsCallableReadReturnVoidMethod (ActionType action, ClassType *classInstantiation)
• virtual ~mtsCallableReadReturnVoidMethod ()
• 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 mtsCallableReadReturnVoidMethod< _classType, _returnType >::ClassType

Typedef for the specific interface.

Definition at line 49 of file mtsCallableReadReturnVoidMethod.h.

template<class _classType, class _returnType>

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

This type.

Definition at line 52 of file mtsCallableReadReturnVoidMethod.h.

template<class _classType, class _returnType>

typedef void(_classType::*) mtsCallableReadReturnVoidMethod< _classType, _returnType >::ActionType(ReturnType &argument) const

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

Definition at line 56 of file mtsCallableReadReturnVoidMethod.h.

---

Constructor & Destructor Documentation

template<class _classType, class _returnType>

mtsCallableReadReturnVoidMethod< _classType, _returnType >::mtsCallableReadReturnVoidMethod

(

void

)

[inline]

The constructor. Does nothing.

Definition at line 115 of file mtsCallableReadReturnVoidMethod.h.

template<class _classType, class _returnType>

mtsCallableReadReturnVoidMethod< _classType, _returnType >::mtsCallableReadReturnVoidMethod	(	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 122 of file mtsCallableReadReturnVoidMethod.h.

template<class _classType, class _returnType>

virtual mtsCallableReadReturnVoidMethod< _classType, _returnType >::~mtsCallableReadReturnVoidMethod

(

)

[inline, virtual]

The destructor. Does nothing

Definition at line 129 of file mtsCallableReadReturnVoidMethod.h.

---

Member Function Documentation

template<class _classType, class _returnType>

mtsExecutionResult mtsCallableReadReturnVoidMethod< _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 132 of file mtsCallableReadReturnVoidMethod.h.

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

template<class _classType, class _returnType>

void mtsCallableReadReturnVoidMethod< _classType, _returnType >::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

Human readable description

Implements mtsCallableReadBase.

Definition at line 138 of file mtsCallableReadReturnVoidMethod.h.

References mtsObjectName().

---

Member Data Documentation

template<class _classType, class _returnType>

ActionType mtsCallableReadReturnVoidMethod< _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 mtsCallableReadReturnVoidMethod.h.

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

template<class _classType, class _returnType>

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

Stores the receiver object of the command.

Definition at line 68 of file mtsCallableReadReturnVoidMethod.h.

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

---

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

• mtsCallableReadReturnVoidMethod.h

---