DtSimulationAddress Class Reference

A DtSimulationAddress is used in DIS to identify a particular simulator. More...

Collaboration diagram for DtSimulationAddress:

Public Member Functions
	DtSimulationAddress ()
	DtSimulationAddress (const char *str)
	DtSimulationAddress (DtU16 site, DtU16 app)
	DtSimulationAddress (const DtNetFederateId &netId)
	DtSimulationAddress (const DtSimulationAddress &orig)
	~DtSimulationAddress ()
const DtNetFederateId &	operator= (const DtNetFederateId &netId)
const DtSimulationAddress &	operator= (const DtSimulationAddress &netId)
bool	operator< (const DtSimulationAddress &other) const
	operator DtNetFederateId () const
bool	operator== (const DtSimulationAddress &otherGuy) const
bool	operator!= (const DtSimulationAddress &otherGuy) const
void	init (DtU16 site, DtU16 app)
	deprecated, here for historical reasons More...
DtU16	siteId () const
	gets the siteId for this class More...
void	setSiteId (DtU16 siteId)
	sets the siteId for this class More...
DtU16	applicationId () const
	gets the applicationId (also know as the host ID) for this class More...
void	setApplicationId (DtU16 id)
	sets the applicationId (also know as the host ID) for this class More...
const char *	string () const
	returns a string representation of the simulation address More...

Static Public Member Functions
static const DtSimulationAddress &	nullId ()

Public Attributes
DtU16	DtSite
	Public for backwards compatibility only, use setSite()/site() More...
DtU16	DtHost
	Public for backwards compatibility only, use applicationId()/setApplicationId() More...

Protected Attributes
std::string	myMutableStringRep
	This member is: 1) mutable because it is changed in const methods and used as a char buffer 2) protected because legacy subclasses use it 3) it SHOULD be private because it is not considered part of the API and should not be used by any subclass. More...

Detailed Description

A DtSimulationAddress is used in DIS to identify a particular simulator.

The address is a combination of the host (also know as the applicationId) and the siteId which is typically a geographic location identifier. DtSimulationAddress are used by EntityIdentifiers in DIS, and since DtEntityIdentifier instances have found a place in the RPR FOM, so too has this class.

Constructor & Destructor Documentation

DtSimulationAddress::DtSimulationAddress

(

)

DtSimulationAddress::DtSimulationAddress

(

const char *

str

)

DtSimulationAddress::DtSimulationAddress	(	DtU16	site,
		DtU16	app
	)

DtSimulationAddress::DtSimulationAddress

(

const DtNetFederateId &

netId

)

DtSimulationAddress::DtSimulationAddress

(

const DtSimulationAddress &

orig

)

DtSimulationAddress::~DtSimulationAddress ( )

inline

Member Function Documentation

DtU16 DtSimulationAddress::applicationId

(

)

const

gets the applicationId (also know as the host ID) for this class

void DtSimulationAddress::init	(	DtU16	site,
		DtU16	app
	)

deprecated, here for historical reasons

static const DtSimulationAddress& DtSimulationAddress::nullId ( )

static

DtSimulationAddress::operator DtNetFederateId

(

)

const

bool DtSimulationAddress::operator!= ( const DtSimulationAddress &  otherGuy ) const

inline

bool DtSimulationAddress::operator<

(

const DtSimulationAddress &

other

)

const

const DtNetFederateId& DtSimulationAddress::operator=

(

const DtNetFederateId &

netId

)

const DtSimulationAddress& DtSimulationAddress::operator=

(

const DtSimulationAddress &

netId

)

bool DtSimulationAddress::operator== ( const DtSimulationAddress &  otherGuy ) const

inline

void DtSimulationAddress::setApplicationId

(

DtU16

id

)

sets the applicationId (also know as the host ID) for this class

Referenced by DtBaseEntityStateRepository::federateId().

void DtSimulationAddress::setSiteId

(

DtU16

siteId

)

sets the siteId for this class

Referenced by DtBaseEntityStateRepository::federateId().

DtU16 DtSimulationAddress::siteId

(

)

const

gets the siteId for this class

const char* DtSimulationAddress::string

(

)

const

returns a string representation of the simulation address

Member Data Documentation

DtU16 DtSimulationAddress::DtHost

Public for backwards compatibility only, use applicationId()/setApplicationId()

DtU16 DtSimulationAddress::DtSite

Public for backwards compatibility only, use setSite()/site()

std::string DtSimulationAddress::myMutableStringRep

mutableprotected

This member is: 1) mutable because it is changed in const methods and used as a char buffer 2) protected because legacy subclasses use it 3) it SHOULD be private because it is not considered part of the API and should not be used by any subclass.

---

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

• simulationAddress.h