dtHLAGM::EntityType Class Reference

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

#include <distypes.h>

List of all members.

Public Member Functions
	EntityType (unsigned char kind=0, unsigned char domain=0, unsigned short country=0, unsigned char category=0, unsigned char subcategory=0, unsigned char specific=0, unsigned char extra=0)
	Constructor.
bool	operator== (const EntityType &entityType) const
	Compares this object to another of its type.
bool	operator!= (const EntityType &entityType) const
EntityType &	operator= (const EntityType &entityType)
	Assigns this object to the value of another.
bool	operator< (const EntityType &entityType) const
	Compares this object to another of its type.
int	RankMatch (const EntityType &entityType) const
	Ranks the match between this entity type and another.
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	SetKind (unsigned char kind)
	Sets the value of the kind field.
unsigned char	GetKind () const
	Returns: the value of the kind field
void	SetDomain (unsigned char domain)
	Sets the value of the domain field.
unsigned char	GetDomain () const
	` *
void	SetCountry (unsigned short country)
	Sets the value of the country field.
unsigned short	GetCountry () const
	Returns: the value of the country field
void	SetCategory (unsigned char category)
	Sets the value of the category field.
unsigned char	GetCategory () const
	Returns: the value of the category field
void	SetSubcategory (unsigned char subcategory)
	Sets the value of the subcategory field.
unsigned char	GetSubcategory () const
	Returns: the value of the subcategory field
void	SetSpecific (unsigned char specific)
	Sets the value of the specific field.
unsigned char	GetSpecific () const
	Returns: the value of the specific field
void	SetExtra (unsigned char extra)
	Sets the value of the extra field.
unsigned char	GetExtra () const
	Returns: the value of the extra field
bool	IsEqual (const EntityType &other) const
	Returns true this equals another EntityType object.

---

Detailed Description

A DIS/RPR-FOM entity type.

---

Constructor & Destructor Documentation

dtHLAGM::EntityType::EntityType	(	unsigned char	kind = 0,
		unsigned char	domain = 0,
		unsigned short	country = 0,
		unsigned char	category = 0,
		unsigned char	subcategory = 0,
		unsigned char	specific = 0,
		unsigned char	extra = 0
	)

Constructor.

Parameters:

	kind	the value of the kind field
	domain	the value of the kind field
	country	the value of the kind field
	category	the value of the kind field
	subcategory	the value of the kind field
	specific	the value of the kind field
	extra	the value of the kind field

---

Member Function Documentation

bool dtHLAGM::EntityType::operator==

(

const EntityType &

entityType

)

const

Compares this object to another of its type.

Parameters:

entityType

the object to compare this to

Returns:

true if this object is equal to the parameter, false otherwise

bool dtHLAGM::EntityType::operator!=

(

const EntityType &

entityType

)

const [inline]

EntityType& dtHLAGM::EntityType::operator=

(

const EntityType &

entityType

)

[inline]

Assigns this object to the value of another.

Parameters:

entityType

the object to compare this to

Returns:

*this

bool dtHLAGM::EntityType::operator<

(

const EntityType &

entityType

)

const

Compares this object to another of its type.

Imposes a total ordering, allowing this object to be used as a map key.

Parameters:

entityType

the object to compare this to

Returns:

true if this object is less than the parameter, false otherwise

int dtHLAGM::EntityType::RankMatch

(

const EntityType &

entityType

)

const

Ranks the match between this entity type and another.

Parameters:

entityType

the entity type to compare this to

Returns:

the integer rank of the match, where -1 indicates that the types do not match, and increasing ranks indicate better (more specific) matches

size_t dtHLAGM::EntityType::EncodedLength

(

)

const

Returns the encoded length of this object.

Returns:

the encoded length of this object, in bytes

void dtHLAGM::EntityType::Encode

(

char *

buf

)

const

Encodes this object into the specified buffer.

Parameters:

buf

the buffer to contain the encoded object

void dtHLAGM::EntityType::Decode

(

const char *

buf

)

Decodes the values contained in the specified buffer.

Parameters:

buf

the buffer containing the encoded object

void dtHLAGM::EntityType::SetKind

(

unsigned char

kind

)

[inline]

Sets the value of the kind field.

Parameters:

kind

the value of the kind field

unsigned char dtHLAGM::EntityType::GetKind

(

)

const [inline]

Returns:

the value of the kind field

void dtHLAGM::EntityType::SetDomain

(

unsigned char

domain

)

[inline]

Sets the value of the domain field.

Parameters:

domain

the value of the domain field

unsigned char dtHLAGM::EntityType::GetDomain

(

)

const [inline]

` *

Returns:

the value of the domain field

void dtHLAGM::EntityType::SetCountry

(

unsigned short

country

)

[inline]

Sets the value of the country field.

Parameters:

country

the value of the country field

unsigned short dtHLAGM::EntityType::GetCountry

(

)

const [inline]

Returns:

the value of the country field

void dtHLAGM::EntityType::SetCategory

(

unsigned char

category

)

[inline]

Sets the value of the category field.

Parameters:

category

the value of the category field

unsigned char dtHLAGM::EntityType::GetCategory

(

)

const [inline]

Returns:

the value of the category field

void dtHLAGM::EntityType::SetSubcategory

(

unsigned char

subcategory

)

[inline]

Sets the value of the subcategory field.

Parameters:

subcategory

the value of the subcategory field

unsigned char dtHLAGM::EntityType::GetSubcategory

(

)

const [inline]

Returns:

the value of the subcategory field

void dtHLAGM::EntityType::SetSpecific

(

unsigned char

specific

)

[inline]

Sets the value of the specific field.

Parameters:

specific

the value of the specific field

unsigned char dtHLAGM::EntityType::GetSpecific

(

)

const [inline]

Returns:

the value of the specific field

void dtHLAGM::EntityType::SetExtra

(

unsigned char

extra

)

[inline]

Sets the value of the extra field.

Parameters:

extra

the value of the extra field

unsigned char dtHLAGM::EntityType::GetExtra

(

)

const [inline]

Returns:

the value of the extra field

bool dtHLAGM::EntityType::IsEqual

(

const EntityType &

other

)

const

Returns true this equals another EntityType object.

Returns:

true if this is equal to other

---