ERC CISST - cisst software

---

mtsCommandQueuedWriteBase Class Reference

Inheritance diagram for mtsCommandQueuedWriteBase:

[legend]Collaboration diagram for mtsCommandQueuedWriteBase:

[legend]List of all members.

---

Detailed Description

Definition at line 36 of file mtsCommandQueuedWriteBase.h.

Public Member Functions

• mtsCommandQueuedWriteBase (mtsMailBox *mailBox, mtsCommandWriteBase *actualCommand, size_t size)
• virtual ~mtsCommandQueuedWriteBase ()
• virtual mtsCommandWriteBase * GetActualCommand (void)
• virtual void ToStream (std::ostream &outputStream) const
• virtual mtsCommandQueuedWriteBase * Clone (mtsMailBox *mailBox, size_t size) const=0
• virtual void Allocate (size_t size)=0
• virtual mtsExecutionResult Execute (const mtsGenericObject &argument, mtsBlockingType blocking)=0
• virtual const mtsGenericObject * ArgumentPeek (void) const=0
• virtual mtsGenericObject * ArgumentGet (void)=0
• mtsBlockingType BlockingFlagGet (void)
• virtual const std::string GetMailBoxName (void) const

Protected Types

• typedef mtsCommandWriteBase BaseType

Protected Attributes

• mtsMailBox * MailBox
• mtsCommandWriteBase * ActualCommand
• mtsQueue< mtsBlockingType > BlockingFlagQueue

---

Member Function Documentation

virtual void mtsCommandQueuedWriteBase::ToStream

(

std::ostream &

outputStream

)

const [virtual]

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

Implements mtsCommandBase.

Reimplemented in mtsCommandQueuedWriteGeneric.

virtual mtsExecutionResult mtsCommandQueuedWriteBase::Execute	(	const mtsGenericObject &	argument,
		mtsBlockingType	blocking
	)			[pure virtual]

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

Parameters:

obj

The data passed to the operation method

Returns:

Boolean value, true if success, false otherwise

Implements mtsCommandWriteBase.

---

Member Data Documentation

mtsQueue<mtsBlockingType> mtsCommandQueuedWriteBase::BlockingFlagQueue [protected]

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

Definition at line 44 of file mtsCommandQueuedWriteBase.h.

Referenced by mtsCommandQueuedWrite< _argumentType >::Allocate(), mtsCommandQueuedWrite< _argumentType >::Execute(), and mtsCommandQueuedWrite< _argumentType >::mtsCommandQueuedWrite().

---

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

• mtsCommandQueuedWriteBase.h

---