DtEntityType is used to represent the type an entity object. More...

Inheritance diagram for DtEntityType:

Collaboration diagram for DtEntityType:

Public Member Functions
	DtEntityType (const char *p)
	constructs an instance from a string in the form: "2:3:4:5:6:7:8"
	DtEntityType (int kind, int domain, int country, int category, int subCategory, int specific, int extra)
	constructs an instance from the specified values
	DtEntityType ()
	constructs a default instance 0:0:0:0:0:0:0
	DtEntityType (DtNetEntityType netType)
	constructs an instance from a network layout specified by IEEE 1278
	DtEntityType (const DtEntityType &orig)
	Copy constructor.
virtual	~DtEntityType ()
	Destructor.
void	setFromNet (const DtNetEntityType &netType)
	Sets the instance equal to the value in netType prefer the DtNetEntityType constructor to this function.
	operator DtNetEntityType () const
	returns a network structure of this instance
const char *	string () const
	returns a string representation of this instance in the form 1:2:3:4:5:6:7
int	kind () const
int	domain () const
int	country () const
int	category () const
int	subCategory () const
int	specific () const
int	extra () const
void	setKind (int val)
void	setDomain (int val)
void	setCountry (int val)
void	setCategory (int val)
void	setSubCategory (int val)
void	setSpecific (int val)
void	setExtra (int val)
bool	matchPattern (const DtEntityType &pat) const
bool	DtTypeMatchPattern (const DtEntityType &pat) const
int	match (const DtEntityType &type) const
int	operator== (const DtEntityType &type) const
int	operator!= (const DtEntityType &type) const
bool	operator< (const DtEntityType &type) const
	Returns true if the entity type is smaller.

Static Public Member Functions
static const DtEntityType &	defaultType ()
	return an instance of -1:-1:-1:-1:-1:-1:-1
static const DtEntityType &	nullType ()
	returns an instance of 0:0:0:0:0:0:0

Public Attributes
int	DtEntityKind
	Public for historical reasons, will be made protected in future versions.
int	DtDomain
	Public for historical reasons, will be made protected in future versions.
int	DtCountry
	Public for historical reasons, will be made protected in future versions.
int	DtCategory
	Public for historical reasons, will be made protected in future versions.
int	DtSubCategory
	Public for historical reasons, will be made protected in future versions.
int	DtSpecific
	Public for historical reasons, will be made protected in future versions.
int	DtExtra
	Public for historical reasons, will be made protected in future versions.

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

DtEntityType is used to represent the type an entity object.

Entities are represented using 7 positive integer values. A value of -1 is used for pattern matching and not transmitted across the network. The common notation for a DtEntityType looks like: kind:domain:country:category:subCategory:specific:extra

Constructor & Destructor Documentation

DtEntityType::DtEntityType ( const char * p )

constructs an instance from a string in the form: "2:3:4:5:6:7:8"

DtEntityType::DtEntityType	(	int	kind,
		int	domain,
		int	country,
		int	category,
		int	subCategory,
		int	specific,
		int	extra
	)

constructs an instance from the specified values

DtEntityType::DtEntityType ( )

constructs a default instance 0:0:0:0:0:0:0

DtEntityType::DtEntityType ( DtNetEntityType netType )

constructs an instance from a network layout specified by IEEE 1278

DtEntityType::DtEntityType ( const DtEntityType & orig )

Copy constructor.

virtual DtEntityType::~DtEntityType ( )

virtual

Destructor.

Member Function Documentation

int DtEntityType::category ( ) const

inline

int DtEntityType::country ( ) const

inline

Reimplemented in DtEnvironmentTypeRecord.

static const DtEntityType& DtEntityType::defaultType ( )

static

return an instance of -1:-1:-1:-1:-1:-1:-1

int DtEntityType::domain ( ) const

inline

bool DtEntityType::DtTypeMatchPattern ( const DtEntityType & pat ) const

inline

int DtEntityType::extra ( ) const

inline

int DtEntityType::kind ( ) const

inline

int DtEntityType::match ( const DtEntityType & type ) const

inline

References operator==().

bool DtEntityType::matchPattern ( const DtEntityType & pat ) const

static const DtEntityType& DtEntityType::nullType ( )

static

returns an instance of 0:0:0:0:0:0:0

Reimplemented in DtRadioEntityType.

DtEntityType::operator DtNetEntityType ( ) const

returns a network structure of this instance

int DtEntityType::operator!= ( const DtEntityType & type ) const

bool DtEntityType::operator< ( const DtEntityType & type ) const

Returns true if the entity type is smaller.

If there are wildcards present then true is returned if the entity is smaller and less specific.

int DtEntityType::operator== ( const DtEntityType & type ) const

void DtEntityType::setCategory ( int val )

inline

void DtEntityType::setCountry ( int val )

inline

Reimplemented in DtEnvironmentTypeRecord.

void DtEntityType::setDomain ( int val )

inline

void DtEntityType::setExtra ( int val )

inline

void DtEntityType::setFromNet ( const DtNetEntityType & netType )

Sets the instance equal to the value in netType prefer the DtNetEntityType constructor to this function.

void DtEntityType::setKind ( int val )

inline

void DtEntityType::setSpecific ( int val )

inline

void DtEntityType::setSubCategory ( int val )

inline

int DtEntityType::specific ( ) const

inline

const char* DtEntityType::string ( ) const

returns a string representation of this instance in the form 1:2:3:4:5:6:7

Reimplemented in DtRadioEntityType.

int DtEntityType::subCategory ( ) const

inline

Referenced by DtF18EntityChooser().