ERC CISST - cisst software

mtsFunctionVoid Class Reference

Inheritance diagram for mtsFunctionVoid:

Inheritance graph
[legend]
Collaboration diagram for mtsFunctionVoid:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 37 of file mtsFunctionVoid.h.

Public Member Functions

Protected Types

Protected Attributes


Constructor & Destructor Documentation

mtsFunctionVoid::mtsFunctionVoid ( void   )  [inline]

Default constructor. Does nothing, use Instantiate before using.

Definition at line 45 of file mtsFunctionVoid.h.

mtsFunctionVoid::~mtsFunctionVoid (  ) 

Destructor.


Member Function Documentation

bool mtsFunctionVoid::Detach ( void   )  [virtual]

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

Implements mtsFunctionBase.

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

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

Implements mtsFunctionBase.

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.

mtsExecutionResult mtsFunctionVoid::operator() ( void   )  const

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

mtsExecutionResult mtsFunctionVoid::ExecuteBlocking ( void   )  const

Blocking call

mtsCommandVoid* mtsFunctionVoid::GetCommand ( void   )  const

Access to underlying command object.

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