ERC CISST - cisst software

---

mtsCommandWriteProxy Class Reference
[Multi Task Support]

#include <mtsCommandWriteProxy.h>

Inheritance diagram for mtsCommandWriteProxy:

[legend]Collaboration diagram for mtsCommandWriteProxy:

[legend]List of all members.

---

Detailed Description

mtsCommandWriteProxy is a proxy class for mtsCommandWrite. When Execute() method is called, the command id with payload is sent to the connected peer interface across a network.

Definition at line 42 of file mtsCommandWriteProxy.h.

Public Types

• typedef mtsCommandWriteBase BaseType

Public Member Functions

• mtsCommandWriteProxy (const std::string &commandName)
• void SetCommandID (const CommandIDType &commandID)
• void SetArgumentPrototype (mtsGenericObject *argumentPrototype)
• mtsExecutionResult Execute (const mtsGenericObject &argument, mtsBlockingType blocking)
• mtsProxySerializer * GetSerializer ()
• void ToStream (std::ostream &outputStream) const

Protected Attributes

• mtsProxySerializer Serializer

Friends

• class mtsComponentProxy
• class mtsMulticastCommandWriteBase

---

Member Typedef Documentation

typedef mtsCommandWriteBase mtsCommandWriteProxy::BaseType

Typedef for base type

Reimplemented from mtsCommandWriteBase.

Definition at line 53 of file mtsCommandWriteProxy.h.

---

Constructor & Destructor Documentation

mtsCommandWriteProxy::mtsCommandWriteProxy

(

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 57 of file mtsCommandWriteProxy.h.

References mtsCommandBase::Disable().

---

Member Function Documentation

void mtsCommandWriteProxy::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 63 of file mtsCommandWriteProxy.h.

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

void mtsCommandWriteProxy::SetArgumentPrototype

(

mtsGenericObject *

argumentPrototype

)

[inline]

Set an argument prototype

Definition at line 74 of file mtsCommandWriteProxy.h.

References mtsCommandWriteBase::ArgumentPrototype.

mtsExecutionResult mtsCommandWriteProxy::Execute	(	const mtsGenericObject &	argument,
		mtsBlockingType	blocking
	)			[inline, virtual]

Direct execute can be used for mtsMulticastCommandWrite.

Implements mtsCommandWriteBase.

Definition at line 79 of file mtsCommandWriteProxy.h.

References mtsCommandProxyBase::ClientID, mtsCommandProxyBase::CommandID, mtsCommandBase::IsDisabled(), mtsCommandProxyBase::NetworkProxyClient, mtsCommandProxyBase::NetworkProxyServer, mtsComponentInterfaceProxyServer::SendExecuteCommandWriteSerialized(), and mtsComponentInterfaceProxyClient::SendExecuteEventWriteSerialized().

mtsProxySerializer* mtsCommandWriteProxy::GetSerializer

(

)

[inline]

Getter for per-command (de)serializer

Definition at line 99 of file mtsCommandWriteProxy.h.

References Serializer.

void mtsCommandWriteProxy::ToStream

(

std::ostream &

outputStream

)

const [inline, virtual]

Generate human readable description of this object

Implements mtsCommandBase.

Definition at line 104 of file mtsCommandWriteProxy.h.

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

---

Member Data Documentation

mtsProxySerializer mtsCommandWriteProxy::Serializer [protected]

Per-command (de)serializer

Definition at line 49 of file mtsCommandWriteProxy.h.

Referenced by GetSerializer(), and SetCommandID().

---

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

• mtsCommandWriteProxy.h

---