IdentContIndex Class Reference

Identifiable container index to a contained object. More...

#include <IdentContIndex.h>

Collaboration diagram for IdentContIndex:

Public Member Functions
	IdentContIndex ()
	Constructors. More...
	IdentContIndex (unsigned short collHash, unsigned short objIndex)
	IdentContIndex (unsigned int hashAndIndex)
unsigned short	collHash () const
	Accessor to hash, obj index and combined index. More...
unsigned short	objIndex () const
	object index in collection More...
unsigned int	hashAndIndex () const
	combined index More...
bool	isValid () const
	check that both fields are set More...
void	setHashAndIndex (unsigned int hashAndIndex)
	Setters of hash, obj index and combined index. More...
void	setCollHash (unsigned short hash)
	set object index in collection More...
void	setObjIndex (unsigned short index)
	set combined index More...

Private Attributes
unsigned short	m_collHash
unsigned short	m_objIndex

Detailed Description

Identifiable container index to a contained object.

IdentContIndex is a helper class used in conjunction with IdentContIndexingPolicy to create a compound index to an object in an identifiable container. The index is composed of the hash id of the collection and the index of a object in the collection. An IdentContIndex provides an unsigned int compound, composed of two 16 bit hash id and collection index.

Author

RD Schaffer

Id

IdentContIndex.h,v 1.2 2007-06-14 22:41:47 ssnyder Exp

Definition at line 22 of file IdentContIndex.h.

Constructor & Destructor Documentation

IdentContIndex() [1/3]

IdentContIndex::IdentContIndex ( )

inline

Constructors.

Definition at line 63 of file IdentContIndex.h.

        :
    m_collHash(0xFFFF),
        m_objIndex(0xFFFF)
{}

IdentContIndex() [2/3]

IdentContIndex::IdentContIndex ( unsigned short  collHash, unsigned short  objIndex  )

inline

Definition at line 70 of file IdentContIndex.h.

        :
    m_collHash(collHash),
        m_objIndex(objIndex)
{}

IdentContIndex() [3/3]

IdentContIndex::IdentContIndex ( unsigned int  hashAndIndex )

inline

Definition at line 77 of file IdentContIndex.h.

{
    setHashAndIndex(hashAndIndex);
}

Member Function Documentation

collHash()

unsigned short IdentContIndex::collHash ( ) const

inline

Accessor to hash, obj index and combined index.

collection hash id

Definition at line 85 of file IdentContIndex.h.

{
    return (m_collHash);
}

hashAndIndex()

unsigned int IdentContIndex::hashAndIndex ( ) const

inline

combined index

Definition at line 99 of file IdentContIndex.h.

{
    // Concatenate hash and index
    unsigned int result = (m_collHash << 16) + m_objIndex;
    return (result);
}

isValid()

bool IdentContIndex::isValid ( ) const

inline

check that both fields are set

Definition at line 108 of file IdentContIndex.h.

{
    // is valid if both hash and index are not default values
    return (m_collHash != 0xFFFF && m_objIndex != 0xFFFF);
}

objIndex()

unsigned short IdentContIndex::objIndex ( ) const

inline

object index in collection

Definition at line 92 of file IdentContIndex.h.

{
    return (m_objIndex);
}

setCollHash()

void IdentContIndex::setCollHash ( unsigned short  hash )

inline

set object index in collection

Definition at line 126 of file IdentContIndex.h.

{
    m_collHash = hash;
}

setHashAndIndex()

void IdentContIndex::setHashAndIndex ( unsigned int  hashAndIndex )

inline

Setters of hash, obj index and combined index.

set collection hash id

Definition at line 117 of file IdentContIndex.h.

{
    // Extract hash and index
    m_collHash = static_cast<unsigned short> (hashAndIndex >> 16);
    m_objIndex = static_cast<unsigned short> (hashAndIndex & 0xFFFF);
}

setObjIndex()

void IdentContIndex::setObjIndex ( unsigned short  index )

inline

set combined index

Definition at line 133 of file IdentContIndex.h.

{
    m_objIndex = index;
}

Member Data Documentation

m_collHash

unsigned short IdentContIndex::m_collHash

private

Definition at line 54 of file IdentContIndex.h.

m_objIndex

unsigned short IdentContIndex::m_objIndex

private

Definition at line 55 of file IdentContIndex.h.

---

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

• IdentContIndex.h