Collapse all Symbian^3 Application Developer Library

CStreamDictionary Class Reference

class CStreamDictionary : public CBase

Maintains two way associations between a UID (a TUid type) and a stream id (a TStreamId type) .

Each UID and stream id pair forms an entry in an array. The class provides member functions to manage these entries, for example, to add a new entry or to change the stream id associated with a UID.

TUid TStreamId CDictionaryStore

Inherits from

CStreamDictionary
- CBase

Nested Classes and Structures

CStreamDictionary::TEntry

Public Member Functions
	CStreamDictionary ()
	~CStreamDictionary ()
IMPORT_C void	AssignL ( TUid , TStreamId )
IMPORT_C TStreamId	At ( TUid )
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C void	InternalizeL ( RReadStream &)
IMPORT_C TBool	IsNull ()
IMPORT_C CStreamDictionary *	NewL ()
IMPORT_C CStreamDictionary *	NewLC ()
IMPORT_C void	Remove ( TUid )

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CArrayFixSeg < TEntry >	iArray

Constructor & Destructor Documentation

CStreamDictionary()

IMPORT_C

CStreamDictionary

(

)

~CStreamDictionary()

IMPORT_C

~CStreamDictionary

(

)

Frees resources owned by the object, prior to its destruction.

Member Functions Documentation

AssignL(TUid, TStreamId)

IMPORT_C void	AssignL	(	TUid	aUid,
			TStreamId	anId
		)

Creates or changes an association between a UID and a stream id.

If the stream dictionary already contains an entry with the same UID as aUid, then the associated stream id in that entry is replaced by anId.

If anId has the value KNullStreamId, then the function attempts to remove the entry whose unique identifier matches aUid.

CStreamDictionary::Remove()

Parameters

TUid aUid	The UID
TStreamId anId	The stream id.

At(TUid)

IMPORT_C TStreamId

(

TUid

aUid

)

const

Returns the stream id associated with the specified UID.

Parameters

TUid aUid

The UID whose associated stream id is to be returned.

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises an object of this class to a write stream.

The presence of this function means that the standard templated operator<<() can be used to externalise objects of this class.

Parameters

RWriteStream & aStream

Stream to which the object should be externalised

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises an object of this class from a read stream.

The presence of this function means that the standard templated operator>>() can be used to internalise objects of this class.

Note that this function has assignment semantics. It replaces the old value of the object with a new value read from the read stream.

Parameters

RReadStream & aStream

Stream from which the object should be internalised.

IsNull()

IMPORT_C TBool

IsNull

(

)

const

Tests whether the stream dictionary is empty.

NewL()

IMPORT_C CStreamDictionary *

NewL

(

)

[static]

Allocates, constructs and returns a pointer to a new stream dictionary.

The function leaves if it cannot complete successfully.

NewLC()

IMPORT_C CStreamDictionary *

NewLC

(

)

[static]

Allocates, constructs and returns a pointer to a new stream dictionary, putting the pointer onto the cleanup stack.

Putting the pointer onto the cleanup stack allows the object and allocated resources to be cleaned up if a subsequent leave occurs.

The function leaves if it cannot complete successfully.

Remove(TUid)

IMPORT_C void

Remove

(

TUid

aUid

)

Removes an association from the stream dictionary.

The function searches the stream dictionary for an entry whose UID matches aUid. If a match is found, the entry is removed. If no match is found, the stream dictionary remains unchanged.

Parameters

TUid aUid

The UID whose matching entry is to be removed from the stream dictionary.

Member Data Documentation

CArrayFixSeg< TEntry > iArray

CArrayFixSeg < TEntry >

iArray

[private]