TBtreeToken Class Reference

#include <s32btree.h>

Link against: estor.lib

class TBtreeToken
Public Member Enumerations
enumTEmpty { EEmpty }
Public Member Functions
TBtreeToken()
TBtreeToken(TEmpty)
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)
TBool IsBroken()
TBool IsEmpty()
TBool IsIntact()
voidTouch()
Protected Member Functions
IMPORT_C voidClear()

Detailed Description

Encapsulates the persistent parameters for a TBtree.

Member Enumeration Documentation

Enum TEmpty

Provides a TBtreeToken initialisation flag.

EnumeratorValueDescription
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 voidClear()[protected]

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Externalises a TBtreeToken object to a stream.

ParameterDescription
aStreamStream to which the object should be externalised.

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises a TBtreeToken object from a stream.

ParameterDescription
aStreamStream from which the object should be internalised.

IsBroken ( )

TBool IsBroken()const [inline]

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

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

IsEmpty ( )

TBool IsEmpty()const [inline]

Tests if the B-tree is empty.

Returns: 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 .

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

Touch ( )

voidTouch()[inline]

Marks the B-tree as broken.

© Nokia 2011.