ERC CISST - cisst software

mtsFunctionVoidReturn Class Reference

Inheritance diagram for mtsFunctionVoidReturn:

Inheritance graph
[legend]
Collaboration diagram for mtsFunctionVoidReturn:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 39 of file mtsFunctionVoidReturn.h.

Public Member Functions

Protected Types

Protected Attributes

Classes


Constructor & Destructor Documentation

mtsFunctionVoidReturn::mtsFunctionVoidReturn ( void   )  [inline]

Default constructor. Does nothing, use Instantiate before using.

Definition at line 63 of file mtsFunctionVoidReturn.h.

mtsFunctionVoidReturn::~mtsFunctionVoidReturn (  ) 

Destructor.


Member Function Documentation

bool mtsFunctionVoidReturn::Detach ( void   )  [virtual]

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

Implements mtsFunctionBase.

bool mtsFunctionVoidReturn::IsValid ( void   )  const [virtual]

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

Implements mtsFunctionBase.

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.

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

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

template<class _userType>
mtsExecutionResult mtsFunctionVoidReturn::operator() ( _userType &  result  )  const [inline]

Overloaded operator that accepts different argument types.

Definition at line 87 of file mtsFunctionVoidReturn.h.

CommandType* mtsFunctionVoidReturn::GetCommand ( void   )  const

Access to underlying command object.

const mtsGenericObject* mtsFunctionVoidReturn::GetResultPrototype ( void   )  const

Access to the command result prototype.

void mtsFunctionVoidReturn::ToStream ( std::ostream &  outputStream  )  const [virtual]

Human readable output to stream.

Implements mtsFunctionBase.


The documentation for this class was generated from the following file:
erc-cisst-devel<at>lists.johnshopkins.edu