ERC CISST - cisst software

---

mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type > Class Template Reference
[Multi Task Support]

#include <mtsCommandQualifiedRead.h>

Inheritance diagram for mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >:

[legend]Collaboration diagram for mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >:

[legend]List of all members.

---

Detailed Description

template<class _classType, class _argument1Type, class _argument2Type>
class mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >

A templated version of command object with one argument for execute. The template argument is the interface type whose method is contained in the command object.

Definition at line 42 of file mtsCommandQualifiedRead.h.

Public Types

• typedef _argument1Type Argument1Type
• typedef _argument2Type Argument2Type
• typedef mtsCommandQualifiedReadBase BaseType
• typedef _classType ClassType
• typedef mtsCommandQualifiedRead<
  ClassType, Argument1Type,
  Argument2Type > ThisType
• typedef void(_classType::*) ActionTypeOld (const Argument1Type &, Argument2Type &) const
• typedef bool(_classType::*) ActionType (const Argument1Type &, Argument2Type &) const

Public Member Functions

• mtsCommandQualifiedRead (void)
• mtsCommandQualifiedRead (ActionType action, ClassType *classInstantiation, const std::string &name, const Argument1Type &argument1Prototype, const Argument2Type &argument2Prototype)
• mtsCommandQualifiedRead (ActionTypeOld action, ClassType *classInstantiation, const std::string &name, const Argument1Type &argument1Prototype, const Argument2Type &argument2Prototype)
• virtual ~mtsCommandQualifiedRead ()
• virtual mtsExecutionResult Execute (const mtsGenericObject &argument1, mtsGenericObject &argument2)
• const mtsGenericObject * GetArgument1Prototype (void) const
• const mtsGenericObject * GetArgument2Prototype (void) const
• void ToStream (std::ostream &outputStream) const

Protected Attributes

• ActionType Action
• ActionTypeOld ActionOld
• ClassType * ClassInstantiation
• mtsGenericObject * Argument1Prototype
• mtsGenericObject * Argument2Prototype

Classes

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

---

Member Typedef Documentation

template<class _classType, class _argument1Type, class _argument2Type>

typedef _classType mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ClassType

Typedef for the specific interface.

Definition at line 49 of file mtsCommandQualifiedRead.h.

template<class _classType, class _argument1Type, class _argument2Type>

typedef mtsCommandQualifiedRead<ClassType, Argument1Type, Argument2Type> mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ThisType

This type.

Definition at line 52 of file mtsCommandQualifiedRead.h.

template<class _classType, class _argument1Type, class _argument2Type>

typedef void(_classType::*) mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ActionTypeOld(const Argument1Type &, Argument2Type &) const

Typedef for pointer to member function of the specific interface class.

Definition at line 56 of file mtsCommandQualifiedRead.h.

---

Constructor & Destructor Documentation

template<class _classType, class _argument1Type, class _argument2Type>

mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::mtsCommandQualifiedRead

(

void

)

[inline]

The constructor. Does nothing

Definition at line 238 of file mtsCommandQualifiedRead.h.

template<class _classType, class _argument1Type, class _argument2Type>

mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::mtsCommandQualifiedRead	(	ActionType	action,
		ClassType *	classInstantiation,
		const std::string &	name,
		const Argument1Type &	argument1Prototype,
		const Argument2Type &	argument2Prototype
	)			[inline]

The constructor.

Parameters:

	action	Pointer to the member function that is to be called by the invoker of the command
	interface	Pointer to the receiver of the command
	name	A string to identify the command.

Definition at line 246 of file mtsCommandQualifiedRead.h.

References mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Argument1Prototype, mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Argument2Prototype, and mtsGenericTypes< T >::ConditionalCreate().

template<class _classType, class _argument1Type, class _argument2Type>

virtual mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::~mtsCommandQualifiedRead

(

)

[inline, virtual]

The destructor. Does nothing

Definition at line 272 of file mtsCommandQualifiedRead.h.

---

Member Function Documentation

template<class _classType, class _argument1Type, class _argument2Type>

virtual mtsExecutionResult mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Execute	(	const mtsGenericObject &	argument1,
		mtsGenericObject &	argument2
	)			[inline, virtual]

The execute method. Calling the execute method from the invoker applies the operation on the receiver.

Parameters:

obj

The data passed to the operation method

Implements mtsCommandQualifiedReadBase.

Definition at line 279 of file mtsCommandQualifiedRead.h.

References mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Action, mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ActionOld, and mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ClassInstantiation.

template<class _classType, class _argument1Type, class _argument2Type>

const mtsGenericObject* mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::GetArgument1Prototype

(

void

)

const [inline, virtual]

Return a pointer on the argument 1 prototype

Implements mtsCommandQualifiedReadBase.

Definition at line 289 of file mtsCommandQualifiedRead.h.

References mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Argument1Prototype.

template<class _classType, class _argument1Type, class _argument2Type>

const mtsGenericObject* mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::GetArgument2Prototype

(

void

)

const [inline, virtual]

Return a pointer on the argument 2 prototype

Implements mtsCommandQualifiedReadBase.

Definition at line 294 of file mtsCommandQualifiedRead.h.

References mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Argument2Prototype.

template<class _classType, class _argument1Type, class _argument2Type>

void mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

For debugging. Generate a human readable output for the command object

Implements mtsCommandQualifiedReadBase.

Definition at line 299 of file mtsCommandQualifiedRead.h.

References mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Argument1Prototype, mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Argument2Prototype, cmnClassServicesBase::GetName(), mtsCommandBase::IsEnabled(), mtsObjectName(), mtsCommandBase::Name, and cmnGenericObject::Services().

---

Member Data Documentation

template<class _classType, class _argument1Type, class _argument2Type>

ActionType mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Action [protected]

The pointer to member function of the receiver class that is to be invoked for a particular instance of the command

Definition at line 67 of file mtsCommandQualifiedRead.h.

Referenced by mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Execute().

template<class _classType, class _argument1Type, class _argument2Type>

ClassType* mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ClassInstantiation [protected]

Stores the receiver object of the command

Definition at line 71 of file mtsCommandQualifiedRead.h.

Referenced by mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Execute().

template<class _classType, class _argument1Type, class _argument2Type>

mtsGenericObject* mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Argument1Prototype [protected]

Argument 1 prototype

Definition at line 74 of file mtsCommandQualifiedRead.h.

Referenced by mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::GetArgument1Prototype(), mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::mtsCommandQualifiedRead(), and mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ToStream().

template<class _classType, class _argument1Type, class _argument2Type>

mtsGenericObject* mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::Argument2Prototype [protected]

Argument 2 prototype

Definition at line 77 of file mtsCommandQualifiedRead.h.

Referenced by mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::GetArgument2Prototype(), mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::mtsCommandQualifiedRead(), and mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >::ToStream().

---

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

• mtsCommandQualifiedRead.h

---