ERC CISST - cisst software

---

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

Inheritance diagram for mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >:

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

[legend]List of all members.

---

Detailed Description

template<class _classType, class _argumentType, class _resultType>
class mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >

Definition at line 42 of file mtsCallableWriteReturnMethod.h.

Public Types

• typedef mtsCallableWriteReturnBase BaseType
• typedef _argumentType ArgumentType
• typedef _resultType ResultType
• typedef _classType ClassType
• typedef mtsCallableWriteReturnMethod<
  ClassType, ArgumentType,
  ResultType > ThisType
• typedef void(_classType::*) ActionType (const ArgumentType &argument, ResultType &result)

Public Member Functions

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

Protected Attributes

• ActionType Action
• ClassType * ClassInstantiation

Classes

• class ConditionalCast
• class ConditionalCast< false, true, dummy >
• class ConditionalCast< true, false, dummy >
• class ConditionalCast< true, true, dummy >

---

Member Typedef Documentation

template<class _classType, class _argumentType, class _resultType>

typedef _classType mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::ClassType

Typedef for the specific interface.

Definition at line 50 of file mtsCallableWriteReturnMethod.h.

template<class _classType, class _argumentType, class _resultType>

typedef mtsCallableWriteReturnMethod<ClassType, ArgumentType, ResultType> mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::ThisType

This type.

Definition at line 53 of file mtsCallableWriteReturnMethod.h.

template<class _classType, class _argumentType, class _resultType>

typedef void(_classType::*) mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::ActionType(const ArgumentType &argument, ResultType &result)

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

Definition at line 57 of file mtsCallableWriteReturnMethod.h.

---

Constructor & Destructor Documentation

template<class _classType, class _argumentType, class _resultType>

mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::mtsCallableWriteReturnMethod

(

void

)

[inline]

The constructor. Does nothing.

Definition at line 200 of file mtsCallableWriteReturnMethod.h.

template<class _classType, class _argumentType, class _resultType>

mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::mtsCallableWriteReturnMethod	(	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 207 of file mtsCallableWriteReturnMethod.h.

template<class _classType, class _argumentType, class _resultType>

virtual mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::~mtsCallableWriteReturnMethod

(

)

[inline, virtual]

The destructor. Does nothing

Definition at line 214 of file mtsCallableWriteReturnMethod.h.

---

Member Function Documentation

template<class _classType, class _argumentType, class _resultType>

mtsExecutionResult mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::Execute	(	const mtsGenericObject &	argument,
		mtsGenericObject &	result
	)			[inline, virtual]

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

Implements mtsCallableWriteReturnBase.

Definition at line 217 of file mtsCallableWriteReturnMethod.h.

References mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::Action, and mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::ClassInstantiation.

template<class _classType, class _argumentType, class _resultType>

void mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

Human readable description

Implements mtsCallableWriteReturnBase.

Definition at line 224 of file mtsCallableWriteReturnMethod.h.

References mtsObjectName().

---

Member Data Documentation

template<class _classType, class _argumentType, class _resultType>

ActionType mtsCallableWriteReturnMethod< _classType, _argumentType, _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 66 of file mtsCallableWriteReturnMethod.h.

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

template<class _classType, class _argumentType, class _resultType>

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

Stores the receiver object of the command.

Definition at line 69 of file mtsCallableWriteReturnMethod.h.

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

---

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

• mtsCallableWriteReturnMethod.h

---