DtObjectId Class Reference

DtObjectId instances are used to represent RTI::ObjectInstances in VR-Link. More...

Collaboration diagram for DtObjectId:

List of all members.

Public Member Functions
	DtObjectId ()
	The Default constructor.
	DtObjectId (RTI::ObjectInstanceHandle id)
	DtObjectId (const DtObjectId &orig)
DtObjectId &	operator= (const DtObjectId &orig)
int	operator== (const DtObjectId &orig) const
	Equality operators.
int	operator!= (const DtObjectId &orig) const
bool	operator< (const DtObjectId &orig) const
	operator RTI::ObjectInstanceHandle () const
virtual void	makePlaceholder ()
	makePlaceholder() causes this object, if it is invalid, to have a unique DtObjectId Hash Key, by setting the invalid ID to a unique number.
virtual bool	valid () const
	returns true if this instance represents a real RTI object.
virtual int	invalidId () const
	returns 0, if the object is valid, 1, if the object is invalid and not unique >1, if the object is unique (created as a placeholder)
const char *	string () const
Static Public Member Functions
static const DtObjectId &	nullId ()
static const DtObjectId &	defaultId ()
Protected Attributes
RTI::ObjectInstanceHandle	myId
int	myValidityFlag
Static Protected Attributes
static int	nextPlaceholderNumber
Private Attributes
DtString	myMutableStringRep
	This is a cashed value which is computed in string()

---

Detailed Description

DtObjectId instances are used to represent RTI::ObjectInstances in VR-Link.

In HLA 13 DtObjects represent RTI::ObjectInstances. It is possible that an instance of a DtObject could be a placeholder for VR-Link and not correspond to an object in the RTI. In HLA 1516 DtObjects can be real objects, invalid objects, or invalid objects which are placeholders. The difference between invalid objects, and invalid objects which are placeholders is that the string() which is used to generate a hash key, will be the same for plane invalid objects, but for invalid objects which are placeholders, the string will be unique.

---

Constructor & Destructor Documentation

DtObjectId::DtObjectId

(

)

The Default constructor.

In 1516 this creates an invalid DtObject. When a DtObject is created using this default constructor it will have an invalid ID of 1.

DtObjectId::DtObjectId

(

RTI::ObjectInstanceHandle

id

)

DtObjectId::DtObjectId

(

const DtObjectId &

orig

)

---

Member Function Documentation

static const DtObjectId& DtObjectId::defaultId

(

)

[static]

virtual int DtObjectId::invalidId

(

)

const [virtual]

returns 0, if the object is valid, 1, if the object is invalid and not unique >1, if the object is unique (created as a placeholder)

virtual void DtObjectId::makePlaceholder

(

)

[virtual]

makePlaceholder() causes this object, if it is invalid, to have a unique DtObjectId Hash Key, by setting the invalid ID to a unique number.

static const DtObjectId& DtObjectId::nullId

(

)

[static]

DtObjectId::operator RTI::ObjectInstanceHandle

(

)

const

int DtObjectId::operator!=

(

const DtObjectId &

orig

)

const

bool DtObjectId::operator<

(

const DtObjectId &

orig

)

const

DtObjectId& DtObjectId::operator=

(

const DtObjectId &

orig

)

int DtObjectId::operator==

(

const DtObjectId &

orig

)

const

Equality operators.

const char* DtObjectId::string

(

)

const

virtual bool DtObjectId::valid

(

)

const [virtual]

returns true if this instance represents a real RTI object.

---

Member Data Documentation

RTI::ObjectInstanceHandle DtObjectId::myId [protected]

DtString DtObjectId::myMutableStringRep [mutable, private]

This is a cashed value which is computed in string()

int DtObjectId::myValidityFlag [protected]

int DtObjectId::nextPlaceholderNumber [static, protected]

---

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

• objectId.h