ERC CISST - cisst software

mtsFunctionWriteReturn Class Reference

Inheritance diagram for mtsFunctionWriteReturn:

Inheritance graph
[legend]
Collaboration diagram for mtsFunctionWriteReturn:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 39 of file mtsFunctionWriteReturn.h.

Public Member Functions

Protected Types

Protected Attributes

Classes


Constructor & Destructor Documentation

mtsFunctionWriteReturn::mtsFunctionWriteReturn ( void   )  [inline]

Default constructor. Does nothing, use Instantiate before using.

Definition at line 87 of file mtsFunctionWriteReturn.h.

mtsFunctionWriteReturn::~mtsFunctionWriteReturn (  ) 

Destructor.


Member Function Documentation

bool mtsFunctionWriteReturn::Detach ( void   )  [virtual]

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

Implements mtsFunctionBase.

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

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

Implements mtsFunctionBase.

bool mtsFunctionWriteReturn::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 mtsFunctionWriteReturn::operator() ( const mtsGenericObject argument,
mtsGenericObject result 
) const

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

template<class __argumentType, class __resultType>
mtsExecutionResult mtsFunctionWriteReturn::operator() ( const __argumentType &  argument,
__resultType &  result 
) const [inline]

Overloaded operator that accepts different argument types (for write return).

Definition at line 112 of file mtsFunctionWriteReturn.h.

CommandType* mtsFunctionWriteReturn::GetCommand ( void   )  const

Access to underlying command object.

const mtsGenericObject* mtsFunctionWriteReturn::GetArgumentPrototype ( void   )  const

Access to the command argument prototype.

const mtsGenericObject* mtsFunctionWriteReturn::GetResultPrototype ( void   )  const

Access to the command result prototype.

void mtsFunctionWriteReturn::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