MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes
DtAssistantInfo Class Reference

Stores basic information about a remote assistant. More...

+ Collaboration diagram for DtAssistantInfo:

Public Member Functions

 ~DtAssistantInfo ()
 Destructor.
bool operator< (const DtAssistantInfo &other) const
 Overloaded operator.
bool operator== (const DtAssistantInfo &other) const
 Overloaded operator. Determines if all params are equal.
bool operator!= (const DtAssistantInfo &other) const
 Overloaded operator. Determines if any param is not equal.
DtHostNameAddress host () const
 Get the host of the assistant.
void setHost (const DtHostNameAddress &host)
 Set the host of the assistant.
const MAKRti::DtString & hostName () const
 Get the host name of the assistant.
void setHostName (const MAKRti::DtString &name)
 Set the host name of the assistant.
const MAKRti::DtInetAddr & address () const
 Get IP address of the assistant.
void setAddress (const MAKRti::DtInetAddr &addr)
 Set the IP address of the assistant.
const MAKRti::DtInetAddr & networkInterfaceAddress () const
 Get address of local interface to the remote the assistant.
void setNetworkInterfaceAddress (const MAKRti::DtInetAddr &interfaceAddr)
 Set address of local interface to the remote the assistant.
int id () const
 Get the ID which is used to distinguish between assistants running on the same machine.
void setId (int id)
 Set the ID which is used to distinguish between assistants running on the same machine.
DtAssistantInfoSet::const_iterator findMatchingHostInfo (const DtAssistantInfoSet &set)
 Returns an iterator into the given set of an item in the set that matches this assistant's host info.
bool isThisAssistant () const
 Returns true if this assistant info is for this assistant.
 DtAssistantInfo ()
 Constructor.
 DtAssistantInfo (const MAKRti::DtString &host, const MAKRti::DtInetAddr &addr, const MAKRti::DtInetAddr &interfaceAddr, int id)
 Constructor.
 DtAssistantInfo (const DtHostNameAddress &host, const MAKRti::DtInetAddr &interfaceAddr, int id)
 Constructor.

Static Public Member Functions

static void setThisAssistantId (int id)
 Sets the ID of this assistant for comparisons.

Protected Attributes

DtHostNameAddress myHost
 Host on which the assistant is running.
MAKRti::DtInetAddr myNetworkInterfaceAddr
 Address of local interface to remote host.
int myId
 ID used to distinguish between assistants running on the same machine.

Static Protected Attributes

static int theIdOfThisAssistant = DtASSISTANT_DEFAULT_DEST_ID
 The ID of this assistant. Must be set with setThisAssistantInfo().

Detailed Description

Stores basic information about a remote assistant.

Constructor & Destructor Documentation

DtAssistantInfo::DtAssistantInfo ( )

Constructor.

DtAssistantInfo::DtAssistantInfo ( const MAKRti::DtString &  host,
const MAKRti::DtInetAddr &  addr,
const MAKRti::DtInetAddr &  interfaceAddr,
int  id 
)

Constructor.

DtAssistantInfo::DtAssistantInfo ( const DtHostNameAddress host,
const MAKRti::DtInetAddr &  interfaceAddr,
int  id 
)

Constructor.

DtAssistantInfo::~DtAssistantInfo ( )

Destructor.

Member Function Documentation

const MAKRti::DtInetAddr & DtAssistantInfo::address ( ) const
DtAssistantInfoSet::const_iterator DtAssistantInfo::findMatchingHostInfo ( const DtAssistantInfoSet set)
DtHostNameAddress DtAssistantInfo::host ( ) const
const MAKRti::DtString & DtAssistantInfo::hostName ( ) const

Get the host name of the assistant.

References DtHostNameAddress::hostName(), and myHost.

Referenced by findMatchingHostInfo(), and DtAssistantFederationsViewMgr::updateRidParams().

int DtAssistantInfo::id ( ) const

Get the ID which is used to distinguish between assistants running on the same machine.

References myId.

Referenced by operator<(), operator==(), DtRtiAssistantPeer::sendFederateInfoReqMsg(), DtRtiAssistantPeer::sendMsgToAssistant(), DtRtiAssistantPeer::sendObserveFederationsMsg(), setId(), and setThisAssistantId().

bool DtAssistantInfo::isThisAssistant ( ) const
const MAKRti::DtInetAddr & DtAssistantInfo::networkInterfaceAddress ( ) const

Get address of local interface to the remote the assistant.

References myNetworkInterfaceAddr.

Referenced by findMatchingHostInfo(), operator<(), operator==(), DtRtiAssistantPeer::sendFederateInfoReqMsg(), and DtRtiAssistantPeer::sendMsgToAssistant().

bool DtAssistantInfo::operator!= ( const DtAssistantInfo other) const

Overloaded operator. Determines if any param is not equal.

References operator==().

bool DtAssistantInfo::operator< ( const DtAssistantInfo other) const

Overloaded operator.

References host(), id(), myHost, myId, myNetworkInterfaceAddr, and networkInterfaceAddress().

bool DtAssistantInfo::operator== ( const DtAssistantInfo other) const

Overloaded operator. Determines if all params are equal.

References host(), id(), myHost, myId, myNetworkInterfaceAddr, and networkInterfaceAddress().

Referenced by operator!=().

void DtAssistantInfo::setAddress ( const MAKRti::DtInetAddr &  addr)

Set the IP address of the assistant.

References myHost, and DtHostNameAddress::setIp().

Referenced by findMatchingHostInfo(), and DtAssistantLatencyTestMgr::getRtiexecConn().

void DtAssistantInfo::setHost ( const DtHostNameAddress host)

Set the host of the assistant.

References host(), and myHost.

Referenced by findMatchingHostInfo(), and DtAssistantFederationsInfoMgr::requestFederateLoc().

void DtAssistantInfo::setHostName ( const MAKRti::DtString &  name)

Set the host name of the assistant.

References myHost, and DtHostNameAddress::setHostName().

void DtAssistantInfo::setId ( int  id)

Set the ID which is used to distinguish between assistants running on the same machine.

References id(), and myId.

Referenced by DtAssistantLatencyTestMgr::getRtiexecConn(), and DtAssistantFederationsInfoMgr::requestFederateLoc().

void DtAssistantInfo::setNetworkInterfaceAddress ( const MAKRti::DtInetAddr &  interfaceAddr)

Set address of local interface to the remote the assistant.

References myNetworkInterfaceAddr.

Referenced by DtAssistantLatencyTestMgr::getRtiexecConn(), and DtRtiAssistantPeer::sendFederateInfoReqMsg().

void DtAssistantInfo::setThisAssistantId ( int  id)
static

Sets the ID of this assistant for comparisons.

References id(), and theIdOfThisAssistant.

Referenced by DtRtiAssistantPeer::DtRtiAssistantPeer().

Member Data Documentation

DtHostNameAddress DtAssistantInfo::myHost
protected
int DtAssistantInfo::myId
protected

ID used to distinguish between assistants running on the same machine.

Referenced by id(), isThisAssistant(), operator<(), operator==(), and setId().

MAKRti::DtInetAddr DtAssistantInfo::myNetworkInterfaceAddr
protected

Address of local interface to remote host.

Referenced by findMatchingHostInfo(), networkInterfaceAddress(), operator<(), operator==(), and setNetworkInterfaceAddress().

int DtAssistantInfo::theIdOfThisAssistant = DtASSISTANT_DEFAULT_DEST_ID
staticprotected

The ID of this assistant. Must be set with setThisAssistantInfo().

Referenced by isThisAssistant(), and setThisAssistantId().


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

Document ID: Generated on Wed Mar 11 20:26:49 EDT 2015 from SVN revision 150939
Copyright © 2005-2015 VT MÄK Inc. All Rights Reserved (www.mak.com)