cisst-saw
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
mtsCommandQueuedWrite< _argumentType > Class Template Reference
cisstMultiTask

#include <mtsCommandQueuedWrite.h>

Inheritance diagram for mtsCommandQueuedWrite< _argumentType >:
mtsCommandQueuedWriteBase mtsCommandWriteBase mtsCommandBase

Public Types

typedef mtsCommandQueuedWriteBase BaseType
typedef _argumentType ArgumentType
typedef mtsGenericTypes< ArgumentType >::FinalType ArgumentQueueType
typedef mtsGenericTypesUnwrap< ArgumentQueueType >::BaseType ArgumentQueueBaseType
typedef mtsCommandQueuedWrite< ArgumentType > ThisType
Public Types inherited from mtsCommandWriteBase
typedef mtsCommandBase BaseType

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)
mtsExecutionResult Execute (const mtsGenericObject &argument, mtsBlockingType blocking, mtsCommandWriteBase *finishedEventHandler)
const mtsGenericObject * GetArgumentPrototype (void) const
virtual const mtsGenericObject * ArgumentPeek (void) const
virtual mtsGenericObject * ArgumentGet (void)
Public Member Functions inherited from mtsCommandQueuedWriteBase
 mtsCommandQueuedWriteBase (mtsMailBox *mailBox, mtsCommandWriteBase *actualCommand, size_t size)
virtual ~mtsCommandQueuedWriteBase ()
virtual mtsCommandWriteBase * GetActualCommand (void)
virtual void ToStream (std::ostream &outputStream) const
mtsExecutionResult Execute (const mtsGenericObject &argument, mtsBlockingType blocking)
mtsBlockingType BlockingFlagGet (void)
mtsCommandWriteBase * FinishedEventGet (void)
virtual const std::string GetMailBoxName (void) const
Public Member Functions inherited from mtsCommandWriteBase
 mtsCommandWriteBase (void)
 mtsCommandWriteBase (const std::string &name)
virtual ~mtsCommandWriteBase ()
virtual mtsExecutionResult Execute (const mtsGenericObject &argument, mtsBlockingType blocking, mtsCommandWriteBase *CMN_UNUSED(finishedEventHandler))=0
size_t NumberOfArguments (void) const
bool Returns (void) const
const cmnClassServicesBase * GetArgumentClassServices (void) const
Public Member Functions inherited from mtsCommandBase
 mtsCommandBase (void)
 mtsCommandBase (const std::string &name)
virtual ~mtsCommandBase ()
virtual std::string ToString (void) const
void Enable (void)
void Disable (void)
bool IsEnabled (void) const
bool IsDisabled (void) const
const std::string & GetName (void) const

Protected Attributes

mtsQueue< ArgumentQueueType > ArgumentsQueue
Protected Attributes inherited from mtsCommandQueuedWriteBase
mtsMailBox * MailBox
mtsCommandWriteBase * ActualCommand
mtsQueue< mtsBlockingType > BlockingFlagQueue
mtsQueue< mtsCommandWriteBase * > FinishedEventQueue
Protected Attributes inherited from mtsCommandWriteBase
const mtsGenericObject * ArgumentPrototype
Protected Attributes inherited from mtsCommandBase
std::string Name
bool EnableFlag

Additional Inherited Members

Protected Types inherited from mtsCommandQueuedWriteBase
typedef mtsCommandWriteBase BaseType
Protected Member Functions inherited from mtsCommandQueuedWriteBase
 mtsCommandQueuedWriteBase (void)
Protected Member Functions inherited from mtsCommandWriteBase
virtual void SetArgumentPrototype (const mtsGenericObject *argumentPrototype)

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.

Member Typedef Documentation

◆ ArgumentQueueBaseType

template<class _argumentType>
typedef mtsGenericTypesUnwrap<ArgumentQueueType>::BaseType mtsCommandQueuedWrite< _argumentType >::ArgumentQueueBaseType

◆ ArgumentQueueType

template<class _argumentType>
typedef mtsGenericTypes<ArgumentType>::FinalType mtsCommandQueuedWrite< _argumentType >::ArgumentQueueType

◆ ArgumentType

template<class _argumentType>
typedef _argumentType mtsCommandQueuedWrite< _argumentType >::ArgumentType

◆ BaseType

template<class _argumentType>
typedef mtsCommandQueuedWriteBase mtsCommandQueuedWrite< _argumentType >::BaseType

◆ ThisType

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

This type.

Constructor & Destructor Documentation

◆ mtsCommandQueuedWrite() [1/3]

template<class _argumentType>
mtsCommandQueuedWrite< _argumentType >::mtsCommandQueuedWrite ( void )
inline

◆ mtsCommandQueuedWrite() [2/3]

template<class _argumentType>
mtsCommandQueuedWrite< _argumentType >::mtsCommandQueuedWrite ( mtsCommandWriteBase * actualCommand)
inline

◆ mtsCommandQueuedWrite() [3/3]

template<class _argumentType>
mtsCommandQueuedWrite< _argumentType >::mtsCommandQueuedWrite ( mtsMailBox * mailBox,
mtsCommandWriteBase * actualCommand,
size_t size )
inline

◆ ~mtsCommandQueuedWrite()

template<class _argumentType>
virtual mtsCommandQueuedWrite< _argumentType >::~mtsCommandQueuedWrite ( )
inlinevirtual

Member Function Documentation

◆ Allocate()

template<class _argumentType>
virtual void mtsCommandQueuedWrite< _argumentType >::Allocate ( size_t size)
inlinevirtual

Implements mtsCommandQueuedWriteBase.

◆ ArgumentGet()

template<class _argumentType>
virtual mtsGenericObject * mtsCommandQueuedWrite< _argumentType >::ArgumentGet ( void )
inlinevirtual

Implements mtsCommandQueuedWriteBase.

◆ ArgumentPeek()

template<class _argumentType>
virtual const mtsGenericObject * mtsCommandQueuedWrite< _argumentType >::ArgumentPeek ( void ) const
inlinevirtual

Implements mtsCommandQueuedWriteBase.

◆ Clone()

template<class _argumentType>
virtual mtsCommandQueuedWriteBase * mtsCommandQueuedWrite< _argumentType >::Clone ( mtsMailBox * mailBox,
size_t size ) const
inlinevirtual

Implements mtsCommandQueuedWriteBase.

◆ Execute()

template<class _argumentType>
mtsExecutionResult mtsCommandQueuedWrite< _argumentType >::Execute ( const mtsGenericObject & argument,
mtsBlockingType blocking,
mtsCommandWriteBase * finishedEventHandler )
inlinevirtual

Implements mtsCommandQueuedWriteBase.

◆ GetArgumentPrototype()

template<class _argumentType>
const mtsGenericObject * mtsCommandQueuedWrite< _argumentType >::GetArgumentPrototype ( void ) const
inlinevirtual

Return a pointer on the argument prototype

Reimplemented from mtsCommandWriteBase.

Member Data Documentation

◆ ArgumentsQueue

template<class _argumentType>
mtsQueue<ArgumentQueueType> mtsCommandQueuedWrite< _argumentType >::ArgumentsQueue
protected

Queue to store arguments

The documentation for this class was generated from the following file:
Generated by doxygen 1.18.0