MAK RTIspy API Documentation for HLA 1516
Public Member Functions | Protected Attributes
DtRtiAssistantLrcClient Class Reference

The client connection to the RTI Assistant for an LRC. More...

+ Inheritance diagram for DtRtiAssistantLrcClient:
+ Collaboration diagram for DtRtiAssistantLrcClient:

List of all members.

Public Member Functions

 DtRtiAssistantLrcClient (int port=0)
virtual ~DtRtiAssistantLrcClient ()
virtual void updateLrcName (const MAKRti::DtString &name)
 Updates the name used by the Assistant to identify this LRC.
virtual void updateFederateName (const MAKRti::DtString &fedName)
 Updates the federate name used by the assistant.
virtual void updateFederationInfo (unsigned long federationHandle, const MAKRti::DtString &federationName, unsigned long fedHandle, DtHlaVersionId hlaVersion)
 Updates the federation name and federate handle used by the Assistant to help identify this LRC.
virtual void updateLrcLogFile (const MAKRti::DtFilename &file)
 Updates the log file name used by this LRC.
virtual void updateLicenseServer (const MAKRti::DtString &server)
 Updates the license server used by this LRC.
virtual void updateWebSpyInfo (const MAKRti::DtInetAddr &ipAddr, int port, int id)
 Updates the information needed for the Assistant to open the web spy page for this LRC, namely the host IP address, port number, and the connection ID.
virtual void updateConnInfo (const MAKRti::DtInetAddr &ipAddr, const MAKRti::DtInetAddr &bestEffortIpAddr, const MAKRti::DtInetAddr &interfaceAddr, int udpPort, int tcpPort, bool useRtiexec, bool fullCompliance, int forwarderPort)
 Updates the information on this LRC's RTI connection.
virtual void sendClientInfo ()
 Sends the stored LRC information to the Assistant.

Protected Attributes

MAKRti::DtString myName
 The name the Assistant uses to identify this LRC.
unsigned long myFedHandle
 This LRC's federate handle.
unsigned long myFederationHandle
 This LRC's federation handle.
MAKRti::DtString myFederationName
 This LRC's federation name.
MAKRti::DtFilename myLogFile
 The name and full path of the log file.
MAKRti::DtString myLicServer
 The license server used by this LRC.
MAKRti::DtInetAddr myWebSpyAddr
 The host address for the web spy.
int myWebSpyPort
 The port for the web spy.
int myWebSpyId
 The connection ID used to identify this LRC's page.
MAKRti::DtInetAddr myReliableAddr
 The RTI reliable IP address.
MAKRti::DtInetAddr myBestEffortAddr
 The RTI best effort IP address.
MAKRti::DtInetAddr myNetworkInterfaceAddr
 The address of the network interface being used.
int myUdpPort
 The RTI UDP port.
int myTcpPort
 The RTI TCP port.
bool myUseRtiexec
 Whether use of an rtiexec is enabled.
bool myFullCompliance
 Whether full compliance is enabled.
int myForwarderPort
 The port the forwarder uses to connect to other forwarders.
MAKRti::DtString myFederateName
 The federate name.
DtHlaVersionId myHlaVersion
 The federate's HLA version.

Detailed Description

The client connection to the RTI Assistant for an LRC.

DtRtiAssistantLrcClient manages the client connection of an LRC to the RTI Assistant. Provides routines to create and send messages to the Assistant.


Constructor & Destructor Documentation


Member Function Documentation

Sends the stored LRC information to the Assistant.

Reimplemented from DtRtiAssistantClient.

References DtAssistantLrcCompInfoMsgKind, DtRtiAssistantClient::msgFactory(), myBestEffortAddr, DtRtiAssistantClient::myCommandArgs, myFederateName, myFederationHandle, myFederationName, myFedHandle, myForwarderPort, myFullCompliance, myHlaVersion, myLicServer, myLogFile, myName, myNetworkInterfaceAddr, DtRtiAssistantClient::myPID, DtRtiAssistantClient::myProcessName, myReliableAddr, myTcpPort, myUdpPort, myUseRtiexec, myWebSpyAddr, myWebSpyId, myWebSpyPort, DtRtiAssistantClient::sendMsg(), DtAssistantLrcCompInfoMsg::setBestEffortIpAddress(), DtAssistantLrcCompInfoMsg::setCommandArgs(), DtAssistantLrcCompInfoMsg::setFederateHandle(), DtAssistantLrcCompInfoMsg::setFederateName(), DtAssistantLrcCompInfoMsg::setFederationHandle(), DtAssistantLrcCompInfoMsg::setFederationName(), DtAssistantLrcCompInfoMsg::setForwarderPort(), DtAssistantLrcCompInfoMsg::setFullCompliance(), DtAssistantLrcCompInfoMsg::setHlaVersion(), DtAssistantLrcCompInfoMsg::setIpAddress(), DtAssistantLrcCompInfoMsg::setLicServer(), DtAssistantLrcCompInfoMsg::setLogFilename(), DtAssistantLrcCompInfoMsg::setName(), DtAssistantLrcCompInfoMsg::setNetworkInterfaceAddress(), DtAssistantLrcCompInfoMsg::setNotifyLevel(), DtAssistantLrcCompInfoMsg::setProcessId(), DtAssistantLrcCompInfoMsg::setProcessName(), DtAssistantLrcCompInfoMsg::setTcpPort(), DtAssistantLrcCompInfoMsg::setUdpPort(), DtAssistantLrcCompInfoMsg::setUseRtiexec(), DtAssistantLrcCompInfoMsg::setWebSpyId(), DtAssistantLrcCompInfoMsg::setWebSpyIpAddress(), and DtAssistantLrcCompInfoMsg::setWebSpyPort().

Referenced by DtRtiExecFederateMgr::processJoinResponseMsg().

void DtRtiAssistantLrcClient::updateConnInfo ( const MAKRti::DtInetAddr &  ipAddr,
const MAKRti::DtInetAddr &  bestEffortIpAddr,
const MAKRti::DtInetAddr &  interfaceAddr,
int  udpPort,
int  tcpPort,
bool  useRtiexec,
bool  fullCompliance,
int  forwarderPort 
) [virtual]

Updates the information on this LRC's RTI connection.

Note that this method does not send the message to the assistant, just stores the name to be sent when sendClientInfo is called.

References DtDefaultInterfaceAddr(), myBestEffortAddr, myForwarderPort, myFullCompliance, myNetworkInterfaceAddr, myReliableAddr, myTcpPort, myUdpPort, myUseRtiexec, and tcpPort.

void DtRtiAssistantLrcClient::updateFederateName ( const MAKRti::DtString &  fedName) [virtual]

Updates the federate name used by the assistant.

Note that this method does not send the message to the assistant, just stores the name to be send when sendClientInfo is called.

References myFederateName.

Referenced by DtRtiExecFederateMgr::processJoinResponseMsg().

void DtRtiAssistantLrcClient::updateFederationInfo ( unsigned long  federationHandle,
const MAKRti::DtString &  federationName,
unsigned long  fedHandle,
DtHlaVersionId  hlaVersion 
) [virtual]

Updates the federation name and federate handle used by the Assistant to help identify this LRC.

Note that this method does not send the message to the assistant, just stores the name to be sent when sendClientInfo is called.

References federationName(), myFederationHandle, myFederationName, myFedHandle, and myHlaVersion.

void DtRtiAssistantLrcClient::updateLicenseServer ( const MAKRti::DtString &  server) [virtual]

Updates the license server used by this LRC.

Used by the Assistant to help other LRCs locate a license. Note that this method does not send the message to the assistant, just stores the name to be sent when sendClientInfo is called.

References myLicServer.

Referenced by initControl().

void DtRtiAssistantLrcClient::updateLrcLogFile ( const MAKRti::DtFilename &  file) [virtual]

Updates the log file name used by this LRC.

This is sent to the Assistant so that it may display the log to interested users. Note that this method does not send the message to the assistant, just stores the name to be sent when sendClientInfo is called.

References myLogFile, and NULL.

void DtRtiAssistantLrcClient::updateLrcName ( const MAKRti::DtString &  name) [virtual]

Updates the name used by the Assistant to identify this LRC.

Note that this method does not send the message to the assistant, just stores the name to be sent when sendClientInfo is called.

References myName.

void DtRtiAssistantLrcClient::updateWebSpyInfo ( const MAKRti::DtInetAddr &  ipAddr,
int  port,
int  id 
) [virtual]

Updates the information needed for the Assistant to open the web spy page for this LRC, namely the host IP address, port number, and the connection ID.

Note that this method does not send the message to the assistant, just stores the name to be sent when sendClientInfo is called.

References myWebSpyAddr, myWebSpyId, and myWebSpyPort.


Member Data Documentation

MAKRti::DtInetAddr DtRtiAssistantLrcClient::myBestEffortAddr [protected]

The RTI best effort IP address.

Referenced by sendClientInfo(), and updateConnInfo().

MAKRti::DtString DtRtiAssistantLrcClient::myFederateName [protected]

The federate name.

Referenced by sendClientInfo(), and updateFederateName().

This LRC's federation handle.

Referenced by sendClientInfo(), and updateFederationInfo().

MAKRti::DtString DtRtiAssistantLrcClient::myFederationName [protected]

This LRC's federation name.

Referenced by sendClientInfo(), and updateFederationInfo().

unsigned long DtRtiAssistantLrcClient::myFedHandle [protected]

This LRC's federate handle.

Referenced by sendClientInfo(), and updateFederationInfo().

The port the forwarder uses to connect to other forwarders.

Referenced by sendClientInfo(), and updateConnInfo().

Whether full compliance is enabled.

Referenced by sendClientInfo(), and updateConnInfo().

The federate's HLA version.

Referenced by sendClientInfo(), and updateFederationInfo().

MAKRti::DtString DtRtiAssistantLrcClient::myLicServer [protected]

The license server used by this LRC.

Referenced by sendClientInfo(), and updateLicenseServer().

MAKRti::DtFilename DtRtiAssistantLrcClient::myLogFile [protected]

The name and full path of the log file.

Referenced by sendClientInfo(), and updateLrcLogFile().

MAKRti::DtString DtRtiAssistantLrcClient::myName [protected]

The name the Assistant uses to identify this LRC.

Referenced by sendClientInfo(), and updateLrcName().

MAKRti::DtInetAddr DtRtiAssistantLrcClient::myNetworkInterfaceAddr [protected]

The address of the network interface being used.

Referenced by sendClientInfo(), and updateConnInfo().

MAKRti::DtInetAddr DtRtiAssistantLrcClient::myReliableAddr [protected]

The RTI reliable IP address.

Referenced by sendClientInfo(), and updateConnInfo().

The RTI TCP port.

Referenced by sendClientInfo(), and updateConnInfo().

The RTI UDP port.

Referenced by sendClientInfo(), and updateConnInfo().

Whether use of an rtiexec is enabled.

Referenced by sendClientInfo(), and updateConnInfo().

MAKRti::DtInetAddr DtRtiAssistantLrcClient::myWebSpyAddr [protected]

The host address for the web spy.

Referenced by sendClientInfo(), and updateWebSpyInfo().

The connection ID used to identify this LRC's page.

Referenced by sendClientInfo(), and updateWebSpyInfo().

The port for the web spy.

Referenced by sendClientInfo(), and updateWebSpyInfo().


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

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)