mtsCallableVoidReturnMethod< _classType, _resultType > Class Template Reference

#include <mtsCallableVoidReturnMethod.h>

Inheritance diagram for mtsCallableVoidReturnMethod< _classType, _resultType >:

Classes
class	ConditionalCast
class	ConditionalCast< true, _dummy >

Public Types
typedef mtsCallableVoidReturnBase	BaseType
typedef _resultType	ResultType
typedef _classType	ClassType
typedef mtsCallableVoidReturnMethod< ClassType, ResultType >	ThisType
typedef void(_classType::*)	ActionType(ResultType &result)

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

Protected Attributes
ActionType	Action
ClassType *	ClassInstantiation

Member Typedef Documentation

ActionType

template<class _classType, class _resultType>

typedef void(_classType::*) mtsCallableVoidReturnMethod< _classType, _resultType >::ActionType(ResultType &result)

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

BaseType

template<class _classType, class _resultType>

typedef mtsCallableVoidReturnBase mtsCallableVoidReturnMethod< _classType, _resultType >::BaseType

ClassType

template<class _classType, class _resultType>

typedef _classType mtsCallableVoidReturnMethod< _classType, _resultType >::ClassType

Typedef for the specific interface.

ResultType

template<class _classType, class _resultType>

typedef _resultType mtsCallableVoidReturnMethod< _classType, _resultType >::ResultType

ThisType

template<class _classType, class _resultType>

typedef mtsCallableVoidReturnMethod<ClassType, ResultType> mtsCallableVoidReturnMethod< _classType, _resultType >::ThisType

This type.

Constructor & Destructor Documentation

mtsCallableVoidReturnMethod() [1/2]

template<class _classType, class _resultType>

mtsCallableVoidReturnMethod< _classType, _resultType >::mtsCallableVoidReturnMethod ( void )

inline

The constructor. Does nothing.

mtsCallableVoidReturnMethod() [2/2]

template<class _classType, class _resultType>

mtsCallableVoidReturnMethod< _classType, _resultType >::mtsCallableVoidReturnMethod ( 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

~mtsCallableVoidReturnMethod()

template<class _classType, class _resultType>

virtual mtsCallableVoidReturnMethod< _classType, _resultType >::~mtsCallableVoidReturnMethod ( )

inlinevirtual

The destructor. Does nothing

Member Function Documentation

Execute()

template<class _classType, class _resultType>

mtsExecutionResult mtsCallableVoidReturnMethod< _classType, _resultType >::Execute ( mtsGenericObject & result )

inlinevirtual

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

Implements mtsCallableVoidReturnBase.

ToStream()

template<class _classType, class _resultType>

void mtsCallableVoidReturnMethod< _classType, _resultType >::ToStream ( std::ostream & outputStream ) const

inlinevirtual

Human readable description

Implements mtsCallableVoidReturnBase.

Member Data Documentation

Action

template<class _classType, class _resultType>

ActionType mtsCallableVoidReturnMethod< _classType, _resultType >::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, class _resultType>

ClassType* mtsCallableVoidReturnMethod< _classType, _resultType >::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/mtsCallableVoidReturnMethod.h