mtsCommandWriteBase Class Reference

#include <mtsCommandWriteBase.h>

Inheritance diagram for mtsCommandWriteBase:

Public Types
typedef mtsCommandBase	BaseType

Public Member Functions
	mtsCommandWriteBase (void)
	mtsCommandWriteBase (const std::string &name)
virtual	~mtsCommandWriteBase ()
virtual mtsExecutionResult	Execute (const mtsGenericObject &argument, mtsBlockingType blocking)=0
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
virtual void	ToStream (std::ostream &outputStream) const =0
void	Enable (void)
void	Disable (void)
bool	IsEnabled (void) const
bool	IsDisabled (void) const
const std::string &	GetName (void) const

Protected Member Functions
virtual void	SetArgumentPrototype (const mtsGenericObject *argumentPrototype)

Protected Attributes
const mtsGenericObject *	ArgumentPrototype
Protected Attributes inherited from mtsCommandBase
std::string	Name
bool	EnableFlag

Friends
class	mtsMulticastCommandWriteBase
class	mtsCommandQueuedWriteGeneric

Detailed Description

A base class of command object with an execute method that takes one argument.

Member Typedef Documentation

BaseType

typedef mtsCommandBase mtsCommandWriteBase::BaseType

Constructor & Destructor Documentation

mtsCommandWriteBase() [1/2]

mtsCommandWriteBase::mtsCommandWriteBase ( void )

inline

The constructor. Does nothing

mtsCommandWriteBase() [2/2]

mtsCommandWriteBase::mtsCommandWriteBase ( const std::string & name )

inline

~mtsCommandWriteBase()

virtual mtsCommandWriteBase::~mtsCommandWriteBase ( )

inlinevirtual

The destructor. Does nothing

Member Function Documentation

Execute() [1/2]

virtual mtsExecutionResult mtsCommandWriteBase::Execute ( const mtsGenericObject & argument, mtsBlockingType blocking )

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

Implemented in mtsCommandFilteredWrite, mtsCommandQueuedWriteBase, and mtsMulticastCommandWriteBase.

Execute() [2/2]

virtual mtsExecutionResult mtsCommandWriteBase::Execute ( const mtsGenericObject & argument, mtsBlockingType blocking, mtsCommandWriteBase * CMN_UNUSEDfinishedEventHandler )

pure virtual

The execute method. Method may 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
finishedEventHandler	Command object to invoke when blocking command is finished

Returns

the execution result (mtsExecutionResult)

Implemented in mtsCommandFilteredWrite, mtsCommandWrite< _classType, _argumentType >, mtsCommandWrite< ClassType, ArgumentType >, mtsCommandWriteGeneric< _classType >, mtsCommandWriteGeneric< ClassType >, mtsMulticastCommandWrite< _argumentType >, and mtsMulticastCommandWriteGeneric.

GetArgumentClassServices()

const cmnClassServicesBase * mtsCommandWriteBase::GetArgumentClassServices ( void ) const

inline

Return const pointer of class services associated to the argument type.

GetArgumentPrototype()

virtual const mtsGenericObject * mtsCommandWriteBase::GetArgumentPrototype ( void ) const

inlinevirtual

Return a pointer on the argument prototype

Reimplemented in mtsCommandFilteredQueuedWrite, mtsCommandFilteredWrite, mtsCommandQueuedWrite< _argumentType >, mtsCommandQueuedWrite< ArgumentType >, and mtsCommandQueuedWriteGeneric.

NumberOfArguments()

size_t mtsCommandWriteBase::NumberOfArguments ( void ) const

inlinevirtual

Returns number of arguments (parameters) expected by Execute method. Must be overloaded in derived classes.

Implements mtsCommandBase.

Returns()

bool mtsCommandWriteBase::Returns ( void ) const

inlinevirtual

Implements mtsCommandBase.

SetArgumentPrototype()

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

inlineprotectedvirtual

Reimplemented in mtsCommandQueuedWriteGeneric.

Friends And Related Symbol Documentation

mtsCommandQueuedWriteGeneric

friend class mtsCommandQueuedWriteGeneric

friend

mtsMulticastCommandWriteBase

friend class mtsMulticastCommandWriteBase

friend

Member Data Documentation

ArgumentPrototype

const mtsGenericObject* mtsCommandWriteBase::ArgumentPrototype

protected

---

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

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