ERC CISST - cisst software

---

mtsCommandWriteBase Class Reference
[Multi Task Support]

#include <mtsCommandWriteBase.h>

Inheritance diagram for mtsCommandWriteBase:

[legend]Collaboration diagram for mtsCommandWriteBase:

[legend]List of all members.

---

Detailed Description

A base class of command object with an execute method that takes one argument.

Definition at line 43 of file mtsCommandWriteBase.h.

Public Types

• typedef mtsCommandBase BaseType

Public Member Functions

• mtsCommandWriteBase (void)
• mtsCommandWriteBase (const std::string &name)
• virtual ~mtsCommandWriteBase ()
• virtual mtsExecutionResult Execute (const mtsGenericObject &argument, mtsBlockingType blocking)=0
• size_t NumberOfArguments (void) const
• bool Returns (void) const
• virtual const mtsGenericObject * GetArgumentPrototype (void) const
• const cmnClassServicesBase * GetArgumentClassServices (void) const

Protected Member Functions

• virtual void SetArgumentPrototype (const mtsGenericObject *argumentPrototype)

Protected Attributes

• const mtsGenericObject * ArgumentPrototype

Friends

• class mtsMulticastCommandWriteBase
• class mtsCommandQueuedWriteGeneric

---

Constructor & Destructor Documentation

mtsCommandWriteBase::mtsCommandWriteBase

(

void

)

[inline]

The constructor. Does nothing

Definition at line 52 of file mtsCommandWriteBase.h.

virtual mtsCommandWriteBase::~mtsCommandWriteBase

(

)

[inline, virtual]

The destructor. Does nothing

Definition at line 63 of file mtsCommandWriteBase.h.

---

Member Function Documentation

virtual mtsExecutionResult mtsCommandWriteBase::Execute	(	const mtsGenericObject &	argument,
		mtsBlockingType	blocking
	)			[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 mtsFunctionWrite::ConditionalWrap< _userType, >::Call(), and mtsFunctionWrite::ConditionalWrap< _userType, true >::Call().

size_t mtsCommandWriteBase::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 74 of file mtsCommandWriteBase.h.

virtual const mtsGenericObject* mtsCommandWriteBase::GetArgumentPrototype

(

void

)

const [inline, virtual]

Return a pointer on the argument prototype

Definition at line 84 of file mtsCommandWriteBase.h.

References ArgumentPrototype.

Referenced by GetArgumentClassServices(), and mtsCommandQueuedWrite< _argumentType >::GetArgumentPrototype().

const cmnClassServicesBase* mtsCommandWriteBase::GetArgumentClassServices

(

void

)

const [inline]

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

Definition at line 90 of file mtsCommandWriteBase.h.

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

---

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

• mtsCommandWriteBase.h

---