ERC CISST - cisst software

---

mtsCommandQueuedVoid Class Reference

Inheritance diagram for mtsCommandQueuedVoid:

[legend]Collaboration diagram for mtsCommandQueuedVoid:

[legend]List of all members.

---

Detailed Description

Definition at line 36 of file mtsCommandQueuedVoid.h.

Public Types

• typedef mtsCommandVoid BaseType
• typedef mtsCommandQueuedVoid ThisType

Public Member Functions

• mtsCommandQueuedVoid (mtsCallableVoidBase *callable, const std::string &name, mtsMailBox *mailBox, size_t size)
• virtual ~mtsCommandQueuedVoid ()
• virtual mtsCommandQueuedVoid * Clone (mtsMailBox *mailBox, size_t size) const
• virtual void Allocate (unsigned int CMN_UNUSED(size))
• mtsExecutionResult Execute (mtsBlockingType blocking)
• mtsBlockingType BlockingFlagGet (void)
• std::string GetMailBoxName (void) const
• void ToStream (std::ostream &outputStream) const

Protected Attributes

• mtsMailBox * MailBox
• mtsQueue< mtsBlockingType > BlockingFlagQueue

---

Member Typedef Documentation

typedef mtsCommandVoid mtsCommandQueuedVoid::BaseType

Base type

Reimplemented from mtsCommandVoid.

Definition at line 40 of file mtsCommandQueuedVoid.h.

typedef mtsCommandQueuedVoid mtsCommandQueuedVoid::ThisType

This type.

Reimplemented from mtsCommandVoid.

Definition at line 43 of file mtsCommandQueuedVoid.h.

---

Member Function Documentation

mtsExecutionResult mtsCommandQueuedVoid::Execute

(

mtsBlockingType

blocking

)

For a queued command, Execute means queueing the command. This method will return mtsExecutionResult::DEV_OK if the command has been queued, it doesn't mean that the actual has been executed yet. If the command has been disabled (see mtsCommandBase::Disable()), Execute will return mtsExecutionResult::DISABLED. finally, if the mailbox is full, Execute() will return mtsExecutionResult::MAILBOX_FULL. This can happen if the task receiving the command doesn't process/empty its mailboxes fast enough.

void mtsCommandQueuedVoid::ToStream

(

std::ostream &

outputStream

)

const [virtual]

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

Reimplemented from mtsCommandVoid.

---

Member Data Documentation

mtsMailBox* mtsCommandQueuedVoid::MailBox [protected]

Mailbox used to queue the commands

Definition at line 47 of file mtsCommandQueuedVoid.h.

mtsQueue<mtsBlockingType> mtsCommandQueuedVoid::BlockingFlagQueue [protected]

Queue of flags to indicate if the command is blocking or not

Definition at line 50 of file mtsCommandQueuedVoid.h.

---

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

• mtsCommandQueuedVoid.h

---