ERC CISST - cisst software

mtsCallableVoidMethod< _classType > Class Template Reference
[Multi Task Support]

#include <mtsCallableVoidMethod.h>

Inheritance diagram for mtsCallableVoidMethod< _classType >:

Inheritance graph
[legend]
Collaboration diagram for mtsCallableVoidMethod< _classType >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class _classType>
class mtsCallableVoidMethod< _classType >

A templated version of command object with zero arguments for execute. The template argument is the class type whose method is contained in the command object. This command is based on a void method, i.e. it requires the class and method name as well as an instantiation of the class to get and actual pointer on the method.

Definition at line 46 of file mtsCallableVoidMethod.h.

Public Types

Public Member Functions

Protected Attributes

Member Typedef Documentation

template<class _classType>
typedef _classType mtsCallableVoidMethod< _classType >::ClassType

Typedef for the specific interface.

Definition at line 52 of file mtsCallableVoidMethod.h.

template<class _classType>
typedef mtsCallableVoidMethod<ClassType> mtsCallableVoidMethod< _classType >::ThisType

This type.

Definition at line 55 of file mtsCallableVoidMethod.h.

template<class _classType>
typedef void(_classType::*) mtsCallableVoidMethod< _classType >::ActionType(void)

Typedef for pointer to member function (method) of a specific class (_classType).

Definition at line 59 of file mtsCallableVoidMethod.h.

Constructor & Destructor Documentation

template<class _classType>
mtsCallableVoidMethod< _classType >::mtsCallableVoidMethod ( void   )  [inline]

The constructor. Does nothing.

Definition at line 75 of file mtsCallableVoidMethod.h.

template<class _classType>
mtsCallableVoidMethod< _classType >::mtsCallableVoidMethod ( ActionType  action,
ClassType *  classInstantiation 
) [inline]

The constructor.

Parameters:
action Pointer to the member function that is to be called by the invoker of the command
classInstantiation Pointer to the receiver of the command

Definition at line 82 of file mtsCallableVoidMethod.h.

template<class _classType>
virtual mtsCallableVoidMethod< _classType >::~mtsCallableVoidMethod (  )  [inline, virtual]

The destructor. Does nothing

Definition at line 89 of file mtsCallableVoidMethod.h.

Member Function Documentation

template<class _classType>
void mtsCallableVoidMethod< _classType >::Execute ( void   )  [inline, virtual]

The execute method. Abstract method to be implemented by derived classes to run the actual operation on the receiver.

Implements mtsCallableVoidBase.

Definition at line 92 of file mtsCallableVoidMethod.h.

References mtsCallableVoidMethod< _classType >::Action, and mtsCallableVoidMethod< _classType >::ClassInstantiation.

template<class _classType>
void mtsCallableVoidMethod< _classType >::ToStream ( std::ostream &  outputStream  )  const [inline, virtual]

Human readable description

Implements mtsCallableVoidBase.

Definition at line 97 of file mtsCallableVoidMethod.h.

References mtsObjectName().

Member Data Documentation

template<class _classType>
ActionType mtsCallableVoidMethod< _classType >::Action [protected]

The pointer to member function of the receiver class that is to be invoked for a particular instance of the command.

Definition at line 68 of file mtsCallableVoidMethod.h.

Referenced by mtsCallableVoidMethod< _classType >::Execute().

template<class _classType>
ClassType* mtsCallableVoidMethod< _classType >::ClassInstantiation [protected]

Stores the receiver object of the command.

Definition at line 71 of file mtsCallableVoidMethod.h.

Referenced by mtsCallableVoidMethod< _classType >::Execute().

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