mtsFunctionWriteReturn Class Reference

#include <mtsFunctionWriteReturn.h>

Inheritance diagram for mtsFunctionWriteReturn:

Classes
class	ConditionalWrap
class	ConditionalWrap< __argumentType, __resultType, false, true >
class	ConditionalWrap< __argumentType, __resultType, true, false >
class	ConditionalWrap< __argumentType, __resultType, true, true >

Public Types
typedef mtsCommandWriteReturn	CommandType

Public Member Functions
	mtsFunctionWriteReturn ()
	~mtsFunctionWriteReturn ()
bool	Detach (void)
bool	IsValid (void) const
bool	Bind (CommandType *command)
mtsExecutionResult	operator() (const mtsGenericObject &argument, mtsGenericObject &result) const
mtsExecutionResult	ExecuteGeneric (const mtsGenericObject &argument, mtsGenericObject &result) const
template<class __argumentType, class __resultType>
mtsExecutionResult	operator() (const __argumentType &argument, __resultType &result) const
template<class __argumentType, class __resultType>
mtsExecutionResult	Execute (const __argumentType &argument, __resultType &result) const
CommandType *	GetCommand (void) const
const mtsGenericObject *	GetArgumentPrototype (void) const
const mtsGenericObject *	GetResultPrototype (void) const
void	ToStream (std::ostream &outputStream) const
Public Member Functions inherited from mtsFunctionBase
virtual void	InitCompletionCommand (const std::string &name)
virtual void	DeleteCompletionCommand (void)
void	SetThreadSignal (osaThreadSignal *threadSignal)
void	ThreadSignalWait (void) const
mtsExecutionResult	WaitForResult (void) const

Protected Attributes
CommandType *	Command
Protected Attributes inherited from mtsFunctionBase
osaThreadSignal *	ThreadSignal
mtsEventReceiverWrite *	CompletionCommand

Additional Inherited Members
Protected Member Functions inherited from mtsFunctionBase
	mtsFunctionBase ()
virtual	~mtsFunctionBase ()

Member Typedef Documentation

CommandType

typedef mtsCommandWriteReturn mtsFunctionWriteReturn::CommandType

Constructor & Destructor Documentation

mtsFunctionWriteReturn()

mtsFunctionWriteReturn::mtsFunctionWriteReturn

(

)

Default constructor. Does nothing, use Bind before using.

~mtsFunctionWriteReturn()

mtsFunctionWriteReturn::~mtsFunctionWriteReturn

(

)

Destructor.

Member Function Documentation

Bind()

bool mtsFunctionWriteReturn::Bind

(

CommandType *

command

)

Bind using a command pointer. This allows to avoid querying by name from an interface.

Parameters

command

Pointer on an existing command

Returns

Boolean value, true if the command pointer is not null.

Detach()

bool mtsFunctionWriteReturn::Detach ( void )

virtual

Detach the function from the command used. Internally, sets the command pointer to 0

Implements mtsFunctionBase.

Execute()

template<class __argumentType, class __resultType>

mtsExecutionResult mtsFunctionWriteReturn::Execute ( const __argumentType & argument, __resultType & result ) const

inline

ExecuteGeneric()

mtsExecutionResult mtsFunctionWriteReturn::ExecuteGeneric	(	const mtsGenericObject &	argument,
		mtsGenericObject &	result ) const

GetArgumentPrototype()

const mtsGenericObject * mtsFunctionWriteReturn::GetArgumentPrototype

(

void

)

const

Access to the command argument prototype.

GetCommand()

CommandType * mtsFunctionWriteReturn::GetCommand

(

void

)

const

Access to underlying command object.

GetResultPrototype()

const mtsGenericObject * mtsFunctionWriteReturn::GetResultPrototype

(

void

)

const

Access to the command result prototype.

IsValid()

bool mtsFunctionWriteReturn::IsValid ( void ) const

virtual

Return whether function is valid (i.e., command pointer is non-zero)

Implements mtsFunctionBase.

operator()() [1/2]

template<class __argumentType, class __resultType>

mtsExecutionResult mtsFunctionWriteReturn::operator() ( const __argumentType & argument, __resultType & result ) const

inline

Overloaded operator that accepts different argument types (for write return).

operator()() [2/2]

mtsExecutionResult mtsFunctionWriteReturn::operator() ( const mtsGenericObject & argument, mtsGenericObject & result ) const

inline

Overloaded operator to enable more intuitive syntax e.g., Command() instead of Command->Execute().

ToStream()

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

virtual

Human readable output to stream.

Implements mtsFunctionBase.

Member Data Documentation

Command

CommandType* mtsFunctionWriteReturn::Command

protected

---

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

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