ERC CISST - cisst software

---

mtsCommandQueuedWriteReturn Class Reference
[Multi Task Support]

#include <mtsCommandQueuedWriteReturn.h>

Inheritance diagram for mtsCommandQueuedWriteReturn:

[legend]Collaboration diagram for mtsCommandQueuedWriteReturn:

[legend]List of all members.

---

Detailed Description

WriteReturn queued command using templated _returnType parameter

Definition at line 41 of file mtsCommandQueuedWriteReturn.h.

Public Types

• typedef mtsCommandWriteReturn BaseType
• typedef mtsCommandQueuedWriteReturn ThisType

Public Member Functions

• mtsCommandQueuedWriteReturn (mtsCallableWriteReturnBase *callable, const std::string &name, const mtsGenericObject *argumentPrototype, const mtsGenericObject *resultPrototype, mtsMailBox *mailBox)
• mtsCommandQueuedWriteReturn * Clone (mtsMailBox *mailBox) const
• mtsExecutionResult Execute (const mtsGenericObject &argument, mtsGenericObject &result)
• const mtsGenericObject * GetArgumentPointer (void)
• mtsGenericObject * GetResultPointer (void)
• std::string GetMailBoxName (void) const
• void ToStream (std::ostream &outputStream) const

Protected Attributes

• mtsMailBox * MailBox
• const mtsGenericObject * ArgumentPointer
• mtsGenericObject * ResultPointer

---

Member Typedef Documentation

typedef mtsCommandWriteReturn mtsCommandQueuedWriteReturn::BaseType

Base type

Reimplemented from mtsCommandWriteReturn.

Definition at line 44 of file mtsCommandQueuedWriteReturn.h.

typedef mtsCommandQueuedWriteReturn mtsCommandQueuedWriteReturn::ThisType

This type.

Reimplemented from mtsCommandWriteReturn.

Definition at line 47 of file mtsCommandQueuedWriteReturn.h.

---

Member Function Documentation

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

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

Reimplemented from mtsCommandWriteReturn.

void mtsCommandQueuedWriteReturn::ToStream

(

std::ostream &

outputStream

)

const [virtual]

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

Reimplemented from mtsCommandWriteReturn.

---

Member Data Documentation

mtsMailBox* mtsCommandQueuedWriteReturn::MailBox [protected]

Mailbox used to queue the commands

Definition at line 51 of file mtsCommandQueuedWriteReturn.h.

const mtsGenericObject* mtsCommandQueuedWriteReturn::ArgumentPointer [protected]

Pointer on caller provided placeholder for result

Definition at line 82 of file mtsCommandQueuedWriteReturn.h.

---

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

• mtsCommandQueuedWriteReturn.h

---