mtsFunctionVoid Class Reference

#include <mtsFunctionVoid.h>

Inheritance diagram for mtsFunctionVoid:

Public Types
typedef mtsCommandVoid	CommandType

Public Member Functions
	mtsFunctionVoid ()
	~mtsFunctionVoid ()
bool	Detach (void)
bool	IsValid (void) const
bool	Bind (CommandType *command)
mtsExecutionResult	operator() (void) const
mtsExecutionResult	Execute (void) const
mtsExecutionResult	ExecuteBlocking (void) const
mtsCommandVoid *	GetCommand (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 mtsCommandVoid mtsFunctionVoid::CommandType

Constructor & Destructor Documentation

mtsFunctionVoid()

mtsFunctionVoid::mtsFunctionVoid

(

)

Default constructor. Does nothing, use Bind before using.

~mtsFunctionVoid()

mtsFunctionVoid::~mtsFunctionVoid

(

)

Destructor.

Member Function Documentation

Bind()

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

virtual

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

Implements mtsFunctionBase.

Execute()

mtsExecutionResult mtsFunctionVoid::Execute

(

void

)

const

Non-blocking call

ExecuteBlocking()

mtsExecutionResult mtsFunctionVoid::ExecuteBlocking

(

void

)

const

Blocking call

GetCommand()

mtsCommandVoid * mtsFunctionVoid::GetCommand

(

void

)

const

Access to underlying command object.

IsValid()

bool mtsFunctionVoid::IsValid ( void ) const

virtual

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

Implements mtsFunctionBase.

operator()()

mtsExecutionResult mtsFunctionVoid::operator() ( void ) const

inline

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

ToStream()

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

virtual

Human readable output to stream.

Implements mtsFunctionBase.

Member Data Documentation

Command

CommandType* mtsFunctionVoid::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/mtsFunctionVoid.h