ERC CISST - cisst software

mtsCommandReadProxy Class Reference
[Multi Task Support]

#include <mtsCommandReadProxy.h>

Inheritance diagram for mtsCommandReadProxy:

Inheritance graph
[legend]
Collaboration diagram for mtsCommandReadProxy:

Collaboration graph
[legend]
List of all members.

Detailed Description

mtsCommandReadProxy is a proxy for mtsCommandRead. 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 mtsCommandReadProxy.h.

Public Types

Public Member Functions

Protected Attributes

Friends

Member Typedef Documentation

typedef mtsCommandRead mtsCommandReadProxy::BaseType

Typedef for base type

Reimplemented from mtsCommandRead.

Definition at line 52 of file mtsCommandReadProxy.h.

Constructor & Destructor Documentation

mtsCommandReadProxy::mtsCommandReadProxy ( 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 56 of file mtsCommandReadProxy.h.

References mtsCommandBase::Disable().

Member Function Documentation

void mtsCommandReadProxy::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 62 of file mtsCommandReadProxy.h.

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

void mtsCommandReadProxy::SetArgumentPrototype ( mtsGenericObject *  argumentPrototype  )  [inline]

Set an argument prototype

Definition at line 71 of file mtsCommandReadProxy.h.

References mtsCommandRead::ArgumentPrototype.

virtual mtsExecutionResult mtsCommandReadProxy::Execute ( mtsGenericObject &  argument  )  [inline, virtual]

The execute method.

Reimplemented from mtsCommandRead.

Definition at line 76 of file mtsCommandReadProxy.h.

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

void mtsCommandReadProxy::ToStream ( std::ostream &  outputStream  )  const [inline, virtual]

Generate human readable description of this object

Reimplemented from mtsCommandRead.

Definition at line 90 of file mtsCommandReadProxy.h.

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

Member Data Documentation

mtsProxySerializer mtsCommandReadProxy::Serializer [protected]

Per-command serializer and deserializer

Definition at line 48 of file mtsCommandReadProxy.h.

Referenced by SetCommandID().

The documentation for this class was generated from the following file:
erc-cisst-devel<at>lists.johnshopkins.edu