Class TBtreeFix

class TBtreeFix : public TBtreeFixBase;

Description

A B-tree for fixed-sized keys and entries.

Entry is the type of entry to store. Key defines how items should be ordered: there must be a member of this type in the Entry class.

Derivation

• TBtree - ...

• TBtreeFixBase - Base class for TBtreeFix, which provides a B-tree for fixed sized entries.

• TBtreeFix - A B-tree for fixed-sized keys and entries.

Members

Defined in TBtreeFix:

• AtL(const TBtreeMark &)constGets the entry at the specified iterator position.
• AtL(const TBtreePos &)constGets the entry at the specified position.
• DeleteL(const Key &)Delete an entry.
• ExtractAtL(const TBtreeMark &,Entry &)constGets the entry at the specified iterator position.
• ExtractAtL(const TBtreePos &,Entry &)constGets the entry at the specified position.
• FindL(TBtreePos &,const Key &,TFind)const
• InsertL(TBtreePos &,const Entry &,TAllowDuplicates)Inserts an entry into the tree.
• TBtreeFix(TBtreeMode)Constructor that sets the B-tree mode.
• TBtreeFix(const TBtreeToken &,TBtreeMode)Constructor that sets the B-tree mode and initialisation parameters.

Inherited from TBtree:

• ClearL()Resets the B-tree to have zero-height, and a null root, and deletes all index pa...
• Connect(MPagePool *,const MBtreeKey *,const MBtreeLeafOrg *,const MBtreeIndexOrg *)
• DeleteAtL(TBtreePos &)Deletes the entry at the specified position
• DeleteL(const TAny *)Deletes an entry.
• EEqualToFind the first entry equal to the search target.
• EGreaterEqualFind the first entry greater than or equal to the search target.
• EGreaterThanFind the first entry greater than the search target.
• ELessEqualFind the last entry less than or equal to the search target.
• ELessThanFind the last entry less than the search target.
• ExtractAtL(const TBtreeMark &,TAny *,TInt)constGets an entry at specified iterator position.
• ExtractAtL(const TBtreePos &,TAny *,TInt)constGets the entry at the specified position.
• FindL(TBtreePos &,const TAny *,TFind)constSearches for an entry and returns its position.
• FirstL(TBtreePos &)constGoes to the first entry in the B-tree.
• InsertL(TBtreePos &,const TAny *,TInt,TAllowDuplicates)Inserts an entry into the tree.
• IsBroken()constTests if the broken flag has been set on the B-tree.
• IsDirty()constTests if the dirty flag has been set on the B-tree.
• IsEmpty()constTests if the B-tree is empty.
• IsIntact()constTests if the broken flag has not been set on the B-tree .
• LastL(TBtreePos &)constGoes to the last entry in the B-tree.
• MarkBroken()Sets the broken flag.
• MarkCurrent()Clears the dirty flag.
• MarkDirty()Sets the dirty flag.
• NextL(TBtreeMark &)constAdvances an iterator to the next entry.
• NextL(TBtreePos &)constGets the position of the entry following the specified entry.
• PreviousL(TBtreePos &)constGets the position of the entry preceding the specified entry.
• RepairL()Attempts to repair a broken B-tree.
• ResetL(TBtreeMark &)constResets an iterator to the root of the tree.
• Set(const TBtreeToken &,TBtreeMode)Initialises the B-tree.
• TBtree(TBtreeMode)Constructor that sets the B-tree mode.
• TBtree(const TBtreeToken &,TBtreeMode)Constructor that sets the B-tree mode and initialisation parameters.
• TFindSets the condition for a successful match when calling TBtree::Find().
• Token()constGets an object that encapsulates the TBtree settings.

Inherited from TBtreeFixBase:

• Connect(MPagePool *,const MBtreeKey *)Initalises the B-tree with a page pool and key handler.
• ExtractAtL(const TBtreeMark &,TAny *)constGets the entry at the specified iterator position.
• ExtractAtL(const TBtreePos &,TAny *)constGets the entry at the specified position.
• InsertL(TBtreePos &,const TAny *,TAllowDuplicates)Inserts an entry into the tree.
• TBtreeFixBase(TBtreeMode,TInt,TInt)
• TBtreeFixBase(const TBtreeToken &,TBtreeMode,TInt,TInt)

inline TBtreeFix(TBtreeMode aMode);

Description

Constructor that sets the B-tree mode.

Parameters

TBtreeMode aMode B-tree operating mode

inline TBtreeFix(const TBtreeToken &aToken, TBtreeMode aMode);

Description

Constructor that sets the B-tree mode and initialisation parameters.

Parameters

const TBtreeToken &aToken Parameters with which to initialise the B-tree TBtreeMode aMode B-tree operating mode

inline TBool FindL(TBtreePos &aPos, const Key &aKey, TFind aMode=EEqualTo) const;

Description

Parameters

TBtreePos &aPos const Key &aKey TBtree::TFind aMode

Return value

TBool

inline TBool InsertL(TBtreePos &aPos, const Entry &anEntry, TAllowDuplicates aDup=ENoDuplicates);

Description

Inserts an entry into the tree.

Parameters

TBtreePos &aPos On return, the position of the entry inserted const Entry &anEntry Entry to insert TAllowDuplicates aDup Flag to indicate whether duplicate entries are allowed in the tree

Return value

TBool True if successful, false if the entry was a duplicate and aDup was set to ENoDuplicates

inline TBool DeleteL(const Key &aKey);

Description

Delete an entry.

Parameters

const Key &aKey Key of the entry to delete

Return value

TBool True if successful, false if the entry was not found

inline Entry AtL(const TBtreePos &aPos) const;

Description

Gets the entry at the specified position.

Parameters

const TBtreePos &aPos Position of the entry to get

Return value

Entry Entry at position aPos

inline Entry AtL(const TBtreeMark &aMark) const;

Description

Gets the entry at the specified iterator position.

Parameters

const TBtreeMark &aMark Iterator to use to get the entry

Return value

Entry Entry at current iterator position

inline void ExtractAtL(const TBtreePos &aPos, Entry &anEntry) const;

Description

Gets the entry at the specified position.

Parameters

const TBtreePos &aPos Position of the entry to get Entry &anEntry On return, the specified entry

inline void ExtractAtL(const TBtreeMark &aMark, Entry &anEntry) const;

Description

Gets the entry at the specified iterator position.

Parameters

const TBtreeMark &aMark Iterator to use to get the entry Entry &anEntry On return, the specified entry