ERC CISST - cisst software

---

mtsCommandWriteReturn Class Reference
[Multi Task Support]

#include <mtsCommandWriteReturn.h>

Inheritance diagram for mtsCommandWriteReturn:

[legend]Collaboration diagram for mtsCommandWriteReturn:

[legend]List of all members.

---

Detailed Description

A templated version of command object with zero arguments for execute. The template argument is the class type whose method is contained in the command object. This command is based on a void method, i.e. it requires the class and method name as well as an instantiation of the class to get and actual pointer on the method.

Definition at line 45 of file mtsCommandWriteReturn.h.

Public Types

• typedef mtsCommandBase BaseType
• typedef mtsCommandWriteReturn ThisType

Public Member Functions

• mtsCommandWriteReturn (void)
• mtsCommandWriteReturn (mtsCallableWriteReturnBase *callable, const std::string &name, const mtsGenericObject *argumentPrototype, const mtsGenericObject *resultPrototype)
• virtual ~mtsCommandWriteReturn ()
• virtual mtsExecutionResult Execute (const mtsGenericObject &argument, mtsGenericObject &result)
• mtsCallableWriteReturnBase * GetCallable (void) const
• size_t NumberOfArguments (void) const
• bool Returns (void) const
• const mtsGenericObject * GetArgumentPrototype (void) const
• const mtsGenericObject * GetResultPrototype (void) const
• void ToStream (std::ostream &outputStream) const

Protected Member Functions

• void SetResultPrototype (const mtsGenericObject *resultPrototype)

Protected Attributes

• mtsCallableWriteReturnBase * Callable
• const mtsGenericObject * ArgumentPrototype
• const mtsGenericObject * ResultPrototype

---

Member Typedef Documentation

typedef mtsCommandBase mtsCommandWriteReturn::BaseType

Base type

Reimplemented in mtsCommandQueuedWriteReturn.

Definition at line 49 of file mtsCommandWriteReturn.h.

typedef mtsCommandWriteReturn mtsCommandWriteReturn::ThisType

This type.

Reimplemented in mtsCommandQueuedWriteReturn.

Definition at line 52 of file mtsCommandWriteReturn.h.

---

Constructor & Destructor Documentation

mtsCommandWriteReturn::mtsCommandWriteReturn

(

void

)

The constructor. Does nothing.

mtsCommandWriteReturn::mtsCommandWriteReturn	(	mtsCallableWriteReturnBase *	callable,
		const std::string &	name,
		const mtsGenericObject *	argumentPrototype,
		const mtsGenericObject *	resultPrototype
	)

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
	name	A string to identify the command.

virtual mtsCommandWriteReturn::~mtsCommandWriteReturn

(

)

[virtual]

The destructor. Does nothing

---

Member Function Documentation

virtual mtsExecutionResult mtsCommandWriteReturn::Execute	(	const mtsGenericObject &	argument,
		mtsGenericObject &	result
	)			[virtual]

The execute method. Calling the execute method from the invoker applies the operation on the receiver.

Referenced by mtsFunctionWriteReturn::ConditionalWrap< __argumentType, __resultType, a, b >::Call(), mtsFunctionWriteReturn::ConditionalWrap< __argumentType, __resultType, false, true >::Call(), mtsFunctionWriteReturn::ConditionalWrap< __argumentType, __resultType, true, false >::Call(), and mtsFunctionWriteReturn::ConditionalWrap< __argumentType, __resultType, true, true >::Call().

mtsCallableWriteReturnBase* mtsCommandWriteReturn::GetCallable

(

void

)

const

Get a direct pointer to the callable object. This method is used for queued commands. The caller should still use the Execute method which will queue the command. When the command is de-queued, one needs access to the callable object to call the final method or function.

size_t mtsCommandWriteReturn::NumberOfArguments

(

void

)

const [virtual]

Returns number of arguments (parameters) expected by Execute method. Must be overloaded in derived classes.

Implements mtsCommandBase.

const mtsGenericObject* mtsCommandWriteReturn::GetArgumentPrototype

(

void

)

const

Return a pointer on the argument prototype

const mtsGenericObject* mtsCommandWriteReturn::GetResultPrototype

(

void

)

const

Return a pointer on the result prototype

void mtsCommandWriteReturn::ToStream

(

std::ostream &

outputStream

)

const [virtual]

For debugging. Generate a human readable output for the command object

Implements mtsCommandBase.

Reimplemented in mtsCommandQueuedWriteReturn.

---

Member Data Documentation

mtsCallableWriteReturnBase* mtsCommandWriteReturn::Callable [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 61 of file mtsCommandWriteReturn.h.

---

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

• mtsCommandWriteReturn.h

---