ERC CISST - cisst software

---

mtsCommandQualifiedReadProxy Class Reference
[Multi Task Support]

#include <mtsCommandQualifiedReadProxy.h>

Inheritance diagram for mtsCommandQualifiedReadProxy:

[legend]Collaboration diagram for mtsCommandQualifiedReadProxy:

[legend]List of all members.

---

Detailed Description

mtsCommandQualifiedReadProxy is a proxy for mtsCommandQualifiedRead. When Execute() method is called, the command id with two payloads is sent to the connected peer interface across a network.

Definition at line 42 of file mtsCommandQualifiedReadProxy.h.

Public Types

• typedef mtsCommandQualifiedReadBase BaseType

Public Member Functions

• mtsCommandQualifiedReadProxy (const std::string &commandName)
• void SetCommandID (const CommandIDType &commandID)
• void SetArgumentPrototype (mtsGenericObject *argument1Prototype, mtsGenericObject *argument2Prototype)
• mtsExecutionResult Execute (const mtsGenericObject &argument1, mtsGenericObject &argument2)
• void ToStream (std::ostream &outputStream) const
• const mtsGenericObject * GetArgument1Prototype (void) const
• const mtsGenericObject * GetArgument2Prototype (void) const

Protected Attributes

• mtsProxySerializer Serializer
• mtsGenericObject * Argument1Prototype
• mtsGenericObject * Argument2Prototype

Friends

• class mtsComponentProxy

---

Member Typedef Documentation

typedef mtsCommandQualifiedReadBase mtsCommandQualifiedReadProxy::BaseType

Typedef for base type

Reimplemented from mtsCommandQualifiedReadBase.

Definition at line 56 of file mtsCommandQualifiedReadProxy.h.

---

Constructor & Destructor Documentation

mtsCommandQualifiedReadProxy::mtsCommandQualifiedReadProxy

(

const std::string &

commandName

)

[inline]

Constructor. Command proxy is disabled by defaultand is enabled when command id and network proxy are set.

Definition at line 60 of file mtsCommandQualifiedReadProxy.h.

References mtsCommandBase::Disable().

---

Member Function Documentation

void mtsCommandQualifiedReadProxy::SetCommandID

(

const CommandIDType &

commandID

)

[inline, virtual]

Set command id and register serializer to network proxy. This method should be called after SetNetworkProxy() is called.

Reimplemented from mtsCommandProxyBase.

Definition at line 66 of file mtsCommandQualifiedReadProxy.h.

References mtsComponentInterfaceProxyServer::AddPerCommandSerializer(), mtsCommandProxyBase::CommandID, mtsCommandProxyBase::NetworkProxyServer, Serializer, and mtsCommandProxyBase::SetCommandID().

void mtsCommandQualifiedReadProxy::SetArgumentPrototype	(	mtsGenericObject *	argument1Prototype,
		mtsGenericObject *	argument2Prototype
	)			[inline]

Set argument prototypes

Definition at line 75 of file mtsCommandQualifiedReadProxy.h.

References Argument1Prototype, and Argument2Prototype.

mtsExecutionResult mtsCommandQualifiedReadProxy::Execute	(	const mtsGenericObject &	argument1,
		mtsGenericObject &	argument2
	)			[inline, virtual]

The execute method.

Implements mtsCommandQualifiedReadBase.

Definition at line 81 of file mtsCommandQualifiedReadProxy.h.

References mtsCommandProxyBase::ClientID, mtsCommandProxyBase::CommandID, mtsCommandBase::IsDisabled(), mtsCommandProxyBase::NetworkProxyServer, and mtsComponentInterfaceProxyServer::SendExecuteCommandQualifiedReadSerialized().

void mtsCommandQualifiedReadProxy::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

Generate human readable description of this object

Implements mtsCommandQualifiedReadBase.

Definition at line 96 of file mtsCommandQualifiedReadProxy.h.

References mtsCommandProxyBase::CommandID, mtsCommandBase::IsEnabled(), mtsCommandBase::Name, and mtsCommandProxyBase::ToStreamBase().

const mtsGenericObject* mtsCommandQualifiedReadProxy::GetArgument1Prototype

(

void

)

const [inline, virtual]

Return a pointer on the argument prototype

Implements mtsCommandQualifiedReadBase.

Definition at line 101 of file mtsCommandQualifiedReadProxy.h.

References Argument1Prototype.

const mtsGenericObject* mtsCommandQualifiedReadProxy::GetArgument2Prototype

(

void

)

const [inline, virtual]

Return a pointer on the argument 2 prototype

Implements mtsCommandQualifiedReadBase.

Definition at line 105 of file mtsCommandQualifiedReadProxy.h.

References Argument2Prototype.

---

Member Data Documentation

mtsProxySerializer mtsCommandQualifiedReadProxy::Serializer [protected]

Per-command serializer and deserializer

Definition at line 48 of file mtsCommandQualifiedReadProxy.h.

Referenced by SetCommandID().

mtsGenericObject* mtsCommandQualifiedReadProxy::Argument1Prototype [protected]

Argument prototypes. Deserialization recovers the original argument prototype objects.

Definition at line 52 of file mtsCommandQualifiedReadProxy.h.

Referenced by GetArgument1Prototype(), and SetArgumentPrototype().

---

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

• mtsCommandQualifiedReadProxy.h

---