ERC CISST - cisst software

---

mtsCommandQueuedWriteGeneric Class Reference

#include <mtsCommandQueuedWrite.h>

Inheritance diagram for mtsCommandQueuedWriteGeneric:

[legend]Collaboration diagram for mtsCommandQueuedWriteGeneric:

[legend]List of all members.

---

Detailed Description

Write queued command using mtsGenericObject parameter. This is used for all queued write commands. It is also used to create a generic event observer (combined with mtsMulticastCommandWriteBase) that can accept any payload (derived from mtsGenericObject).

Definition at line 176 of file mtsCommandQueuedWrite.h.

Public Member Functions

• mtsCommandQueuedWriteGeneric (mtsMailBox *mailBox, mtsCommandWriteBase *actualCommand, size_t size)
• virtual ~mtsCommandQueuedWriteGeneric ()
• virtual void ToStream (std::ostream &outputStream) const
• virtual mtsCommandQueuedWriteGeneric * Clone (mtsMailBox *mailBox, size_t size) const
• virtual void Allocate (size_t size)
• virtual void SetArgumentPrototype (const mtsGenericObject *argumentPrototype)
• virtual mtsExecutionResult Execute (const mtsGenericObject &argument, mtsBlockingType blocking)
• const mtsGenericObject * GetArgumentPrototype (void) const
• virtual const mtsGenericObject * ArgumentPeek (void) const
• virtual mtsGenericObject * ArgumentGet (void)

Protected Types

• typedef mtsCommandQueuedWriteBase BaseType
• typedef mtsCommandQueuedWriteGeneric ThisType

Protected Attributes

• size_t ArgumentQueueSize
• mtsQueueGeneric ArgumentsQueue

---

Constructor & Destructor Documentation

mtsCommandQueuedWriteGeneric::mtsCommandQueuedWriteGeneric	(	mtsMailBox *	mailBox,
		mtsCommandWriteBase *	actualCommand,
		size_t	size
	)

Constructor, requires a mailbox to queue commands, a pointer on actual command and size used to create the argument queue. If the actual command doesn't provide an argument prototype, the argument queue is not allocated. Queue allocation will potentially occur later, i.e. when SetArgumentPrototype is used. This is useful when the queued command is added to a multicast command.

virtual mtsCommandQueuedWriteGeneric::~mtsCommandQueuedWriteGeneric

(

)

[inline, virtual]

Destructor

Definition at line 205 of file mtsCommandQueuedWrite.h.

---

Member Function Documentation

virtual void mtsCommandQueuedWriteGeneric::ToStream

(

std::ostream &

outputStream

)

const [virtual]

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

Reimplemented from mtsCommandQueuedWriteBase.

virtual mtsExecutionResult mtsCommandQueuedWriteGeneric::Execute	(	const mtsGenericObject &	argument,
		mtsBlockingType	blocking
	)			[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 mtsCommandQueuedWriteBase.

const mtsGenericObject* mtsCommandQueuedWriteGeneric::GetArgumentPrototype

(

void

)

const [inline, virtual]

Return a pointer on the argument prototype

Reimplemented from mtsCommandWriteBase.

Definition at line 230 of file mtsCommandQueuedWrite.h.

---

Member Data Documentation

mtsQueueGeneric mtsCommandQueuedWriteGeneric::ArgumentsQueue [protected]

Queue to store arguments

Definition at line 184 of file mtsCommandQueuedWrite.h.

---

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

• mtsCommandQueuedWrite.h

---