VR-Link API Documentation for HLA 1.3
Public Member Functions | Static Public Member Functions | Protected Attributes | Private Attributes
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::ObjectHandle id)
 DtObjectId (const char *str)
 This constructor from a string is not provided by the 1516 interface.
 DtObjectId (const DtNetObjectId &netId)
 This constructor from an integer is not allowed in 1516.
 DtObjectId (const DtObjectId &orig)
DtObjectIdoperator= (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::ObjectHandle () const
const char * string () const

Static Public Member Functions

static const DtObjectIdnullId ()
static const DtObjectIddefaultId ()

Protected Attributes

RTI::ObjectHandle myId

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

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::ObjectHandle  id)
DtObjectId::DtObjectId ( const char *  str)

This constructor from a string is not provided by the 1516 interface.

This constructor from an integer is not allowed in 1516.


Member Function Documentation

static const DtObjectId& DtObjectId::defaultId ( ) [static]
static const DtObjectId& DtObjectId::nullId ( ) [static]
DtObjectId::operator RTI::ObjectHandle ( ) 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

Member Data Documentation

RTI::ObjectHandle DtObjectId::myId [protected]

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


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

Document ID: Generated on Mon May 14 08:06:18 EDT 2012 from SVN revision 114750
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)