TAgnEntryId Class Reference

class TAgnEntryId

The base class for agenda entry and instance ID types. Internally, the ID is stored as a 32-bit unsigned integer.

This is made up of a stream ID which stores the stream containing the entry, and a partial ID, which gives the position of the entry within that stream. There can be up to EMaxNumEntriesPerStream entries in a stream (16).

Public Member Functions
TAgnEntryId()
TAgnEntryId(const TStreamId &, TUint)
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)
IMPORT_C TBoolIsNullId()
IMPORT_C TUintPartialId()
voidSetStreamId(const TStreamId &)
TStreamId StreamId()
TUint Value()
IMPORT_C TBooloperator!=(const TAgnEntryId &)
IMPORT_C TBooloperator==(const TAgnEntryId &)
Private Member Functions
voidSetPartialId(TUint)
Protected Attributes
TUint32 iId

Constructor & Destructor Documentation

TAgnEntryId()

IMPORT_CTAgnEntryId()

TAgnEntryId(const TStreamId &, TUint)

IMPORT_CTAgnEntryId(const TStreamId &aStreamId,
TUintaPartialId
)

Parameters

const TStreamId & aStreamId
TUint aPartialId

Member Functions Documentation

ExternalizeL(RWriteStream &)

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Externalises the ID to a write stream.

The presence of this function means that the standard templated operator<<() is available to externalise objects of this class.

Parameters

RWriteStream & aStreamStream to which the ID should be externalised.

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises the ID from a read stream.

The presence of this function means that the standard templated operator>>() is available to internalise objects of this class.

Parameters

RReadStream & aStreamStream from which the ID should be internalised.

IsNullId()

IMPORT_C TBoolIsNullId()const

Tests whether the ID value has been set.

If not set, its value is zero.

PartialId()

IMPORT_C TUintPartialId()const

SetPartialId(TUint)

voidSetPartialId(TUintaId)[private]

Parameters

TUint aId

SetStreamId(const TStreamId &)

voidSetStreamId(const TStreamId &aId)

Parameters

const TStreamId & aId

StreamId()

TStreamId StreamId()const [inline]

Value()

TUint Value()const [inline]

operator!=(const TAgnEntryId &)

IMPORT_C TBooloperator!=(const TAgnEntryId &aId)const

Compares two IDs for inequality.

Parameters

const TAgnEntryId & aIdThe ID to compare with this one.

operator==(const TAgnEntryId &)

IMPORT_C TBooloperator==(const TAgnEntryId &aId)const

Compares two IDs for equivalence.

Parameters

const TAgnEntryId & aIdThe ID to compare with this one.

Member Data Documentation

TUint32 iId

TUint32 iId[protected]