VR-Link API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
DtObjectIdHashKey Class Reference

Instances of DtObjectIdHashKey are hash keys made from DtObjectIds. More...

+ Inheritance diagram for DtObjectIdHashKey:
+ Collaboration diagram for DtObjectIdHashKey:

Public Member Functions

 DtObjectIdHashKey ()
 empty constructor
 DtObjectIdHashKey (const DtObjectId &id)
 default constructor
virtual ~DtObjectIdHashKey ()
 destructor
 DtObjectIdHashKey (const DtObjectIdHashKey &orig)
 copy constructor
DtObjectIdHashKeyoperator= (const DtObjectIdHashKey &orig)
 assignment operator
virtual bool operator== (const DtBaseHashKey &other) const
 Override equality operator to NOT use stringRep(), as this is expensive.
virtual DtBaseHashKeyclone () const
 Make a copy of this hash key.
virtual const DtObjectIdvalue () const
 Get hash key value.
virtual DtHashKeyType hashKeyType () const
 Get the type of HashKey.
- Public Member Functions inherited from DtBaseHashKey
 DtBaseHashKey ()
 default constructor
virtual ~DtBaseHashKey ()
 destructor
 DtBaseHashKey (const DtBaseHashKey &orig)
 copy constructor
DtBaseHashKeyoperator= (const DtBaseHashKey &orig)
 assignment operator
virtual bool operator!= (const DtBaseHashKey &other) const
 equality operator
virtual DtU32 hashValue () const
 Get the hashed value for this key.
virtual bool equalTo (const DtBaseHashKey &otherKey) const
 Subclasses may override this to provide an optimized comparison between two keys.

Protected Member Functions

virtual const DtString stringRep () const
 Get the string representation of this key.
virtual DtU64 computeHashValue ()
 Compute the hashed value for this key.

Protected Attributes

DtObjectId myId
- Protected Attributes inherited from DtBaseHashKey
bool myHashValueIsComputed
 myHashValueIsComputed is modified in hashValue()
DtU32 myHashValue
 myHashValue is modified in the const function hashValue()

Detailed Description

Instances of DtObjectIdHashKey are hash keys made from DtObjectIds.

They can be used with DtBaseHashList to store arbitrary pieces of data hashed by DtObjectId.

Constructor & Destructor Documentation

DtObjectIdHashKey::DtObjectIdHashKey ( )

empty constructor

DtObjectIdHashKey::DtObjectIdHashKey ( const DtObjectId id)

default constructor

virtual DtObjectIdHashKey::~DtObjectIdHashKey ( )
virtual

destructor

DtObjectIdHashKey::DtObjectIdHashKey ( const DtObjectIdHashKey orig)

copy constructor

Member Function Documentation

virtual DtBaseHashKey* DtObjectIdHashKey::clone ( ) const
virtual

Make a copy of this hash key.

Implements DtBaseHashKey.

virtual DtU64 DtObjectIdHashKey::computeHashValue ( )
protectedvirtual

Compute the hashed value for this key.

Implements DtBaseHashKey.

virtual DtHashKeyType DtObjectIdHashKey::hashKeyType ( ) const
inlinevirtual

Get the type of HashKey.

Reimplemented from DtBaseHashKey.

References DtObjectIdHashKeyType.

DtObjectIdHashKey& DtObjectIdHashKey::operator= ( const DtObjectIdHashKey orig)

assignment operator

virtual bool DtObjectIdHashKey::operator== ( const DtBaseHashKey other) const
virtual

Override equality operator to NOT use stringRep(), as this is expensive.

Reimplemented from DtBaseHashKey.

virtual const DtString DtObjectIdHashKey::stringRep ( ) const
protectedvirtual

Get the string representation of this key.

Implements DtBaseHashKey.

virtual const DtObjectId& DtObjectIdHashKey::value ( ) const
virtual

Get hash key value.

Member Data Documentation

DtObjectId DtObjectIdHashKey::myId
protected

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

Document ID: Generated on Wed Jan 7 13:31:29 EST 2015 from SVN revision 149162
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)