Collapse all Symbian^3 Product Developer Library

TBtreeToken Class Reference

class TBtreeToken

Encapsulates the persistent parameters for a TBtree.

Public Member Functions
	TBtreeToken()
	TBtreeToken(TEmpty)
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
TBool	IsBroken()
TBool	IsEmpty()
TBool	IsIntact()
void	Touch()

Protected Member Functions
IMPORT_C void	Clear()

Private Member Functions
	TBtreeToken(TPageRef, TPageRef, TBtreeHeight)

Public Member Enumerations
enum	TEmpty { EEmpty }

Private Attributes
TPageRef	iFirst
TBtreeHeight	iHeight
TPageRef	iRoot

Constructor & Destructor Documentation

TBtreeToken()

TBtreeToken

(

)

[inline]

Default constuctor.

TBtreeToken(TEmpty)

TBtreeToken

(

TEmpty

)

[inline]

Constructor that intialises the TBtreeToken for an empty B-tree.

Parameters

TEmpty

TBtreeToken(TPageRef, TPageRef, TBtreeHeight)

TBtreeToken	(	TPageRef	aFirst,
		TPageRef	aRoot,
		TBtreeHeight	aHeight
	)	[private, inline]

Parameters

TPageRef aFirst
TPageRef aRoot
TBtreeHeight aHeight

Member Functions Documentation

Clear()

IMPORT_C void

Clear

(

)

[protected]

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises a TBtreeToken object to a stream.

Parameters

RWriteStream & aStream

Stream to which the object should be externalised.

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises a TBtreeToken object from a stream.

Parameters

RReadStream & aStream

Stream from which the object should be internalised.

IsBroken()

TBool

IsBroken

(

)

const [inline]

Tests if the broken flag has been set on the B-tree.

IsEmpty()

TBool

IsEmpty

(

)

const [inline]

Tests if the B-tree is empty.

IsIntact()

TBool

IsIntact

(

)

const [inline]

Tests if the broken flag has not been set on the B-tree .

Touch()

void

Touch

(

)

[inline]

Marks the B-tree as broken.

Member Enumerations Documentation

Enum TEmpty

Provides a TBtreeToken initialisation flag.

Enumerators

EEmpty

Member Data Documentation

TPageRef iFirst

TPageRef

iFirst

[private]

TBtreeHeight iHeight

TBtreeHeight

iHeight

[private]

TPageRef iRoot

TPageRef

iRoot

[private]