ERC CISST - cisst software

mtsCommandRead Class Reference
[Multi Task Support]

#include <mtsCommandRead.h>

Inheritance diagram for mtsCommandRead:

Inheritance graph
[legend]
Collaboration diagram for mtsCommandRead:

Collaboration graph
[legend]
List of all members.

Detailed Description

A templated version of command object with one argument for execute. The template argument is the interface type whose method is contained in the command object.

Definition at line 44 of file mtsCommandRead.h.

Public Types

Public Member Functions

Protected Attributes


Member Typedef Documentation

typedef mtsCommandBase mtsCommandRead::BaseType

Base type

Reimplemented in mtsCommandReadProxy.

Definition at line 47 of file mtsCommandRead.h.

typedef mtsCommandRead mtsCommandRead::ThisType

This type.

Definition at line 50 of file mtsCommandRead.h.


Constructor & Destructor Documentation

mtsCommandRead::mtsCommandRead ( void   ) 

The constructor. Does nothing

mtsCommandRead::mtsCommandRead ( mtsCallableReadBase callable,
const std::string &  name,
const mtsGenericObject argumentPrototype 
)

The constructor.

Parameters:
action Pointer to the member function that is to be called by the invoker of the command
name A string to identify the command
argumentPrototype An instance of the argument being used

mtsCommandRead::~mtsCommandRead (  ) 

The destructor. Does nothing


Member Function Documentation

virtual mtsExecutionResult mtsCommandRead::Execute ( mtsGenericObject argument  )  [virtual]

The execute method. Calling the execute method from the invoker applies the operation on the receiver.

Parameters:
obj The data passed to the operation method

Referenced by mtsFunctionRead::ConditionalWrap< _userType, true >::Call(), and mtsFunctionRead::ConditionalWrap< _userType, >::Call().

size_t mtsCommandRead::NumberOfArguments ( void   )  const [virtual]

Returns number of arguments (parameters) expected by Execute method. Must be overloaded in derived classes.

Implements mtsCommandBase.

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

For debugging. Generate a human readable output for the command object

Implements mtsCommandBase.

Reimplemented in mtsCommandReadProxy.


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