Class TBtreeFix

template <class Entry,class Key> class TBtreeFix

Support

Supported from 5.0

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 Provides ordering of entries by key value in a B+-tree (balanced tree) structure TBtreeFix A B-tree for fixed-sized keys and entries TBtreeFixBase Base class for TBtreeFix, which provides a B-tree for fixed sized entries

Defined in TBtreeFix:
AtL(), DeleteL(), ExtractAtL(), FindL(), InsertL(), TBtreeFix()

Inherited from TBtree:
ClearL(), DeleteAtL(), EEqualTo, EGreaterEqual, EGreaterThan, ELessEqual, ELessThan, FirstL(), IsBroken(), IsDirty(), IsEmpty(), IsIntact(), LastL(), MarkBroken(), MarkCurrent(), MarkDirty(), NextL(), PreviousL(), RepairL(), ResetL(), Set(), TFind, Token()

Inherited from TBtreeFixBase:
Connect()

TBtreeFix(TBtreeMode aMode);

Description

Constructor that sets the B-tree mode.

Parameters

TBtreeMode aMode B-tree operating mode

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

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

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

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

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

Description

Searches for an entry and returns its position.

Parameters

TBtreePos& aPos On return, the position of the entry found const Key& aKey Key of the entry for which to search TFind aMode=EEqualTo Type of search to perform

Return value

TBool True if search was successful, otherwise false

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=ENoDuplicates 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

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

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