cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType > Class Template Reference
cisstMultiTask

#include <mtsCallableWriteReturnMethod.h>

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

Classes

class  ConditionalCast
 
class  ConditionalCast< false, true, dummy >
 
class  ConditionalCast< true, false, 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

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).

template<class _classType , class _argumentType , class _resultType >
typedef _argumentType mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::ArgumentType
template<class _classType , class _argumentType , class _resultType >
typedef mtsCallableWriteReturnBase mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::BaseType
template<class _classType , class _argumentType , class _resultType >
typedef _classType mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::ClassType

Typedef for the specific interface.

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

This type.

Constructor & Destructor Documentation

template<class _classType , class _argumentType , class _resultType >
mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::mtsCallableWriteReturnMethod ( void  )
inline

The constructor. Does nothing.

template<class _classType , class _argumentType , class _resultType >
mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::mtsCallableWriteReturnMethod ( 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
template<class _classType , class _argumentType , class _resultType >
virtual mtsCallableWriteReturnMethod< _classType, _argumentType, _resultType >::~mtsCallableWriteReturnMethod ( )
inlinevirtual

The destructor. Does nothing

Member Function Documentation

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.

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

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.

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:
Generated by   doxygen 1.8.6