mtsCommandFilteredWrite Class Reference

#include <mtsCommandFilteredWrite.h>

Inheritance diagram for mtsCommandFilteredWrite:

Public Types
typedef mtsCommandWriteBase	BaseType
typedef mtsCommandFilteredWrite	ThisType
Public Types inherited from mtsCommandWriteBase
typedef mtsCommandBase	BaseType

Public Member Functions
	mtsCommandFilteredWrite (mtsCommandQualifiedRead *filter, mtsCommandWriteBase *command)
virtual	~mtsCommandFilteredWrite ()
mtsExecutionResult	Execute (const mtsGenericObject &argument, mtsBlockingType blocking)
mtsExecutionResult	Execute (const mtsGenericObject &argument, mtsBlockingType blocking, mtsCommandWriteBase *CMN_UNUSED(finishedEventHandler))
const mtsGenericObject *	GetArgumentPrototype (void) const
void	ToStream (std::ostream &outputStream) const
Public Member Functions inherited from mtsCommandWriteBase
	mtsCommandWriteBase (void)
	mtsCommandWriteBase (const std::string &name)
virtual	~mtsCommandWriteBase ()
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
mtsCommandWriteBase *	Command
mtsCommandQualifiedRead *	Filter
mtsGenericObject *	FilterOutput
Protected Attributes inherited from mtsCommandWriteBase
const mtsGenericObject *	ArgumentPrototype
Protected Attributes inherited from mtsCommandBase
std::string	Name
bool	EnableFlag

Additional Inherited Members
Protected Member Functions inherited from mtsCommandWriteBase
virtual void	SetArgumentPrototype (const mtsGenericObject *argumentPrototype)

Member Typedef Documentation

BaseType

typedef mtsCommandWriteBase mtsCommandFilteredWrite::BaseType

ThisType

typedef mtsCommandFilteredWrite mtsCommandFilteredWrite::ThisType

Constructor & Destructor Documentation

mtsCommandFilteredWrite()

mtsCommandFilteredWrite::mtsCommandFilteredWrite	(	mtsCommandQualifiedRead *	filter,
		mtsCommandWriteBase *	command )

~mtsCommandFilteredWrite()

virtual mtsCommandFilteredWrite::~mtsCommandFilteredWrite ( )

virtual

Member Function Documentation

Execute() [1/2]

mtsExecutionResult mtsCommandFilteredWrite::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 mtsCommandFilteredWrite::Execute ( const mtsGenericObject & argument, mtsBlockingType blocking, mtsCommandWriteBase * CMN_UNUSEDfinishedEventHandler )

inlinevirtual

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)

Implements mtsCommandWriteBase.

GetArgumentPrototype()

const mtsGenericObject * mtsCommandFilteredWrite::GetArgumentPrototype ( void ) const

virtual

Return a pointer on the argument prototype

Reimplemented from mtsCommandWriteBase.

ToStream()

void mtsCommandFilteredWrite::ToStream ( std::ostream & outputStream ) const

virtual

Implements mtsCommandBase.

Member Data Documentation

Command

mtsCommandWriteBase* mtsCommandFilteredWrite::Command

protected

Filter

mtsCommandQualifiedRead* mtsCommandFilteredWrite::Filter

protected

FilterOutput

mtsGenericObject* mtsCommandFilteredWrite::FilterOutput

protected

---

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

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