DtBaseHashKey Class Reference

DtBaseHashKey is an abstract base class for hash keys. More...

Inheritance diagram for DtBaseHashKey:

Collaboration diagram for DtBaseHashKey:

Public Member Functions
	DtBaseHashKey ()
	default constructor More...
virtual	~DtBaseHashKey ()
	destructor More...
	DtBaseHashKey (const DtBaseHashKey &orig)
	copy constructor More...
DtBaseHashKey &	operator= (const DtBaseHashKey &orig)
	assignment operator More...
virtual bool	operator== (const DtBaseHashKey &other) const
	equality operator More...
virtual bool	operator!= (const DtBaseHashKey &other) const
	equality operator More...
virtual DtU32	hashValue () const
	Get the hashed value for this key. More...
virtual DtHashKeyType	hashKeyType () const
	Get the type of HashKey. More...
virtual DtBaseHashKey *	clone () const =0
	Make a copy of this hash key. More...
virtual const DtString	stringRep () const =0
	Get the string representation of this key. More...
virtual bool	equalTo (const DtBaseHashKey &otherKey) const
	Subclasses may override this to provide an optimized comparison between two keys. More...

Protected Member Functions
virtual DtU64	computeHashValue ()=0
	Compute the hashed value for this key. More...

Protected Attributes
bool	myHashValueIsComputed
	myHashValueIsComputed is modified in hashValue() More...
DtU32	myHashValue
	myHashValue is modified in the const function hashValue() More...

Detailed Description

DtBaseHashKey is an abstract base class for hash keys.

DtHashlist has been deprecated, and replaced by std::map. This

Deprecated:

This class has been deprecated, see DtHashList

Constructor & Destructor Documentation

DtBaseHashKey::DtBaseHashKey

(

)

default constructor

virtual DtBaseHashKey::~DtBaseHashKey ( )

virtual

destructor

DtBaseHashKey::DtBaseHashKey

(

const DtBaseHashKey &

orig

)

copy constructor

Member Function Documentation

virtual DtBaseHashKey* DtBaseHashKey::clone ( ) const

pure virtual

Make a copy of this hash key.

Implemented in DtWStringHashKey, DtStringHashKey, DtPtrHashKey, DtIntHashKey, DtEventIdHashKey, DtEntityIdentifierHashKey, DtIFFSystemHashKey, and DtSystemHashKey.

virtual DtU64 DtBaseHashKey::computeHashValue ( )

protectedpure virtual

Compute the hashed value for this key.

Implemented in DtWStringHashKey, DtStringHashKey, DtPtrHashKey, DtIntHashKey, DtEventIdHashKey, DtIFFSystemHashKey, DtEntityIdentifierHashKey, and DtSystemHashKey.

virtual bool DtBaseHashKey::equalTo ( const DtBaseHashKey &  otherKey ) const

virtual

Subclasses may override this to provide an optimized comparison between two keys.

Base implementation calls operator== which uses strings to compare.

Reimplemented in DtPtrHashKey, and DtIntHashKey.

virtual DtHashKeyType DtBaseHashKey::hashKeyType ( ) const

inlinevirtual

Get the type of HashKey.

Reimplemented in DtWStringHashKey, DtStringHashKey, DtPtrHashKey, DtIntHashKey, DtEventIdHashKey, DtEntityIdentifierHashKey, DtIFFSystemHashKey, and DtSystemHashKey.

References DtBaseHashKeyType.

virtual DtU32 DtBaseHashKey::hashValue ( ) const

virtual

Get the hashed value for this key.

This may modify myHashValueIsComputed and myHashValue

virtual bool DtBaseHashKey::operator!= ( const DtBaseHashKey &  other ) const

virtual

equality operator

DtBaseHashKey& DtBaseHashKey::operator=

(

const DtBaseHashKey &

orig

)

assignment operator

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

virtual

equality operator

Reimplemented in DtEventIdHashKey, and DtEntityIdentifierHashKey.

virtual const DtString DtBaseHashKey::stringRep ( ) const

pure virtual

Get the string representation of this key.

Implemented in DtWStringHashKey, DtStringHashKey, DtPtrHashKey, DtIntHashKey, DtEventIdHashKey, DtEntityIdentifierHashKey, DtIFFSystemHashKey, and DtSystemHashKey.

Member Data Documentation

DtU32 DtBaseHashKey::myHashValue

mutableprotected

myHashValue is modified in the const function hashValue()

bool DtBaseHashKey::myHashValueIsComputed

mutableprotected

myHashValueIsComputed is modified in hashValue()

---

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

• vlHashKeys.h