mtsFunctionWrite Class Reference

#include <mtsFunctionWrite.h>

Inheritance diagram for mtsFunctionWrite:

Classes
class	ConditionalWrap
class	ConditionalWrap< _userType, true >

Public Types
typedef mtsCommandWriteBase	CommandType
typedef mtsExecutionResult(mtsFunctionWrite::*)	ActionType(const mtsGenericObject &) const

Public Member Functions
	mtsFunctionWrite ()
virtual	~mtsFunctionWrite ()
bool	Detach (void)
bool	IsValid (void) const
bool	Bind (CommandType *command)
mtsExecutionResult	operator() (const mtsGenericObject &argument) const
mtsExecutionResult	ExecuteGeneric (const mtsGenericObject &argument) const
mtsExecutionResult	ExecuteBlockingGeneric (const mtsGenericObject &argument) const
template<class _userType>
mtsExecutionResult	operator() (const _userType &argument) const
template<class _userType>
mtsExecutionResult	Execute (const _userType &argument) const
template<class _userType>
mtsExecutionResult	ExecuteBlocking (const _userType &argument) const
CommandType *	GetCommand (void) const
const mtsGenericObject *	GetArgumentPrototype (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

ActionType

typedef mtsExecutionResult(mtsFunctionWrite::*) mtsFunctionWrite::ActionType(const mtsGenericObject &) const

CommandType

typedef mtsCommandWriteBase mtsFunctionWrite::CommandType

Constructor & Destructor Documentation

mtsFunctionWrite()

mtsFunctionWrite::mtsFunctionWrite

(

)

Default constructor. Does nothing, use Bind before using.

~mtsFunctionWrite()

virtual mtsFunctionWrite::~mtsFunctionWrite ( )

virtual

Destructor.

Member Function Documentation

Bind()

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

virtual

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

Implements mtsFunctionBase.

Execute()

template<class _userType>

mtsExecutionResult mtsFunctionWrite::Execute ( const _userType & argument ) const

inline

ExecuteBlocking()

template<class _userType>

mtsExecutionResult mtsFunctionWrite::ExecuteBlocking ( const _userType & argument ) const

inline

ExecuteBlockingGeneric()

mtsExecutionResult mtsFunctionWrite::ExecuteBlockingGeneric

(

const mtsGenericObject &

argument

)

const

ExecuteGeneric()

mtsExecutionResult mtsFunctionWrite::ExecuteGeneric

(

const mtsGenericObject &

argument

)

const

GetArgumentPrototype()

const mtsGenericObject * mtsFunctionWrite::GetArgumentPrototype

(

void

)

const

Access to the command argument prototype.

GetCommand()

CommandType * mtsFunctionWrite::GetCommand

(

void

)

const

Access to underlying command object.

IsValid()

bool mtsFunctionWrite::IsValid ( void ) const

virtual

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

Implements mtsFunctionBase.

operator()() [1/2]

template<class _userType>

mtsExecutionResult mtsFunctionWrite::operator() ( const _userType & argument ) const

inline

Overloaded operator that accepts different argument types.

operator()() [2/2]

mtsExecutionResult mtsFunctionWrite::operator() ( const mtsGenericObject & argument ) const

inline

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

ToStream()

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

virtual

Human readable output to stream.

Implements mtsFunctionBase.

Member Data Documentation

Command

CommandType* mtsFunctionWrite::Command

protected

Internal pointer to command. Command pointer should be set when interfaces get connected.

---

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

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