mtsCommandQueuedWriteBase Class Reference

#include <mtsCommandQueuedWriteBase.h>

Inheritance diagram for mtsCommandQueuedWriteBase:

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
mtsExecutionResult	Execute (const mtsGenericObject &argument, mtsBlockingType blocking)
mtsExecutionResult	Execute (const mtsGenericObject &argument, mtsBlockingType blocking, mtsCommandWriteBase *finishedEventHandler)=0
virtual const mtsGenericObject *	ArgumentPeek (void) const =0
virtual mtsGenericObject *	ArgumentGet (void)=0
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
virtual const mtsGenericObject *	GetArgumentPrototype (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 mtsCommandWriteBase	BaseType

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

Protected Attributes
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

Member Typedef Documentation

BaseType

typedef mtsCommandWriteBase mtsCommandQueuedWriteBase::BaseType

protected

Constructor & Destructor Documentation

mtsCommandQueuedWriteBase() [1/2]

mtsCommandQueuedWriteBase::mtsCommandQueuedWriteBase ( void )

inlineprotected

mtsCommandQueuedWriteBase() [2/2]

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

inline

~mtsCommandQueuedWriteBase()

virtual mtsCommandQueuedWriteBase::~mtsCommandQueuedWriteBase ( )

inlinevirtual

Member Function Documentation

Allocate()

virtual void mtsCommandQueuedWriteBase::Allocate ( size_t size )

pure virtual

Implemented in mtsCommandQueuedWrite< _argumentType >, mtsCommandQueuedWrite< ArgumentType >, and mtsCommandQueuedWriteGeneric.

ArgumentGet()

virtual mtsGenericObject * mtsCommandQueuedWriteBase::ArgumentGet ( void )

pure virtual

Implemented in mtsCommandQueuedWrite< _argumentType >, mtsCommandQueuedWrite< ArgumentType >, and mtsCommandQueuedWriteGeneric.

ArgumentPeek()

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

pure virtual

Implemented in mtsCommandQueuedWrite< _argumentType >, mtsCommandQueuedWrite< ArgumentType >, and mtsCommandQueuedWriteGeneric.

BlockingFlagGet()

mtsBlockingType mtsCommandQueuedWriteBase::BlockingFlagGet

(

void

)

Clone()

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

pure virtual

Implemented in mtsCommandFilteredQueuedWrite, mtsCommandQueuedWrite< _argumentType >, mtsCommandQueuedWrite< ArgumentType >, and mtsCommandQueuedWriteGeneric.

Execute() [1/2]

mtsExecutionResult mtsCommandQueuedWriteBase::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

argument	The data passed to the operation method
blocking	Indicates whether caller wishes to block until command finishes

Returns

the execution result (mtsExecutionResult)

Implements mtsCommandWriteBase.

Execute() [2/2]

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

pure virtual

Implemented in mtsCommandFilteredQueuedWrite, mtsCommandQueuedWrite< _argumentType >, mtsCommandQueuedWrite< ArgumentType >, and mtsCommandQueuedWriteGeneric.

FinishedEventGet()

mtsCommandWriteBase * mtsCommandQueuedWriteBase::FinishedEventGet

(

void

)

GetActualCommand()

virtual mtsCommandWriteBase * mtsCommandQueuedWriteBase::GetActualCommand ( void )

inlinevirtual

GetMailBoxName()

virtual const std::string mtsCommandQueuedWriteBase::GetMailBoxName ( void ) const

inlinevirtual

ToStream()

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

virtual

Implements mtsCommandBase.

Reimplemented in mtsCommandQueuedWriteGeneric.

Member Data Documentation

ActualCommand

mtsCommandWriteBase* mtsCommandQueuedWriteBase::ActualCommand

protected

BlockingFlagQueue

mtsQueue<mtsBlockingType> mtsCommandQueuedWriteBase::BlockingFlagQueue

protected

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

FinishedEventQueue

mtsQueue<mtsCommandWriteBase *> mtsCommandQueuedWriteBase::FinishedEventQueue

protected

Queue for return events (to send result to caller). If non-zero, this indicates that a blocking call was made (previously, this was a BlockingFlagQueue).

MailBox

mtsMailBox* mtsCommandQueuedWriteBase::MailBox

protected

---

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

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