ERC CISST - cisst software

---

mtsCommandWriteGeneric< _classType > Class Template Reference

Inheritance diagram for mtsCommandWriteGeneric< _classType >:

[legend]Collaboration diagram for mtsCommandWriteGeneric< _classType >:

[legend]List of all members.

---

Detailed Description

template<class _classType>
class mtsCommandWriteGeneric< _classType >

Definition at line 191 of file mtsCommandWrite.h.

Public Types

• typedef mtsCommandWriteBase BaseType
• typedef _classType ClassType
• typedef mtsCommandWriteGeneric<
  ClassType > ThisType
• typedef void(_classType::*) ActionType (const mtsGenericObject &)

Public Member Functions

• mtsCommandWriteGeneric (ActionType action, ClassType *classInstantiation, const std::string &name, const mtsGenericObject *argumentPrototype)
• virtual ~mtsCommandWriteGeneric ()
• mtsExecutionResult Execute (const mtsGenericObject &argument, mtsBlockingType CMN_UNUSED(blocking))
• void ToStream (std::ostream &outputStream) const

Protected Attributes

• ActionType Action
• ClassType * ClassInstantiation

---

Member Typedef Documentation

template<class _classType>

typedef _classType mtsCommandWriteGeneric< _classType >::ClassType

Typedef for the specific interface.

Definition at line 197 of file mtsCommandWrite.h.

template<class _classType>

typedef mtsCommandWriteGeneric<ClassType> mtsCommandWriteGeneric< _classType >::ThisType

This type.

Definition at line 200 of file mtsCommandWrite.h.

template<class _classType>

typedef void(_classType::*) mtsCommandWriteGeneric< _classType >::ActionType(const mtsGenericObject &)

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

Definition at line 204 of file mtsCommandWrite.h.

---

Constructor & Destructor Documentation

template<class _classType>

mtsCommandWriteGeneric< _classType >::mtsCommandWriteGeneric	(	ActionType	action,
		ClassType *	classInstantiation,
		const std::string &	name,
		const mtsGenericObject *	argumentPrototype
	)			[inline]

The constructor.

FIXME: this needs to be updated.

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 231 of file mtsCommandWrite.h.

References mtsCommandWriteBase::ArgumentPrototype, CMN_ASSERT, cmnClassServicesBase::Create(), and cmnGenericObject::Services().

template<class _classType>

virtual mtsCommandWriteGeneric< _classType >::~mtsCommandWriteGeneric

(

)

[inline, virtual]

The destructor. Does nothing

Definition at line 250 of file mtsCommandWrite.h.

References mtsCommandWriteBase::ArgumentPrototype.

---

Member Function Documentation

template<class _classType>

mtsExecutionResult mtsCommandWriteGeneric< _classType >::Execute	(	const mtsGenericObject &	argument,
		mtsBlockingType	CMN_UNUSED(blocking)
	)			[inline]

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

Definition at line 261 of file mtsCommandWrite.h.

References mtsCommandWriteGeneric< _classType >::Action, and mtsCommandWriteGeneric< _classType >::ClassInstantiation.

template<class _classType>

void mtsCommandWriteGeneric< _classType >::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

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

Implements mtsCommandBase.

Definition at line 271 of file mtsCommandWrite.h.

References mtsCommandBase::IsEnabled(), mtsObjectName(), and mtsCommandBase::Name.

---

Member Data Documentation

template<class _classType>

ActionType mtsCommandWriteGeneric< _classType >::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 213 of file mtsCommandWrite.h.

Referenced by mtsCommandWriteGeneric< _classType >::Execute().

template<class _classType>

ClassType* mtsCommandWriteGeneric< _classType >::ClassInstantiation [protected]

Stores the receiver object of the command

Definition at line 216 of file mtsCommandWrite.h.

Referenced by mtsCommandWriteGeneric< _classType >::Execute().

---

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

• mtsCommandWrite.h

---