TBtreeToken Class Reference

#include <s32btree.h>

Link against: estor.lib

class TBtreeToken

Public Member Enumerations
enum	TEmpty { EEmpty }

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()

Detailed Description

Encapsulates the persistent parameters for a TBtree.

Member Enumeration Documentation

Enum TEmpty

Provides a TBtreeToken initialisation flag.

Enumerator	Value	Description
EEmpty

Constructor & Destructor Documentation

TBtreeToken ( )

TBtreeToken

(

)

[inline]

Default constuctor.

TBtreeToken ( TEmpty )

TBtreeToken

(

TEmpty

)

[inline]

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

Member Function Documentation

Clear ( )

IMPORT_C void

Clear

(

)

[protected]

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises a TBtreeToken object to a stream.

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

Return Value: True if the B-tree is broken, otherwise false.

IsEmpty ( )

TBool

IsEmpty

(

)

const [inline]

Tests if the B-tree is empty.

Return Value: True if the B-tree is empty, otherwise false.

IsIntact ( )

TBool

IsIntact

(

)

const [inline]

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

Return Value: True if the B-tree is not broken, otherwise false.

Touch ( )

void

Touch

(

)

[inline]

Marks the B-tree as broken.