TBtreeKey Class Reference

class TBtreeKey : public MBtreeKey

Inherits from

Public Member Functions
TBtreeKey()
TBtreeKey(TInt)
TBtreeKey(TInt, TKeyCmpText)
TBtreeKey(TInt, TKeyCmpText, TInt)
TBtreeKey(TInt, TKeyCmpNumeric)
IMPORT_C voidBetween(const TAny *, const TAny *, TBtreePivot &)
IMPORT_C TIntCompare(const TAny *, const TAny *)
IMPORT_C const TAny *Key(const TAny *)
Protected Attributes
TInt iCmpType
TInt iKeyLength
TInt iKeyOffset

Constructor & Destructor Documentation

TBtreeKey()

IMPORT_CTBtreeKey()

TBtreeKey(TInt)

IMPORT_CTBtreeKey(TIntaLength)

Parameters

TInt aLength

TBtreeKey(TInt, TKeyCmpText)

IMPORT_CTBtreeKey(TIntanOffset,
TKeyCmpTextaType
)

Parameters

TInt anOffset
TKeyCmpText aType

TBtreeKey(TInt, TKeyCmpText, TInt)

IMPORT_CTBtreeKey(TIntanOffset,
TKeyCmpTextaType,
TIntaLength
)

Parameters

TInt anOffset
TKeyCmpText aType
TInt aLength

TBtreeKey(TInt, TKeyCmpNumeric)

IMPORT_CTBtreeKey(TIntanOffset,
TKeyCmpNumericaType
)

Parameters

TInt anOffset
TKeyCmpNumeric aType

Member Functions Documentation

Between(const TAny *, const TAny *, TBtreePivot &)

IMPORT_C voidBetween(const TAny *aLeft,
const TAny *aRight,
TBtreePivot &aPivot
)const [virtual]

Gets the midpoint between two keys.

The generated midpoint will be greater or equal to aLeft (by a comparison performed by the Compare() function), and less than aRight.

Parameters

const TAny * aLeftFirst key
const TAny * aRightSecond key
TBtreePivot & aPivotOn return, the midpoint between the two keys

Compare(const TAny *, const TAny *)

IMPORT_C TIntCompare(const TAny *aLeft,
const TAny *aRight
)const [virtual]

Orders two keys.

Parameters

const TAny * aLeftPointer to first key
const TAny * aRightPointer to second key

Key(const TAny *)

IMPORT_C const TAny *Key(const TAny *anEntry)const [virtual]

Gets the key value for an entry.

Parameters

const TAny * anEntryObject for which to get the key value

Member Data Documentation

TInt iCmpType

TInt iCmpType[protected]

TInt iKeyLength

TInt iKeyLength[protected]

TInt iKeyOffset

TInt iKeyOffset[protected]