ERC CISST - cisst software

---

mtsCommandQualifiedReadBase Class Reference
[Multi Task Support]

#include <mtsCommandQualifiedReadBase.h>

Inheritance diagram for mtsCommandQualifiedReadBase:

[legend]Collaboration diagram for mtsCommandQualifiedReadBase:

[legend]List of all members.

---

Detailed Description

A base class of command object with an execute method that takes one argument. The type of argument is defined by a template parameter. This allows to use the same base class for const and non-const object references.

Definition at line 46 of file mtsCommandQualifiedReadBase.h.

Public Types

• typedef mtsCommandBase BaseType
• typedef const mtsGenericObject Argument1Type
• typedef mtsGenericObject Argument2Type

Public Member Functions

• mtsCommandQualifiedReadBase (void)
• mtsCommandQualifiedReadBase (const std::string &name)
• virtual ~mtsCommandQualifiedReadBase ()
• virtual mtsExecutionResult Execute (Argument1Type &argument1, Argument2Type &argument2)=0
• virtual void ToStream (std::ostream &outputStream) const=0
• size_t NumberOfArguments (void) const
• bool Returns (void) const
• virtual const mtsGenericObject * GetArgument1Prototype (void) const=0
• const cmnClassServicesBase * GetArgument1ClassServices (void) const
• virtual const mtsGenericObject * GetArgument2Prototype (void) const=0
• const cmnClassServicesBase * GetArgument2ClassServices (void) const

---

Constructor & Destructor Documentation

mtsCommandQualifiedReadBase::mtsCommandQualifiedReadBase

(

void

)

[inline]

The constructor. Does nothing

Definition at line 53 of file mtsCommandQualifiedReadBase.h.

virtual mtsCommandQualifiedReadBase::~mtsCommandQualifiedReadBase

(

)

[inline, virtual]

The destructor. Does nothing

Definition at line 62 of file mtsCommandQualifiedReadBase.h.

---

Member Function Documentation

virtual mtsExecutionResult mtsCommandQualifiedReadBase::Execute	(	Argument1Type &	argument1,
		Argument2Type &	argument2
	)			[pure virtual]

The execute method. Abstract method to be implemented by derived classes to run the actual operation on the receiver

Parameters:

obj

The data passed to the operation method

Returns:

Boolean value, true if success, false otherwise

Referenced by mtsFunctionQualifiedRead::ConditionalWrap< _userType1, _userType2, a, b >::Call(), mtsFunctionQualifiedRead::ConditionalWrap< _userType1, _userType2, false, true >::Call(), mtsFunctionQualifiedRead::ConditionalWrap< _userType1, _userType2, true, false >::Call(), and mtsFunctionQualifiedRead::ConditionalWrap< _userType1, _userType2, true, true >::Call().

virtual void mtsCommandQualifiedReadBase::ToStream

(

std::ostream &

outputStream

)

const [pure virtual]

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

Implements mtsCommandBase.

Implemented in mtsCommandQualifiedRead< _classType, _argument1Type, _argument2Type >, and mtsCommandQualifiedReadProxy.

size_t mtsCommandQualifiedReadBase::NumberOfArguments

(

void

)

const [inline, virtual]

Returns number of arguments (parameters) expected by Execute method. Must be overloaded in derived classes.

Implements mtsCommandBase.

Definition at line 76 of file mtsCommandQualifiedReadBase.h.

bool mtsCommandQualifiedReadBase::Returns

(

void

)

const [inline, virtual]

documented in base class

Implements mtsCommandBase.

Definition at line 81 of file mtsCommandQualifiedReadBase.h.

virtual const mtsGenericObject* mtsCommandQualifiedReadBase::GetArgument1Prototype

(

void

)

const [pure virtual]

Return a pointer on the argument 1 prototype

Referenced by GetArgument1ClassServices().

const cmnClassServicesBase* mtsCommandQualifiedReadBase::GetArgument1ClassServices

(

void

)

const [inline]

Return const pointer of class services associated to the argument type.

Definition at line 90 of file mtsCommandQualifiedReadBase.h.

References GetArgument1Prototype(), and cmnGenericObject::Services().

virtual const mtsGenericObject* mtsCommandQualifiedReadBase::GetArgument2Prototype

(

void

)

const [pure virtual]

Return a pointer on the argument 2 prototype

Referenced by GetArgument2ClassServices().

const cmnClassServicesBase* mtsCommandQualifiedReadBase::GetArgument2ClassServices

(

void

)

const [inline]

Return const pointer of class services associated to the argument type.

Definition at line 99 of file mtsCommandQualifiedReadBase.h.

References GetArgument2Prototype(), and cmnGenericObject::Services().

---

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

• mtsCommandQualifiedReadBase.h

---