ERC CISST - cisst software

---

mtsCommandQueuedVoidReturn Class Reference
[Multi Task Support]

#include <mtsCommandQueuedVoidReturn.h>

Inheritance diagram for mtsCommandQueuedVoidReturn:

[legend]Collaboration diagram for mtsCommandQueuedVoidReturn:

[legend]List of all members.

---

Detailed Description

VoidReturn queued command using templated _returnType parameter

Definition at line 41 of file mtsCommandQueuedVoidReturn.h.

Public Types

• typedef mtsCommandVoidReturn BaseType
• typedef mtsCommandQueuedVoidReturn ThisType

Public Member Functions

• mtsCommandQueuedVoidReturn (mtsCallableVoidReturnBase *callable, const std::string &name, const mtsGenericObject *resultPrototype, mtsMailBox *mailBox)
• mtsCommandQueuedVoidReturn * Clone (mtsMailBox *mailBox) const
• mtsExecutionResult Execute (mtsGenericObject &result)
• mtsGenericObject * GetResultPointer (void)
• std::string GetMailBoxName (void) const
• void ToStream (std::ostream &outputStream) const

Protected Attributes

• mtsMailBox * MailBox
• mtsGenericObject * ResultPointer

---

Member Typedef Documentation

typedef mtsCommandVoidReturn mtsCommandQueuedVoidReturn::BaseType

Base type

Reimplemented from mtsCommandVoidReturn.

Definition at line 44 of file mtsCommandQueuedVoidReturn.h.

typedef mtsCommandQueuedVoidReturn mtsCommandQueuedVoidReturn::ThisType

This type.

Reimplemented from mtsCommandVoidReturn.

Definition at line 47 of file mtsCommandQueuedVoidReturn.h.

---

Member Function Documentation

mtsExecutionResult mtsCommandQueuedVoidReturn::Execute

(

mtsGenericObject &

result

)

[virtual]

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

Reimplemented from mtsCommandVoidReturn.

void mtsCommandQueuedVoidReturn::ToStream

(

std::ostream &

outputStream

)

const [virtual]

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

Reimplemented from mtsCommandVoidReturn.

---

Member Data Documentation

mtsMailBox* mtsCommandQueuedVoidReturn::MailBox [protected]

Mailbox used to queue the commands

Definition at line 51 of file mtsCommandQueuedVoidReturn.h.

mtsGenericObject* mtsCommandQueuedVoidReturn::ResultPointer [protected]

Pointer on caller provided placeholder for result

Definition at line 78 of file mtsCommandQueuedVoidReturn.h.

---

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

• mtsCommandQueuedVoidReturn.h

---