mtsCommandQueuedWriteGeneric Class Reference

#include <mtsCommandQueuedWrite.h>

Inheritance diagram for mtsCommandQueuedWriteGeneric:

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)
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)
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 Types
typedef mtsCommandQueuedWriteBase	BaseType
typedef mtsCommandQueuedWriteGeneric	ThisType
Protected Types inherited from mtsCommandQueuedWriteBase
typedef mtsCommandWriteBase	BaseType

Protected Attributes
size_t	ArgumentQueueSize
mtsQueueGeneric	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
Public Types inherited from mtsCommandWriteBase
typedef mtsCommandBase	BaseType
Protected Member Functions inherited from mtsCommandQueuedWriteBase
	mtsCommandQueuedWriteBase (void)

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).

Member Typedef Documentation

BaseType

typedef mtsCommandQueuedWriteBase mtsCommandQueuedWriteGeneric::BaseType

protected

ThisType

typedef mtsCommandQueuedWriteGeneric mtsCommandQueuedWriteGeneric::ThisType

protected

Constructor & Destructor Documentation

mtsCommandQueuedWriteGeneric()

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.

~mtsCommandQueuedWriteGeneric()

virtual mtsCommandQueuedWriteGeneric::~mtsCommandQueuedWriteGeneric ( )

inlinevirtual

Destructor

Member Function Documentation

Allocate()

virtual void mtsCommandQueuedWriteGeneric::Allocate ( size_t size )

virtual

Implements mtsCommandQueuedWriteBase.

ArgumentGet()

virtual mtsGenericObject * mtsCommandQueuedWriteGeneric::ArgumentGet ( void )

inlinevirtual

Implements mtsCommandQueuedWriteBase.

ArgumentPeek()

virtual const mtsGenericObject * mtsCommandQueuedWriteGeneric::ArgumentPeek ( void ) const

inlinevirtual

Implements mtsCommandQueuedWriteBase.

Clone()

virtual mtsCommandQueuedWriteGeneric * mtsCommandQueuedWriteGeneric::Clone ( mtsMailBox * mailBox, size_t size ) const

inlinevirtual

Implements mtsCommandQueuedWriteBase.

Reimplemented in mtsCommandFilteredQueuedWrite.

Execute()

mtsExecutionResult mtsCommandQueuedWriteGeneric::Execute ( const mtsGenericObject & argument, mtsBlockingType blocking, mtsCommandWriteBase * finishedEventHandler )

virtual

Implements mtsCommandQueuedWriteBase.

GetArgumentPrototype()

const mtsGenericObject * mtsCommandQueuedWriteGeneric::GetArgumentPrototype ( void ) const

inlinevirtual

Return a pointer on the argument prototype

Reimplemented from mtsCommandWriteBase.

SetArgumentPrototype()

virtual void mtsCommandQueuedWriteGeneric::SetArgumentPrototype ( const mtsGenericObject * argumentPrototype )

inlinevirtual

Reimplemented from mtsCommandWriteBase.

ToStream()

virtual void mtsCommandQueuedWriteGeneric::ToStream ( std::ostream & outputStream ) const

virtual

Reimplemented from mtsCommandQueuedWriteBase.

Member Data Documentation

ArgumentQueueSize

size_t mtsCommandQueuedWriteGeneric::ArgumentQueueSize

protected

ArgumentsQueue

mtsQueueGeneric mtsCommandQueuedWriteGeneric::ArgumentsQueue

protected

Queue to store arguments

---

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

• tmp/cisst-saw/cisst/cisstMultiTask/mtsCommandQueuedWrite.h