TBtreeKey Class Reference

#include <s32btree.h>

Link against: estor.lib

class TBtreeKey : public MBtreeKey

Inherits from

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

Member Attribute Documentation

iCmpType

TInt iCmpType[protected]

iKeyLength

TInt iKeyLength[protected]

iKeyOffset

TInt iKeyOffset[protected]

Constructor & Destructor Documentation

TBtreeKey ( )

IMPORT_CTBtreeKey()

TBtreeKey ( TInt )

IMPORT_CTBtreeKey(TIntaLength)

TBtreeKey ( TInt, TKeyCmpText )

IMPORT_CTBtreeKey(TIntanOffset,
TKeyCmpTextaType
)

TBtreeKey ( TInt, TKeyCmpText, TInt )

IMPORT_CTBtreeKey(TIntanOffset,
TKeyCmpTextaType,
TIntaLength
)

TBtreeKey ( TInt, TKeyCmpNumeric )

IMPORT_CTBtreeKey(TIntanOffset,
TKeyCmpNumericaType
)

Member Function 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
aLeftFirst key
aRightSecond key
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
aLeftPointer to first key
aRightPointer to second key
Return Value
Positive, if the first key is after the second key; negative, if the first key is before the second key; zero, if the keys are equal

Key ( const TAny * )

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

Gets the key value for an entry.

Parameters
anEntryObject for which to get the key value
Return Value
Pointer to the key value
© Nokia 2005.