TBtreeFix Class Reference

#include <s32btree.h>

class TBtreeFix : public TBtreeFixBase

Inherits from

TBtreeFix
- TBtreeFixBase
  - TBtree

Public Member Functions
	TBtreeFix(TBtreeMode)
	TBtreeFix(const TBtreeToken &, TBtreeMode)
Entry	AtL(const TBtreePos &)
Entry	AtL(const TBtreeMark &)
TBool	DeleteL(const Key &)
void	ExtractAtL(const TBtreePos &, Entry &)
void	ExtractAtL(const TBtreeMark &, Entry &)
TBool	FindL(TBtreePos &, const Key &, TFind)
TBool	InsertL(TBtreePos &, const Entry &, TAllowDuplicates)

Inherited Enumerations
	TBtree:TFind

Inherited Functions
	TBtree::ClearL()
	TBtree::Connect(MPagePool ,const MBtreeKey ,const MBtreeLeafOrg ,const MBtreeIndexOrg )
	TBtree::DeleteAtL(TBtreePos &)
	TBtree::DeleteL(const TAny *)
	TBtree::ExtractAtL(const TBtreeMark &,TAny *,TInt)const
	TBtree::ExtractAtL(const TBtreePos &,TAny *,TInt)const
	TBtree::FindL(TBtreePos &,const TAny *,TFind)const
	TBtree::FirstL(TBtreePos &)const
	TBtree::InsertL(TBtreePos &,const TAny *,TInt,TAllowDuplicates)
	TBtree::IsBroken()const
	TBtree::IsDirty()const
	TBtree::IsEmpty()const
	TBtree::IsIntact()const
	TBtree::LastL(TBtreePos &)const
	TBtree::MarkBroken()
	TBtree::MarkCurrent()
	TBtree::MarkDirty()
	TBtree::NextL(TBtreeMark &)const
	TBtree::NextL(TBtreePos &)const
	TBtree::PreviousL(TBtreePos &)const
	TBtree::RepairL()
	TBtree::ResetL(TBtreeMark &)const
	TBtree::Set(const TBtreeToken &,TBtreeMode)
	TBtree::TBtree(TBtreeMode)
	TBtree::TBtree(const TBtreeToken &,TBtreeMode)
	TBtree::Token()const
	TBtreeFixBase::Connect(MPagePool ,const MBtreeKey )
	TBtreeFixBase::ExtractAtL(const TBtreeMark &,TAny *)const
	TBtreeFixBase::ExtractAtL(const TBtreePos &,TAny *)const
	TBtreeFixBase::InsertL(TBtreePos &,const TAny *,TAllowDuplicates)
	TBtreeFixBase::TBtreeFixBase(TBtreeMode,TInt,TInt)
	TBtreeFixBase::TBtreeFixBase(const TBtreeToken &,TBtreeMode,TInt,TInt)

Detailed 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.

Constructor & Destructor Documentation

TBtreeFix ( TBtreeMode )

TBtreeFix

(

TBtreeMode

aMode

)

[inline]

Constructor that sets the B-tree mode.

Parameters
aMode	B-tree operating mode

TBtreeFix ( const TBtreeToken &, TBtreeMode )

TBtreeFix	(	const TBtreeToken &	aToken,
		TBtreeMode	aMode
	)	[inline]

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

Parameters
aToken	Parameters with which to initialise the B-tree
aMode	B-tree operating mode

Member Function Documentation

AtL ( const TBtreePos & )

Entry

AtL

(

const TBtreePos &

aPos

)

const [inline]

Gets the entry at the specified position.

Parameters
aPos	Position of the entry to get

Return Value: Entry at position aPos

AtL ( const TBtreeMark & )

Entry

AtL

(

const TBtreeMark &

aMark

)

const [inline]

Gets the entry at the specified iterator position.

Parameters
aMark	Iterator to use to get the entry

Return Value: Entry at current iterator position

DeleteL ( const Key & )

TBool

DeleteL

(

const Key &

aKey

)

[inline]

Delete an entry.

Parameters
aKey	Key of the entry to delete

Return Value: True if successful, false if the entry was not found

ExtractAtL ( const TBtreePos &, Entry & )

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

Gets the entry at the specified position.

Parameters
aPos	Position of the entry to get
anEntry	On return, the specified entry

ExtractAtL ( const TBtreeMark &, Entry & )

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

Gets the entry at the specified iterator position.

Parameters
aMark	Iterator to use to get the entry
anEntry	On return, the specified entry

FindL ( TBtreePos &, const Key &, TFind )

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

InsertL ( TBtreePos &, const Entry &, TAllowDuplicates )

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

Inserts an entry into the tree.

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

Return Value: True if successful, false if the entry was a duplicate and aDup was set to ENoDuplicates