dtHLAGM::EntityIdentifier Class Reference

A DIS/RPR-FOM entity identifier. More...

#include <distypes.h>

List of all members.

Public Member Functions
	EntityIdentifier (unsigned short siteIdentifier=0, unsigned short applicationIdentifier=0, unsigned short entityIdentifier=0)
	Constructor.
size_t	EncodedLength () const
	Returns the encoded length of this object.
void	Encode (char *buf) const
	Encodes this object into the specified buffer.
void	Decode (const char *buf)
	Decodes the values contained in the specified buffer.
void	SetSiteIdentifier (unsigned short siteIdentifier)
	Sets the value of the site identifier field.
unsigned short	GetSiteIdentifier () const
	Returns the value of the site identifier field.
void	SetApplicationIdentifier (unsigned short applicationIdentifier)
	Sets the value of the application identifier field.
unsigned short	GetApplicationIdentifier () const
	Returns the value of the application identifier field.
void	SetEntityIdentifier (unsigned short entityIdentifier)
	Sets the value of the entity identifier field.
unsigned short	GetEntityIdentifier () const
	Returns the value of the entity identifier field.
bool	operator== (const EntityIdentifier &compareTo) const
bool	operator< (const EntityIdentifier &entityId) const

---

Detailed Description

A DIS/RPR-FOM entity identifier.

---

Constructor & Destructor Documentation

dtHLAGM::EntityIdentifier::EntityIdentifier	(	unsigned short	siteIdentifier = 0,
		unsigned short	applicationIdentifier = 0,
		unsigned short	entityIdentifier = 0
	)

Constructor.

Parameters:

	siteIdentifier	the site identifier
	applicationIdentifier	the application identifier
	entityIdentifier	the entity identifier

---

Member Function Documentation

size_t dtHLAGM::EntityIdentifier::EncodedLength

(

)

const

Returns the encoded length of this object.

Returns:

the encoded length of this object, in bytes

void dtHLAGM::EntityIdentifier::Encode

(

char *

buf

)

const

Encodes this object into the specified buffer.

Parameters:

buf

the buffer to contain the encoded object

void dtHLAGM::EntityIdentifier::Decode

(

const char *

buf

)

Decodes the values contained in the specified buffer.

Parameters:

buf

the buffer containing the encoded object

void dtHLAGM::EntityIdentifier::SetSiteIdentifier

(

unsigned short

siteIdentifier

)

Sets the value of the site identifier field.

Parameters:

siteIdentifier

the value of the site identifier field

unsigned short dtHLAGM::EntityIdentifier::GetSiteIdentifier

(

)

const

Returns the value of the site identifier field.

Returns:

the value of the site identifier field

void dtHLAGM::EntityIdentifier::SetApplicationIdentifier

(

unsigned short

applicationIdentifier

)

Sets the value of the application identifier field.

Parameters:

applicationIdentifier

the value of the application identifier field

unsigned short dtHLAGM::EntityIdentifier::GetApplicationIdentifier

(

)

const

Returns the value of the application identifier field.

Returns:

the value of the application identifier field

void dtHLAGM::EntityIdentifier::SetEntityIdentifier

(

unsigned short

entityIdentifier

)

Sets the value of the entity identifier field.

Parameters:

entityIdentifier

the value of the entity identifier field

unsigned short dtHLAGM::EntityIdentifier::GetEntityIdentifier

(

)

const

Returns the value of the entity identifier field.

Returns:

the value of the entity identifier field

bool dtHLAGM::EntityIdentifier::operator==

(

const EntityIdentifier &

compareTo

)

const

bool dtHLAGM::EntityIdentifier::operator<

(

const EntityIdentifier &

entityId

)

const

---