mtsFunctionVoidReturn Class Reference

#include <mtsFunctionVoidReturn.h>

Inheritance diagram for mtsFunctionVoidReturn:

Classes
class	ConditionalWrap
class	ConditionalWrap< _userType, true >

Public Types
typedef mtsCommandVoidReturn	CommandType

Public Member Functions
	mtsFunctionVoidReturn ()
	~mtsFunctionVoidReturn ()
bool	Detach (void)
bool	IsValid (void) const
bool	Bind (CommandType *command)
mtsExecutionResult	operator() (mtsGenericObject &result) const
virtual mtsExecutionResult	ExecuteGeneric (mtsGenericObject &result) const
template<class _userType>
mtsExecutionResult	operator() (_userType &result) const
template<class _userType>
mtsExecutionResult	Execute (_userType &result) const
CommandType *	GetCommand (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 mtsCommandVoidReturn mtsFunctionVoidReturn::CommandType

Constructor & Destructor Documentation

mtsFunctionVoidReturn()

mtsFunctionVoidReturn::mtsFunctionVoidReturn

(

)

Default constructor. Does nothing, use Bind before using.

~mtsFunctionVoidReturn()

mtsFunctionVoidReturn::~mtsFunctionVoidReturn

(

)

Destructor.

Member Function Documentation

Bind()

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

virtual

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

Implements mtsFunctionBase.

Execute()

template<class _userType>

mtsExecutionResult mtsFunctionVoidReturn::Execute ( _userType & result ) const

inline

ExecuteGeneric()

virtual mtsExecutionResult mtsFunctionVoidReturn::ExecuteGeneric ( mtsGenericObject & result ) const

virtual

GetCommand()

CommandType * mtsFunctionVoidReturn::GetCommand

(

void

)

const

Access to underlying command object.

GetResultPrototype()

const mtsGenericObject * mtsFunctionVoidReturn::GetResultPrototype

(

void

)

const

Access to the command result prototype.

IsValid()

bool mtsFunctionVoidReturn::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 mtsFunctionVoidReturn::operator() ( _userType & result ) const

inline

Overloaded operator that accepts different argument types.

operator()() [2/2]

mtsExecutionResult mtsFunctionVoidReturn::operator() ( mtsGenericObject & result ) const

inline

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

ToStream()

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

virtual

Human readable output to stream.

Implements mtsFunctionBase.

Member Data Documentation

Command

CommandType* mtsFunctionVoidReturn::Command

protected

---

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

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