ERC CISST - cisst software

mtsFunctionQualifiedRead Class Reference

Inheritance diagram for mtsFunctionQualifiedRead:

Inheritance graph
[legend]
Collaboration diagram for mtsFunctionQualifiedRead:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 38 of file mtsFunctionQualifiedRead.h.

Public Member Functions

Protected Types

Protected Attributes

Classes


Constructor & Destructor Documentation

mtsFunctionQualifiedRead::mtsFunctionQualifiedRead ( void   )  [inline]

Default constructor. Does nothing, use Bind before using.

Definition at line 88 of file mtsFunctionQualifiedRead.h.

mtsFunctionQualifiedRead::~mtsFunctionQualifiedRead (  ) 

Destructor.


Member Function Documentation

bool mtsFunctionQualifiedRead::Detach ( void   )  [virtual]

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

Implements mtsFunctionBase.

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

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

Implements mtsFunctionBase.

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

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

template<class _userType1, class _userType2>
mtsExecutionResult mtsFunctionQualifiedRead::operator() ( const _userType1 &  argument1,
_userType2 &  argument2 
) const [inline]

Overloaded operator that accepts different argument types (for qualified read).

Definition at line 113 of file mtsFunctionQualifiedRead.h.

CommandType* mtsFunctionQualifiedRead::GetCommand ( void   )  const

Access to underlying command object.

const mtsGenericObject* mtsFunctionQualifiedRead::GetArgument1Prototype ( void   )  const

Access to the command argument 1 prototype.

const mtsGenericObject* mtsFunctionQualifiedRead::GetArgument2Prototype ( void   )  const

Access to the command argument 2 prototype.

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