mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType > Class Template Reference

#include <mtsCallableQualifiedReadMethod.h>

Inheritance diagram for mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >:

Classes
class	ConditionalCast
class	ConditionalCast< true, false, dummy >
class	ConditionalCast< false, true, dummy >
class	ConditionalCast< true, true, dummy >

Public Types
typedef mtsCallableQualifiedReadBase	BaseType
typedef _argumentType	ArgumentType
typedef _resultType	ResultType
typedef _classType	ClassType
typedef mtsCallableQualifiedReadMethod< ClassType, ArgumentType, ResultType >	ThisType
typedef bool(_classType::*)	ActionType(const ArgumentType &argument, ResultType &result) const

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

Protected Attributes
ActionType	Action
ClassType *	ClassInstantiation

Member Typedef Documentation

ActionType

template<class _classType, class _argumentType, class _resultType>

typedef bool(_classType::*) mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >::ActionType(const ArgumentType &argument, ResultType &result) const

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

ArgumentType

template<class _classType, class _argumentType, class _resultType>

typedef _argumentType mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >::ArgumentType

BaseType

template<class _classType, class _argumentType, class _resultType>

typedef mtsCallableQualifiedReadBase mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >::BaseType

ClassType

template<class _classType, class _argumentType, class _resultType>

typedef _classType mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >::ClassType

Typedef for the specific interface.

ResultType

template<class _classType, class _argumentType, class _resultType>

typedef _resultType mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >::ResultType

ThisType

template<class _classType, class _argumentType, class _resultType>

typedef mtsCallableQualifiedReadMethod<ClassType, ArgumentType, ResultType> mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >::ThisType

This type.

Constructor & Destructor Documentation

mtsCallableQualifiedReadMethod() [1/2]

template<class _classType, class _argumentType, class _resultType>

mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >::mtsCallableQualifiedReadMethod ( void )

inline

The constructor. Does nothing.

mtsCallableQualifiedReadMethod() [2/2]

template<class _classType, class _argumentType, class _resultType>

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

~mtsCallableQualifiedReadMethod()

template<class _classType, class _argumentType, class _resultType>

virtual mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >::~mtsCallableQualifiedReadMethod ( )

inlinevirtual

The destructor. Does nothing

Member Function Documentation

Execute()

template<class _classType, class _argumentType, class _resultType>

mtsExecutionResult mtsCallableQualifiedReadMethod< _classType, _argumentType, _resultType >::Execute ( const mtsGenericObject & argument, mtsGenericObject & result )

inlinevirtual

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

Implements mtsCallableQualifiedReadBase.

ToStream()

template<class _classType, class _argumentType, class _resultType>

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

inlinevirtual

Human readable description

Implements mtsCallableQualifiedReadBase.

Member Data Documentation

Action

template<class _classType, class _argumentType, class _resultType>

ActionType mtsCallableQualifiedReadMethod< _classType, _argumentType, _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 _argumentType, class _resultType>

ClassType* mtsCallableQualifiedReadMethod< _classType, _argumentType, _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/mtsCallableQualifiedReadMethod.h