ERC CISST - cisst software

---

mtsCallableVoidReturnMethod< _classType, _resultType > Class Template Reference
[Multi Task Support]

Inheritance diagram for mtsCallableVoidReturnMethod< _classType, _resultType >:

[legend]Collaboration diagram for mtsCallableVoidReturnMethod< _classType, _resultType >:

[legend]List of all members.

---

Detailed Description

template<class _classType, class _resultType>
class mtsCallableVoidReturnMethod< _classType, _resultType >

Definition at line 42 of file mtsCallableVoidReturnMethod.h.

Public Types

• typedef mtsCallableVoidReturnBase BaseType
• typedef _resultType ResultType
• typedef _classType ClassType
• typedef mtsCallableVoidReturnMethod<
  ClassType, ResultType > ThisType
• typedef void(_classType::*) ActionType (ResultType &result)

Public Member Functions

• mtsCallableVoidReturnMethod (void)
• mtsCallableVoidReturnMethod (ActionType action, ClassType *classInstantiation)
• virtual ~mtsCallableVoidReturnMethod ()
• mtsExecutionResult Execute (mtsGenericObject &result)
• 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 _resultType>

typedef _classType mtsCallableVoidReturnMethod< _classType, _resultType >::ClassType

Typedef for the specific interface.

Definition at line 49 of file mtsCallableVoidReturnMethod.h.

template<class _classType, class _resultType>

typedef mtsCallableVoidReturnMethod<ClassType, ResultType> mtsCallableVoidReturnMethod< _classType, _resultType >::ThisType

This type.

Definition at line 52 of file mtsCallableVoidReturnMethod.h.

template<class _classType, class _resultType>

typedef void(_classType::*) mtsCallableVoidReturnMethod< _classType, _resultType >::ActionType(ResultType &result)

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

Definition at line 56 of file mtsCallableVoidReturnMethod.h.

---

Constructor & Destructor Documentation

template<class _classType, class _resultType>

mtsCallableVoidReturnMethod< _classType, _resultType >::mtsCallableVoidReturnMethod

(

void

)

[inline]

The constructor. Does nothing.

Definition at line 115 of file mtsCallableVoidReturnMethod.h.

template<class _classType, class _resultType>

mtsCallableVoidReturnMethod< _classType, _resultType >::mtsCallableVoidReturnMethod	(	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 mtsCallableVoidReturnMethod.h.

template<class _classType, class _resultType>

virtual mtsCallableVoidReturnMethod< _classType, _resultType >::~mtsCallableVoidReturnMethod

(

)

[inline, virtual]

The destructor. Does nothing

Definition at line 129 of file mtsCallableVoidReturnMethod.h.

---

Member Function Documentation

template<class _classType, class _resultType>

mtsExecutionResult mtsCallableVoidReturnMethod< _classType, _resultType >::Execute

(

mtsGenericObject &

result

)

[inline, virtual]

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

Implements mtsCallableVoidReturnBase.

Definition at line 132 of file mtsCallableVoidReturnMethod.h.

References mtsCallableVoidReturnMethod< _classType, _resultType >::Action, and mtsCallableVoidReturnMethod< _classType, _resultType >::ClassInstantiation.

template<class _classType, class _resultType>

void mtsCallableVoidReturnMethod< _classType, _resultType >::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

Human readable description

Implements mtsCallableVoidReturnBase.

Definition at line 138 of file mtsCallableVoidReturnMethod.h.

References mtsObjectName().

---

Member Data Documentation

template<class _classType, class _resultType>

ActionType mtsCallableVoidReturnMethod< _classType, _resultType >::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 mtsCallableVoidReturnMethod.h.

Referenced by mtsCallableVoidReturnMethod< _classType, _resultType >::Execute().

template<class _classType, class _resultType>

ClassType* mtsCallableVoidReturnMethod< _classType, _resultType >::ClassInstantiation [protected]

Stores the receiver object of the command.

Definition at line 68 of file mtsCallableVoidReturnMethod.h.

Referenced by mtsCallableVoidReturnMethod< _classType, _resultType >::Execute().

---

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

• mtsCallableVoidReturnMethod.h

---