mtsCallableVoidMethod< _classType > Class Template Reference

#include <mtsCallableVoidMethod.h>

Inheritance diagram for mtsCallableVoidMethod< _classType >:

Public Types
typedef mtsCallableVoidBase	BaseType
typedef _classType	ClassType
typedef mtsCallableVoidMethod< ClassType >	ThisType
typedef void(_classType::*)	ActionType(void)

Public Member Functions
	mtsCallableVoidMethod (void)
	mtsCallableVoidMethod (ActionType action, ClassType *classInstantiation)
virtual	~mtsCallableVoidMethod ()
mtsExecutionResult	Execute (void)
void	ToStream (std::ostream &outputStream) const
Public Member Functions inherited from mtsCallableVoidBase
	mtsCallableVoidBase (void)
virtual	~mtsCallableVoidBase ()

Protected Attributes
ActionType	Action
ClassType *	ClassInstantiation

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.

Member Typedef Documentation

ActionType

template<class _classType>

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

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

BaseType

template<class _classType>

typedef mtsCallableVoidBase mtsCallableVoidMethod< _classType >::BaseType

ClassType

template<class _classType>

typedef _classType mtsCallableVoidMethod< _classType >::ClassType

Typedef for the specific interface.

ThisType

template<class _classType>

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

This type.

Constructor & Destructor Documentation

mtsCallableVoidMethod() [1/2]

template<class _classType>

mtsCallableVoidMethod< _classType >::mtsCallableVoidMethod ( void )

inline

The constructor. Does nothing.

mtsCallableVoidMethod() [2/2]

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

~mtsCallableVoidMethod()

template<class _classType>

virtual mtsCallableVoidMethod< _classType >::~mtsCallableVoidMethod ( )

inlinevirtual

The destructor. Does nothing

Member Function Documentation

Execute()

template<class _classType>

mtsExecutionResult mtsCallableVoidMethod< _classType >::Execute ( void )

inlinevirtual

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

Implements mtsCallableVoidBase.

ToStream()

template<class _classType>

void mtsCallableVoidMethod< _classType >::ToStream ( std::ostream & outputStream ) const

inlinevirtual

Human readable description

Implements mtsCallableVoidBase.

Member Data Documentation

Action

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.

ClassInstantiation

template<class _classType>

ClassType* mtsCallableVoidMethod< _classType >::ClassInstantiation

protected

Stores the receiver object of the command.

---

The documentation for this class was generated from the following file:

• tmp/cisst-saw/cisst/cisstMultiTask/mtsCallableVoidMethod.h