mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType > Class Template Reference

#include <mtsCallableWriteReturnMethod.h>

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

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

Public Types
typedef mtsCallableWriteReturnBase	BaseType
typedef _argumentType	ArgumentType
typedef _resultType	ResultType
typedef _classType	ClassType
typedef mtsCallableWriteReturnMethod< ClassType, ArgumentType, ResultType >	ThisType
typedef void(_classType::*)	ActionType(const ArgumentType &argument, ResultType &result)

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

Protected Attributes
ActionType	Action
ClassType *	ClassInstantiation

Member Typedef Documentation

ActionType

template<class _classType, class _argumentType, class _resultType>

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

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

ArgumentType

template<class _classType, class _argumentType, class _resultType>

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

BaseType

template<class _classType, class _argumentType, class _resultType>

typedef mtsCallableWriteReturnBase mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::BaseType

ClassType

template<class _classType, class _argumentType, class _resultType>

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

Typedef for the specific interface.

ResultType

template<class _classType, class _argumentType, class _resultType>

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

ThisType

template<class _classType, class _argumentType, class _resultType>

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

This type.

Constructor & Destructor Documentation

mtsCallableWriteReturnMethod() [1/2]

template<class _classType, class _argumentType, class _resultType>

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

inline

The constructor. Does nothing.

mtsCallableWriteReturnMethod() [2/2]

template<class _classType, class _argumentType, class _resultType>

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

~mtsCallableWriteReturnMethod()

template<class _classType, class _argumentType, class _resultType>

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

inlinevirtual

The destructor. Does nothing

Member Function Documentation

Execute()

template<class _classType, class _argumentType, class _resultType>

mtsExecutionResult mtsCallableWriteReturnMethod< _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 mtsCallableWriteReturnBase.

ToStream()

template<class _classType, class _argumentType, class _resultType>

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

inlinevirtual

Human readable description

Implements mtsCallableWriteReturnBase.

Member Data Documentation

Action

template<class _classType, class _argumentType, class _resultType>

ActionType mtsCallableWriteReturnMethod< _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* mtsCallableWriteReturnMethod< _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/mtsCallableWriteReturnMethod.h