mtsCommandQualifiedRead Class Reference

#include <mtsCommandQualifiedRead.h>

Inheritance diagram for mtsCommandQualifiedRead:

Public Types
typedef mtsCommandBase	BaseType
typedef mtsCommandQualifiedRead	ThisType
typedef mtsCallableQualifiedReadBase	CallableType

Public Member Functions
	mtsCommandQualifiedRead (void)
	mtsCommandQualifiedRead (const std::string &name)
	mtsCommandQualifiedRead (mtsCallableQualifiedReadBase *callable, const std::string &name, const mtsGenericObject *argument1Prototype, const mtsGenericObject *argument2Prototype)
virtual	~mtsCommandQualifiedRead ()
virtual mtsExecutionResult	Execute (const mtsGenericObject &argument1, mtsGenericObject &argument2)
virtual mtsExecutionResult	Execute (const mtsGenericObject &argument1, mtsGenericObject &argument2, mtsCommandWriteBase *CMN_UNUSED(finishedEventHandler))
mtsCallableQualifiedReadBase *	GetCallable (void) const
const mtsGenericObject *	GetArgument1Prototype (void) const
const mtsGenericObject *	GetArgument2Prototype (void) const
const mtsGenericObject *	GetArgumentPrototype (void) const
const mtsGenericObject *	GetResultPrototype (void) const
size_t	NumberOfArguments (void) const
bool	Returns (void) const
void	ToStream (std::ostream &outputStream) 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
mtsCallableQualifiedReadBase *	Callable
const mtsGenericObject *	Argument1Prototype
const mtsGenericObject *	Argument2Prototype
Protected Attributes inherited from mtsCommandBase
std::string	Name
bool	EnableFlag

Detailed Description

A templated version of command object with one argument for execute. The template argument is the interface type whose method is contained in the command object.

Member Typedef Documentation

BaseType

typedef mtsCommandBase mtsCommandQualifiedRead::BaseType

Base type

CallableType

typedef mtsCallableQualifiedReadBase mtsCommandQualifiedRead::CallableType

Callable type

ThisType

typedef mtsCommandQualifiedRead mtsCommandQualifiedRead::ThisType

This type.

Constructor & Destructor Documentation

mtsCommandQualifiedRead() [1/3]

mtsCommandQualifiedRead::mtsCommandQualifiedRead

(

void

)

The constructor. Does nothing

mtsCommandQualifiedRead() [2/3]

mtsCommandQualifiedRead::mtsCommandQualifiedRead

(

const std::string &

name

)

mtsCommandQualifiedRead() [3/3]

mtsCommandQualifiedRead::mtsCommandQualifiedRead	(	mtsCallableQualifiedReadBase *	callable,
		const std::string &	name,
		const mtsGenericObject *	argument1Prototype,
		const mtsGenericObject *	argument2Prototype )

The constructor.

Parameters

action	Pointer to the member function that is to be called by the invoker of the command
interface	Pointer to the receiver of the command
name	A string to identify the command.

~mtsCommandQualifiedRead()

virtual mtsCommandQualifiedRead::~mtsCommandQualifiedRead ( )

virtual

The destructor. Does nothing

Member Function Documentation

Execute() [1/2]

virtual mtsExecutionResult mtsCommandQualifiedRead::Execute ( const mtsGenericObject & argument1, mtsGenericObject & argument2 )

virtual

The execute method. Calling the execute method from the invoker applies the operation on the receiver.

Parameters

obj	The data passed to the operation method

Reimplemented in mtsCommandQueuedWriteReturnBase< mtsCommandQualifiedRead >.

Execute() [2/2]

virtual mtsExecutionResult mtsCommandQualifiedRead::Execute ( const mtsGenericObject & argument1, mtsGenericObject & argument2, mtsCommandWriteBase * CMN_UNUSEDfinishedEventHandler )

inlinevirtual

Execute method that includes a pointer to a handler for the finished event. This is intended for derived classes (e.g., mtsCommandQueuedQualifiedRead).

GetArgument1Prototype()

const mtsGenericObject * mtsCommandQualifiedRead::GetArgument1Prototype

(

void

)

const

GetArgument2Prototype()

const mtsGenericObject * mtsCommandQualifiedRead::GetArgument2Prototype

(

void

)

const

GetArgumentPrototype()

const mtsGenericObject * mtsCommandQualifiedRead::GetArgumentPrototype

(

void

)

const

GetCallable()

mtsCallableQualifiedReadBase * mtsCommandQualifiedRead::GetCallable

(

void

)

const

Get a direct pointer to the callable object. This method is used for queued commands. The caller should still use the Execute method which will queue the command. When the command is de-queued, one needs access to the callable object to call the final method or function.

GetResultPrototype()

const mtsGenericObject * mtsCommandQualifiedRead::GetResultPrototype

(

void

)

const

NumberOfArguments()

size_t mtsCommandQualifiedRead::NumberOfArguments ( void ) const

virtual

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

Implements mtsCommandBase.

Returns()

bool mtsCommandQualifiedRead::Returns ( void ) const

virtual

Implements mtsCommandBase.

ToStream()

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

virtual

Implements mtsCommandBase.

Reimplemented in mtsCommandQueuedWriteReturnBase< mtsCommandQualifiedRead >.

Member Data Documentation

Argument1Prototype

const mtsGenericObject* mtsCommandQualifiedRead::Argument1Prototype

protected

Argument 1 prototype

Argument2Prototype

const mtsGenericObject* mtsCommandQualifiedRead::Argument2Prototype

protected

Argument 2 prototype

Callable

mtsCallableQualifiedReadBase* mtsCommandQualifiedRead::Callable

protected

---

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

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