cisst-saw
Loading...
Searching...
No Matches
mtsCallableQualifiedReadMethodGeneric< _classType > Class Template Reference

#include <mtsCallableQualifiedReadMethod.h>

Inheritance diagram for mtsCallableQualifiedReadMethodGeneric< _classType >:
mtsCallableQualifiedReadBase

Public Types

typedef mtsCallableQualifiedReadBase BaseType
typedef _classType ClassType
typedef mtsCallableQualifiedReadMethodGeneric< ClassTypeThisType
typedef bool(_classType::*) ActionType(const mtsGenericObject &argument, mtsGenericObject &result) const

Public Member Functions

 mtsCallableQualifiedReadMethodGeneric (void)
 mtsCallableQualifiedReadMethodGeneric (ActionType action, ClassType *classInstantiation)
virtual ~mtsCallableQualifiedReadMethodGeneric ()
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
ClassTypeClassInstantiation

Member Typedef Documentation

◆ ActionType

template<class _classType>
typedef bool(_classType::*) mtsCallableQualifiedReadMethodGeneric< _classType >::ActionType(const mtsGenericObject &argument, mtsGenericObject &result) const

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

◆ BaseType

template<class _classType>
typedef mtsCallableQualifiedReadBase mtsCallableQualifiedReadMethodGeneric< _classType >::BaseType

◆ ClassType

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

Typedef for the specific interface.

◆ ThisType

This type.

Constructor & Destructor Documentation

◆ mtsCallableQualifiedReadMethodGeneric() [1/2]

template<class _classType>
mtsCallableQualifiedReadMethodGeneric< _classType >::mtsCallableQualifiedReadMethodGeneric ( void )
inline

The constructor. Does nothing.

◆ mtsCallableQualifiedReadMethodGeneric() [2/2]

template<class _classType>
mtsCallableQualifiedReadMethodGeneric< _classType >::mtsCallableQualifiedReadMethodGeneric ( ActionType action,
ClassType * classInstantiation )
inline

The constructor.

Parameters
actionPointer to the member function that is to be called by the invoker of the command
classInstantiationPointer to the receiver of the command

◆ ~mtsCallableQualifiedReadMethodGeneric()

template<class _classType>
virtual mtsCallableQualifiedReadMethodGeneric< _classType >::~mtsCallableQualifiedReadMethodGeneric ( )
inlinevirtual

The destructor. Does nothing

Member Function Documentation

◆ Execute()

template<class _classType>
mtsExecutionResult mtsCallableQualifiedReadMethodGeneric< _classType >::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>
void mtsCallableQualifiedReadMethodGeneric< _classType >::ToStream ( std::ostream & outputStream) const
inlinevirtual

Human readable description

Implements mtsCallableQualifiedReadBase.

Member Data Documentation

◆ Action

template<class _classType>
ActionType mtsCallableQualifiedReadMethodGeneric< _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* mtsCallableQualifiedReadMethodGeneric< _classType >::ClassInstantiation
protected

Stores the receiver object of the command.


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