mtsFunctionQualifiedRead Class Reference

#include <mtsFunctionQualifiedRead.h>

Inheritance diagram for mtsFunctionQualifiedRead:

Classes
class	ConditionalWrap
class	ConditionalWrap< _userType1, _userType2, false, true >
class	ConditionalWrap< _userType1, _userType2, true, false >
class	ConditionalWrap< _userType1, _userType2, true, true >

Public Types
typedef mtsCommandQualifiedRead	CommandType

Public Member Functions
	mtsFunctionQualifiedRead (void)
	~mtsFunctionQualifiedRead ()
bool	Detach (void)
bool	IsValid (void) const
bool	Bind (CommandType *command)
mtsExecutionResult	operator() (const mtsGenericObject &qualifier, mtsGenericObject &argument) const
mtsExecutionResult	ExecuteGeneric (const mtsGenericObject &qualifier, mtsGenericObject &argument) const
template<class _userType1, class _userType2>
mtsExecutionResult	operator() (const _userType1 &argument1, _userType2 &argument2) const
template<class _userType1, class _userType2>
mtsExecutionResult	Execute (const _userType1 &argument1, _userType2 &argument2) const
CommandType *	GetCommand (void) const
const mtsGenericObject *	GetArgument1Prototype (void) const
const mtsGenericObject *	GetArgument2Prototype (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 mtsCommandQualifiedRead mtsFunctionQualifiedRead::CommandType

Constructor & Destructor Documentation

mtsFunctionQualifiedRead()

mtsFunctionQualifiedRead::mtsFunctionQualifiedRead

(

void

)

Default constructor. Does nothing, use Bind before using.

~mtsFunctionQualifiedRead()

mtsFunctionQualifiedRead::~mtsFunctionQualifiedRead

(

)

Destructor.

Member Function Documentation

Bind()

bool mtsFunctionQualifiedRead::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 mtsFunctionQualifiedRead::Detach ( void )

virtual

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

Implements mtsFunctionBase.

Execute()

template<class _userType1, class _userType2>

mtsExecutionResult mtsFunctionQualifiedRead::Execute ( const _userType1 & argument1, _userType2 & argument2 ) const

inline

ExecuteGeneric()

mtsExecutionResult mtsFunctionQualifiedRead::ExecuteGeneric	(	const mtsGenericObject &	qualifier,
		mtsGenericObject &	argument ) const

GetArgument1Prototype()

const mtsGenericObject * mtsFunctionQualifiedRead::GetArgument1Prototype

(

void

)

const

Access to the command argument 1 prototype.

GetArgument2Prototype()

const mtsGenericObject * mtsFunctionQualifiedRead::GetArgument2Prototype

(

void

)

const

Access to the command argument 2 prototype.

GetCommand()

CommandType * mtsFunctionQualifiedRead::GetCommand

(

void

)

const

Access to underlying command object.

IsValid()

bool mtsFunctionQualifiedRead::IsValid ( void ) const

virtual

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

Implements mtsFunctionBase.

operator()() [1/2]

template<class _userType1, class _userType2>

mtsExecutionResult mtsFunctionQualifiedRead::operator() ( const _userType1 & argument1, _userType2 & argument2 ) const

inline

Overloaded operator that accepts different argument types (for qualified read).

operator()() [2/2]

mtsExecutionResult mtsFunctionQualifiedRead::operator() ( const mtsGenericObject & qualifier, mtsGenericObject & argument ) const

inline

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

ToStream()

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

virtual

Human readable output to stream.

Implements mtsFunctionBase.

Member Data Documentation

Command

CommandType* mtsFunctionQualifiedRead::Command

protected

---

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

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