ERC CISST - cisst software

mtsFunctionWrite Class Reference

Inheritance diagram for mtsFunctionWrite:

Inheritance graph
[legend]
Collaboration diagram for mtsFunctionWrite:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 38 of file mtsFunctionWrite.h.

Public Member Functions

Protected Types

Protected Attributes

Classes


Constructor & Destructor Documentation

mtsFunctionWrite::mtsFunctionWrite ( void   )  [inline]

Default constructor. Does nothing, use Bind before using.

Definition at line 62 of file mtsFunctionWrite.h.

virtual mtsFunctionWrite::~mtsFunctionWrite (  )  [virtual]

Destructor.


Member Function Documentation

bool mtsFunctionWrite::Detach ( void   )  [virtual]

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

Implements mtsFunctionBase.

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

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

Implements mtsFunctionBase.

bool mtsFunctionWrite::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.

Referenced by mtsInterfaceProvided::AddEventWrite().

mtsExecutionResult mtsFunctionWrite::operator() ( const mtsGenericObject argument  )  const

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

template<class _userType>
mtsExecutionResult mtsFunctionWrite::operator() ( const _userType &  argument  )  const [inline]

Overloaded operator that accepts different argument types.

Definition at line 88 of file mtsFunctionWrite.h.

CommandType* mtsFunctionWrite::GetCommand ( void   )  const

Access to underlying command object.

const mtsGenericObject* mtsFunctionWrite::GetArgumentPrototype ( void   )  const

Access to the command argument prototype.

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