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 (int site, int 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
int	operator== (const DtSimulationAddress &otherGuy) const
int	operator!= (const DtSimulationAddress &otherGuy) const
void	init (int site, int app)
	deprecated, here for historical reasons
int	siteId () const
	gets the siteId for this class
void	setSiteId (int siteId)
	sets the siteId for this class
int	applicationId () const
	gets the applicationId (also know as the host ID) for this class
void	setApplicationId (int id)
	sets the applicationId (also know as the host ID) for this class
const char *	string () const
	returns a string representation of the simulation address

Static Public Member Functions
static const DtSimulationAddress &	nullId ()

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

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.

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	(	int	site,
		int	app
	)

DtSimulationAddress::DtSimulationAddress

(

const DtNetFederateId &

netId

)

DtSimulationAddress::DtSimulationAddress

(

const DtSimulationAddress &

orig

)

DtSimulationAddress::~DtSimulationAddress ( )

inline

Member Function Documentation

int DtSimulationAddress::applicationId

(

)

const

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

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

deprecated, here for historical reasons

static const DtSimulationAddress& DtSimulationAddress::nullId ( )

static

DtSimulationAddress::operator DtNetFederateId

(

)

const

int DtSimulationAddress::operator!=

(

const DtSimulationAddress &

otherGuy

)

const

bool DtSimulationAddress::operator<

(

const DtSimulationAddress &

other

)

const

const DtNetFederateId& DtSimulationAddress::operator=

(

const DtNetFederateId &

netId

)

const DtSimulationAddress& DtSimulationAddress::operator=

(

const DtSimulationAddress &

netId

)

int DtSimulationAddress::operator==

(

const DtSimulationAddress &

otherGuy

)

const

void DtSimulationAddress::setApplicationId

(

int

id

)

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

Referenced by DtBaseEntityStateRepository::federateId().

void DtSimulationAddress::setSiteId

(

int

siteId

)

sets the siteId for this class

Referenced by DtBaseEntityStateRepository::federateId().

int 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

int DtSimulationAddress::DtHost

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

int 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