ERC CISST - cisst software

---

mtsCommandQueuedWrite< _argumentType > Class Template Reference
[Multi Task Support]

#include <mtsCommandQueuedWrite.h>

Inheritance diagram for mtsCommandQueuedWrite< _argumentType >:

[legend]Collaboration diagram for mtsCommandQueuedWrite< _argumentType >:

[legend]List of all members.

---

Detailed Description

template<class _argumentType>
class mtsCommandQueuedWrite< _argumentType >

Write queued command using templated _argumentType parameter. Currently, this is only used for adding event handlers, and could perhaps be replaced by mtsCommandQueuedWriteGeneric.

Definition at line 43 of file mtsCommandQueuedWrite.h.

Public Types

• typedef mtsCommandQueuedWriteBase BaseType
• typedef _argumentType ArgumentType
• typedef mtsGenericTypes< ArgumentType
  >::FinalType ArgumentQueueType
• typedef mtsGenericTypesUnwrap<
  ArgumentQueueType >::BaseType ArgumentQueueBaseType
• typedef mtsCommandQueuedWrite<
  ArgumentType > ThisType

Public Member Functions

• mtsCommandQueuedWrite (void)
• mtsCommandQueuedWrite (mtsCommandWriteBase *actualCommand)
• mtsCommandQueuedWrite (mtsMailBox *mailBox, mtsCommandWriteBase *actualCommand, size_t size)
• virtual ~mtsCommandQueuedWrite ()
• virtual mtsCommandQueuedWriteBase * Clone (mtsMailBox *mailBox, size_t size) const
• virtual void Allocate (size_t size)
• virtual mtsExecutionResult Execute (const mtsGenericObject &argument, mtsBlockingType blocking)
• const mtsGenericObject * GetArgumentPrototype (void) const
• virtual const mtsGenericObject * ArgumentPeek (void) const
• virtual mtsGenericObject * ArgumentGet (void)

Protected Attributes

• mtsQueue< ArgumentQueueType > ArgumentsQueue

---

Member Typedef Documentation

template<class _argumentType>

typedef mtsCommandQueuedWrite<ArgumentType> mtsCommandQueuedWrite< _argumentType >::ThisType

This type.

Definition at line 52 of file mtsCommandQueuedWrite.h.

---

Member Function Documentation

template<class _argumentType>

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

Definition at line 120 of file mtsCommandQueuedWrite.h.

References mtsCommandQueuedWrite< _argumentType >::ArgumentsQueue, mtsCommandQueuedWriteBase::BlockingFlagQueue, CMN_LOG_RUN_ERROR, mtsQueue< _elementType >::Get(), mtsCommandQueuedWriteBase::MailBox, mtsCommandBase::Name, mtsQueue< _elementType >::Put(), mtsMailBox::ThreadSignalWait(), and mtsMailBox::Write().

template<class _argumentType>

const mtsGenericObject* mtsCommandQueuedWrite< _argumentType >::GetArgumentPrototype

(

void

)

const [inline, virtual]

Return a pointer on the argument prototype

Reimplemented from mtsCommandWriteBase.

Definition at line 156 of file mtsCommandQueuedWrite.h.

References mtsCommandQueuedWriteBase::ActualCommand, and mtsCommandWriteBase::GetArgumentPrototype().

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

---

Member Data Documentation

template<class _argumentType>

mtsQueue<ArgumentQueueType> mtsCommandQueuedWrite< _argumentType >::ArgumentsQueue [protected]

Queue to store arguments

Definition at line 56 of file mtsCommandQueuedWrite.h.

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

---

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

• mtsCommandQueuedWrite.h

---