Symbian^3 Application Developer Library >

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 void Between (const TAny *, const TAny *, TBtreePivot &)
IMPORT_C TInt Compare (const TAny *, const TAny *)
IMPORT_C const TAny * Key (const TAny *)
Protected Attributes
TInt iCmpType
TInt iKeyLength
TInt iKeyOffset

Constructor & Destructor Documentation

TBtreeKey()

IMPORT_C TBtreeKey ( )

TBtreeKey(TInt)

IMPORT_C TBtreeKey ( TInt aLength )

Parameters

TInt aLength

TBtreeKey(TInt, TKeyCmpText)

IMPORT_C TBtreeKey ( TInt anOffset,
TKeyCmpText aType
)

Parameters

TInt anOffset
TKeyCmpText aType

TBtreeKey(TInt, TKeyCmpText, TInt)

IMPORT_C TBtreeKey ( TInt anOffset,
TKeyCmpText aType,
TInt aLength
)

Parameters

TInt anOffset
TKeyCmpText aType
TInt aLength

TBtreeKey(TInt, TKeyCmpNumeric)

IMPORT_C TBtreeKey ( TInt anOffset,
TKeyCmpNumeric aType
)

Parameters

TInt anOffset
TKeyCmpNumeric aType

Member Functions Documentation

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

IMPORT_C void Between ( 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 * aLeft First key
const TAny * aRight Second key
TBtreePivot & aPivot On return, the midpoint between the two keys

Compare(const TAny *, const TAny *)

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

Orders two keys.

Parameters

const TAny * aLeft Pointer to first key
const TAny * aRight Pointer 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 * anEntry Object 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]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.