ERC CISST - cisst software

---

mtsCommandWrite< _classType, _argumentType > Class Template Reference
[Multi Task Support]

#include <mtsCommandWrite.h>

Inheritance diagram for mtsCommandWrite< _classType, _argumentType >:

[legend]Collaboration diagram for mtsCommandWrite< _classType, _argumentType >:

[legend]List of all members.

---

Detailed Description

template<class _classType, class _argumentType>
class mtsCommandWrite< _classType, _argumentType >

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

Public Types

• typedef _argumentType ArgumentType
• typedef mtsCommandWriteBase BaseType
• typedef _classType ClassType
• typedef mtsCommandWrite< ClassType,
  ArgumentType > ThisType
• typedef void(_classType::*) ActionType (const ArgumentType &)

Public Member Functions

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

Protected Attributes

• ActionType Action
• ClassType * ClassInstantiation

Classes

• class ConditionalCast
• class ConditionalCast< true, dummy >

---

Member Typedef Documentation

template<class _classType, class _argumentType>

typedef _classType mtsCommandWrite< _classType, _argumentType >::ClassType

Typedef for the specific interface.

Definition at line 50 of file mtsCommandWrite.h.

template<class _classType, class _argumentType>

typedef mtsCommandWrite<ClassType, ArgumentType> mtsCommandWrite< _classType, _argumentType >::ThisType

This type.

Definition at line 53 of file mtsCommandWrite.h.

template<class _classType, class _argumentType>

typedef void(_classType::*) mtsCommandWrite< _classType, _argumentType >::ActionType(const ArgumentType &)

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

Definition at line 57 of file mtsCommandWrite.h.

---

Constructor & Destructor Documentation

template<class _classType, class _argumentType>

mtsCommandWrite< _classType, _argumentType >::mtsCommandWrite	(	ActionType	action,
		ClassType *	classInstantiation,
		const std::string &	name,
		const ArgumentType &	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 127 of file mtsCommandWrite.h.

References mtsCommandWriteBase::ArgumentPrototype, and mtsGenericTypes< T >::ConditionalCreate().

template<class _classType, class _argumentType>

virtual mtsCommandWrite< _classType, _argumentType >::~mtsCommandWrite

(

)

[inline, virtual]

The destructor. Does nothing

Definition at line 140 of file mtsCommandWrite.h.

References mtsCommandWriteBase::ArgumentPrototype.

---

Member Function Documentation

template<class _classType, class _argumentType>

virtual mtsExecutionResult mtsCommandWrite< _classType, _argumentType >::Execute	(	const mtsGenericObject &	argument,
		mtsBlockingType	CMN_UNUSED(blocking)
	)			[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

Definition at line 151 of file mtsCommandWrite.h.

References mtsCommandWrite< _classType, _argumentType >::Action, and mtsCommandWrite< _classType, _argumentType >::ClassInstantiation.

template<class _classType, class _argumentType>

mtsExecutionResult mtsCommandWrite< _classType, _argumentType >::Execute	(	const ArgumentType &	argument,
		mtsBlockingType	CMN_UNUSED(blocking)
	)			[inline]

Direct execute can be used for mtsMulticastCommandWrite

Definition at line 162 of file mtsCommandWrite.h.

References mtsCommandWrite< _classType, _argumentType >::Action, and mtsCommandWrite< _classType, _argumentType >::ClassInstantiation.

template<class _classType, class _argumentType>

virtual void mtsCommandWrite< _classType, _argumentType >::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

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

Implements mtsCommandBase.

Definition at line 172 of file mtsCommandWrite.h.

References mtsCommandWriteBase::ArgumentPrototype, cmnClassServicesBase::GetName(), mtsCommandBase::IsEnabled(), mtsObjectName(), mtsCommandBase::Name, and cmnGenericObject::Services().

---

Member Data Documentation

template<class _classType, class _argumentType>

ActionType mtsCommandWrite< _classType, _argumentType >::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 66 of file mtsCommandWrite.h.

Referenced by mtsCommandWrite< _classType, _argumentType >::Execute().

template<class _classType, class _argumentType>

ClassType* mtsCommandWrite< _classType, _argumentType >::ClassInstantiation [protected]

Stores the receiver object of the command

Definition at line 69 of file mtsCommandWrite.h.

Referenced by mtsCommandWrite< _classType, _argumentType >::Execute().

---

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

• mtsCommandWrite.h

---