ERC CISST - cisst software

---

mtsCommandProxyBase Class Reference

Inheritance diagram for mtsCommandProxyBase:

[legend]Collaboration diagram for mtsCommandProxyBase:

[legend]List of all members.

---

Detailed Description

Definition at line 30 of file mtsCommandProxyBase.h.

Public Member Functions

• mtsCommandProxyBase ()
• bool SetNetworkProxy (mtsProxyBaseCommon< mtsComponentProxy > *networkProxy, const mtsComponentInterfaceProxyServer::ClientIDType clientID=0)
• virtual void SetCommandID (const CommandIDType &commandID)
• void ToStreamBase (const std::string &className, const std::string &commandName, const CommandIDType &commandID, const bool enabled, std::ostream &outputStream) const

Protected Attributes

• CommandIDType CommandID
• mtsComponentInterfaceProxyServer::ClientIDType ClientID
• mtsProxyBaseCommon< mtsComponentProxy > * NetworkProxy
• mtsComponentInterfaceProxyClient * NetworkProxyClient
• mtsComponentInterfaceProxyServer * NetworkProxyServer

---

Constructor & Destructor Documentation

mtsCommandProxyBase::mtsCommandProxyBase

(

)

[inline]

Constructor

Definition at line 50 of file mtsCommandProxyBase.h.

---

Member Function Documentation

bool mtsCommandProxyBase::SetNetworkProxy	(	mtsProxyBaseCommon< mtsComponentProxy > *	networkProxy,
		const mtsComponentInterfaceProxyServer::ClientIDType	clientID = 0
	)			[inline]

Set network proxy

Definition at line 54 of file mtsCommandProxyBase.h.

References ClientID, NetworkProxyClient, and NetworkProxyServer.

virtual void mtsCommandProxyBase::SetCommandID

(

const CommandIDType &

commandID

)

[inline, virtual]

Set command id

Definition at line 64 of file mtsCommandProxyBase.h.

References CommandID.

Referenced by mtsCommandWriteProxy::SetCommandID(), mtsCommandReadProxy::SetCommandID(), and mtsCommandQualifiedReadProxy::SetCommandID().

void mtsCommandProxyBase::ToStreamBase	(	const std::string &	className,
		const std::string &	commandName,
		const CommandIDType &	commandID,
		const bool	enabled,
		std::ostream &	outputStream
	)			const [inline]

Generate human readable description of this object

Definition at line 69 of file mtsCommandProxyBase.h.

References NetworkProxyClient, and NetworkProxyServer.

Referenced by mtsCommandVoidProxy::ToStream(), mtsCommandQualifiedReadProxy::ToStream(), mtsCommandReadProxy::ToStream(), and mtsCommandWriteProxy::ToStream().

---

Member Data Documentation

CommandIDType mtsCommandProxyBase::CommandID [protected]

Pointer to mtsFunctionXXX object at the peer's memory space

Definition at line 33 of file mtsCommandProxyBase.h.

Referenced by mtsCommandVoidProxy::Execute(), mtsCommandQualifiedReadProxy::Execute(), mtsCommandReadProxy::Execute(), mtsCommandWriteProxy::Execute(), mtsCommandWriteProxy::SetCommandID(), mtsCommandReadProxy::SetCommandID(), mtsCommandQualifiedReadProxy::SetCommandID(), SetCommandID(), mtsCommandVoidProxy::ToStream(), mtsCommandQualifiedReadProxy::ToStream(), mtsCommandReadProxy::ToStream(), and mtsCommandWriteProxy::ToStream().

mtsComponentInterfaceProxyServer::ClientIDType mtsCommandProxyBase::ClientID [protected]

Client ID

Definition at line 36 of file mtsCommandProxyBase.h.

Referenced by mtsCommandVoidProxy::Execute(), mtsCommandQualifiedReadProxy::Execute(), mtsCommandReadProxy::Execute(), mtsCommandWriteProxy::Execute(), and SetNetworkProxy().

mtsProxyBaseCommon<mtsComponentProxy>* mtsCommandProxyBase::NetworkProxy [protected]

Network (ICE) proxy which enables communication with the connected interface across a network. This is of type either mtsComponentInterfaceProxyClient or mtsComponentInterfaceProxyServer

Definition at line 41 of file mtsCommandProxyBase.h.

mtsComponentInterfaceProxyClient* mtsCommandProxyBase::NetworkProxyClient [protected]

Actual pointer to network proxy. Either one of them should be set and the other one should be NULL.

Definition at line 45 of file mtsCommandProxyBase.h.

Referenced by mtsCommandVoidProxy::Execute(), mtsCommandWriteProxy::Execute(), mtsCommandWriteProxy::SetCommandID(), SetNetworkProxy(), and ToStreamBase().

---

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

• mtsCommandProxyBase.h

---