AttrListIndexes Class Reference

Indexes to attribute name, type name and object value for the persistent storage of an attribute list. More...

#include <AttrListIndexes.h>

Collaboration diagram for AttrListIndexes:

Public Member Functions
	AttrListIndexes ()
	AttrListIndexes (unsigned short nameIndex, unsigned short typeIndex, unsigned short objIndex)
	AttrListIndexes (unsigned short typeIndex, unsigned short objIndex)
	AttrListIndexes (unsigned int combinedIndex)
unsigned short	nameIndex () const
	Index into attribute name vector.
unsigned short	typeIndex () const
	Index into the type name vector.
unsigned short	objIndex () const
	Index into the type-specific value vectors - type index identifies which one.
unsigned int	combinedIndex () const
	Access to the bit-packed value.
bool	isValid () const
	Uninitialized index is NOT valid.
void	setCombinedIndex (unsigned int combinedIndex)
void	setAttrIndex (unsigned short nameIndex)
void	setTypeIndex (unsigned short typeIndex)
void	setObjIndex (unsigned short index)

Private Attributes
unsigned short	m_typeIndex
unsigned short	m_objIndex

Detailed Description

Indexes to attribute name, type name and object value for the persistent storage of an attribute list.

The attribute and type names are stored in individual vectors, but the object value is stored in one of serveral type-specific vectors.

Author

RD Schaffer

Id

AttrListIndexes.h,v 1.2 2008-10-13 15:12:05 schaffer Exp

Definition at line 19 of file AttrListIndexes.h.

Constructor & Destructor Documentation

AttrListIndexes() [1/4]

AttrListIndexes::AttrListIndexes ( )

inline

Definition at line 58 of file AttrListIndexes.h.

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

AttrListIndexes() [2/4]

AttrListIndexes::AttrListIndexes ( unsigned short nameIndex, unsigned short typeIndex, unsigned short objIndex )

inline

Definition at line 65 of file AttrListIndexes.h.

        :
        // m_typeIndex: 10 bits nameIndex + 6 bits typeIndex:
    m_typeIndex( ((nameIndex & 0x03FF) << 6) | (typeIndex & 0x003F)),
        m_objIndex(objIndex)
{}

AttrListIndexes() [3/4]

AttrListIndexes::AttrListIndexes ( unsigned short typeIndex, unsigned short objIndex )

inline

Definition at line 74 of file AttrListIndexes.h.

        :
    m_typeIndex(typeIndex & 0x003F),
        m_objIndex(objIndex)
{}

AttrListIndexes() [4/4]

AttrListIndexes::AttrListIndexes ( unsigned int combinedIndex )

inline

Definition at line 81 of file AttrListIndexes.h.

{
    setCombinedIndex(combinedIndex);
}

Member Function Documentation

combinedIndex()

unsigned int AttrListIndexes::combinedIndex ( ) const

inline

Access to the bit-packed value.

Definition at line 110 of file AttrListIndexes.h.

{
    // Concatenate type and obj indexes
    unsigned int result = (m_typeIndex << 16) + m_objIndex;
    return (result);
}

isValid()

bool AttrListIndexes::isValid ( ) const

inline

Uninitialized index is NOT valid.

Definition at line 119 of file AttrListIndexes.h.

{
    // is valid if both type and obj indexes are not default values
    return (m_typeIndex != 0xFFFF && m_objIndex != 0xFFFF);
}

nameIndex()

unsigned short AttrListIndexes::nameIndex ( ) const

inline

Index into attribute name vector.

Definition at line 89 of file AttrListIndexes.h.

{
    return ((m_typeIndex >> 6) & 0x03FF);
}

objIndex()

unsigned short AttrListIndexes::objIndex ( ) const

inline

Index into the type-specific value vectors - type index identifies which one.

Definition at line 103 of file AttrListIndexes.h.

{
    return (m_objIndex);
}

setAttrIndex()

void AttrListIndexes::setAttrIndex ( unsigned short nameIndex )

inline

Definition at line 137 of file AttrListIndexes.h.

{
    // add in only the attribute index, keeping the type index
    m_typeIndex = ((index & 0x03FF) << 6) | (m_typeIndex & 0x003F);
}

setCombinedIndex()

void AttrListIndexes::setCombinedIndex ( unsigned int combinedIndex )

inline

Definition at line 128 of file AttrListIndexes.h.

{
    // Extract type and obj indexes
    m_typeIndex = combinedIndex >> 16;
    m_objIndex = combinedIndex & 0xFFFF;
}

setObjIndex()

void AttrListIndexes::setObjIndex ( unsigned short index )

inline

Definition at line 154 of file AttrListIndexes.h.

{
    m_objIndex = index;
}

setTypeIndex()

void AttrListIndexes::setTypeIndex ( unsigned short typeIndex )

inline

Definition at line 146 of file AttrListIndexes.h.

{
    // add in only the type index, keeping the attribute index
    m_typeIndex = (m_typeIndex & 0x03FF) | (index & 0x003F);
}

typeIndex()

unsigned short AttrListIndexes::typeIndex ( ) const

inline

Index into the type name vector.

Definition at line 96 of file AttrListIndexes.h.

{
    return (m_typeIndex & 0x003F);
}

Member Data Documentation

m_objIndex

unsigned short AttrListIndexes::m_objIndex

private

Definition at line 50 of file AttrListIndexes.h.

m_typeIndex

unsigned short AttrListIndexes::m_typeIndex

private

Definition at line 49 of file AttrListIndexes.h.

---

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

• AttrListIndexes.h