CParameterSetContainer Class Reference

#include <comms-infras/es_parameterbundle.h>

class CParameterSetContainer : public CBase, public Meta::MMetaType

Inherits from

CParameterSetContainer
- CBase

Public Member Functions
virtual	~CParameterSetContainer()
IMPORT_C TInt	AddParameterSet(XParameterSetBase *)
IMPORT_C void	AddParameterSetL(XParameterSetBase *)
void	ClearParameterSetPointer(TInt)
TInt	CountParameterSets()
IMPORT_C TInt	DeleteParameterSet(TInt)
IMPORT_C void	DeleteParameterSetL(TInt)
IMPORT_C XParameterSetBase *	FindParameterSet(const Meta::STypeId &)
const XParameterSetBase *	FindParameterSet(const Meta::STypeId &)
IMPORT_C TBool	FindParameterSet(const XParameterSetBase &)
IMPORT_C XParameterSetBase *	GetParameterSet(TInt)
const XParameterSetBase *	GetParameterSet(TInt)
IMPORT_C TInt	GrowToFit(TInt)
IMPORT_C void	GrowToFitL(TInt)
TUint32	Id()
virtual IMPORT_C TInt	Length()
virtual IMPORT_C TInt	Load(TPtrC8 &)
IMPORT_C CParameterSetContainer *	LoadL(CParameterBundleBase &, TPtrC8 &)
IMPORT_C CParameterSetContainer *	LoadL(TPtrC8 &)
IMPORT_C CParameterSetContainer *	NewL(CParameterBundleBase &, TUint32)
IMPORT_C CParameterSetContainer *	NewL(TUint32)
IMPORT_C XParameterSetBase *	RemoveParameterSet(TInt)
IMPORT_C TInt	ReplaceParameterSet(TInt, XParameterSetBase *)
IMPORT_C void	ReplaceParameterSetL(TInt, XParameterSetBase *)
virtual IMPORT_C TInt	Store(TDes8 &)

Protected Member Functions
	CParameterSetContainer(TUint32)
IMPORT_C void	ConstructL(CParameterBundleBase &)

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

Detailed Description

A container for 0..n Parameter Sets. Can be seen as a "row" or "record" of information, with its own 32 bit Id to be used as a key to the set if required

Constructor & Destructor Documentation

CParameterSetContainer ( TUint32 )

CParameterSetContainer

(

TUint32

aContainerId

)

[protected, inline]

~CParameterSetContainer ( )

IMPORT_C

~CParameterSetContainer

(

)

[virtual]

Member Function Documentation

AddParameterSet ( XParameterSetBase * )

IMPORT_C TInt

AddParameterSet

(

XParameterSetBase *

aParameterSet

)

AddParameterSetL ( XParameterSetBase * )

IMPORT_C void

AddParameterSetL

(

XParameterSetBase *

aParameterSet

)

ClearParameterSetPointer ( TInt )

void

ClearParameterSetPointer

(

TInt

aIndex

)

[inline]

ConstructL ( CParameterBundleBase & )

IMPORT_C void

ConstructL

(

CParameterBundleBase &

aBundle

)

[protected]

Set up the container with empty sets

Exceptions

leaves

with KErrNoMemory in out of memory conditions

Parameters
aBundle	Bundle (parent container) that this new parameter set container is to be added to

CountParameterSets ( )

TInt

CountParameterSets

(

)

const [inline]

DeleteParameterSet ( TInt )

IMPORT_C TInt

DeleteParameterSet

(

TInt

aIndex

)

DeleteParameterSetL ( TInt )

IMPORT_C void

DeleteParameterSetL

(

TInt

aIndex

)

Deletes set at index, and reorganises the array so it's 1 smaller

Parameters
aIndex	- index of container to delete and remove from array

Return Value: throws KErrArgument if aIndex out of range

FindParameterSet ( const Meta::STypeId & )

IMPORT_C XParameterSetBase *

FindParameterSet

(

const Meta::STypeId &

aSetId

)

Searches a container for a parameter set of the given type. Searches a parameter set container for a parameter set.

Parameters
aSetId	The STypeId of the set

Return Value: Pointer to the set if found, otherwise a NULL pointer.Pointer to the set if found, otherwise a NULL pointer.

FindParameterSet ( const Meta::STypeId & )

const XParameterSetBase *

FindParameterSet

(

const Meta::STypeId &

aSetId

)

const [inline]

FindParameterSet ( const XParameterSetBase & )

IMPORT_C TBool

FindParameterSet

(

const XParameterSetBase &

aRhs

)

Searches a container for a specific parameter set instance.

Parameters
aRhs	The parameter set to find

Return Value: ETrue if set was found in parameter set container.

GetParameterSet ( TInt )

IMPORT_C XParameterSetBase *

GetParameterSet

(

TInt

aIndex

)

Searches a parameter set container for a parameter set.

Return Value: Pointer to the set if found, otherwise a NULL pointer.

GetParameterSet ( TInt )

const XParameterSetBase *

GetParameterSet

(

TInt

aIndex

)

const [inline]

GrowToFit ( TInt )

IMPORT_C TInt

GrowToFit

(

TInt

aMinSize

)

GrowToFitL ( TInt )

IMPORT_C void

GrowToFitL

(

TInt

aMinSize

)

Makes room for a bulk setting operation

Id ( )

TUint32

(

)

const [inline]

Length ( )

IMPORT_C TInt

Length

(

)

const [virtual]

Reimplemented from Meta::MMetaType::Length()const

Calculates the length of buffer required to serialise this parameter set container.

Return Value: Length of buffer required.

Load ( TPtrC8 & )

IMPORT_C TInt

Load

(

TPtrC8 &

aBuffer

)

[virtual]

Reimplemented from Meta::MMetaType::Load(TPtrC8 &)

Instructs this container to set its members based on the serialised data in the buffer passed.

Parameters
aBuffer	Buffer containing the serialised container object

Return Value: KErrNone if successful, otherwise system wide error

LoadL ( CParameterBundleBase &, TPtrC8 & )

IMPORT_C CParameterSetContainer *	LoadL	(	CParameterBundleBase &	aBundle,
			TPtrC8 &	aBuffer
		)	[static]

Creates a new parameter set container from a buffer containing the serialised object.

Parameters
aBundle	Bundle that this container is to be added to
aBuffer	Buffer containing the serialised object information

Return Value: a pointer to a parameter set container if successful, otherwise leaves with system error code.

LoadL ( TPtrC8 & )

IMPORT_C CParameterSetContainer *

LoadL

(

TPtrC8 &

aBuffer

)

[static]

Creates a new parameter set container from a buffer containing the serialised object.

Parameters
aBuffer	Buffer containing the serialised object information

Return Value: a pointer to a parameter set container if successful, otherwise leaves with system error code.

NewL ( CParameterBundleBase &, TUint32 )

IMPORT_C CParameterSetContainer *	NewL	(	CParameterBundleBase &	aBundle,
			TUint32	aContainerId = 0
		)	[static]

Creates a new parameter set container. This class is used as a container for a number of parameter sets (generic and extension) that are associated with each other. It is a specific instantiatable class and therefore creates an instance of CParameterSetContainer without using ECOM.

Parameters
aBundle	Bundle that this container is to be added to
aContainerId	identifier for the specific container instance

Return Value: a pointer to a parameter set container if successful, otherwise leaves with system error code.

NewL ( TUint32 )

IMPORT_C CParameterSetContainer *

NewL

(

TUint32

aContainerId = 0

)

[static]

Parameters
aContainerId	identifier for the specific container instance

Return Value: a pointer to a parameter set container if successful, otherwise leaves with system error code.

RemoveParameterSet ( TInt )

IMPORT_C XParameterSetBase *

RemoveParameterSet

(

TInt

aIndex

)

Removes the parameter set at the index. Ownership is transfered to the calling method

Parameters
aIndex	- index of container to delete and remove from array

Return Value: returns NULL if the index was invalid, otherwise a pointer to the removed parameter set.

ReplaceParameterSet ( TInt, XParameterSetBase * )

IMPORT_C TInt	ReplaceParameterSet	(	TInt	aIndex,
			XParameterSetBase *	aNewSet
		)

ReplaceParameterSetL ( TInt, XParameterSetBase * )

IMPORT_C void	ReplaceParameterSetL	(	TInt	aIndex,
			XParameterSetBase *	aNewSet
		)

Deletes set at index aIndex and replaces it with aParameterSet. Ownership of set passes to this parameter set container.

Parameters
aIndex	- index of container to delete and replace

Return Value: throws KErrArgument if aIndex out of range

Store ( TDes8 & )

IMPORT_C TInt

Store

(

TDes8 &

aBuffer

)

const [virtual]

Reimplemented from Meta::MMetaType::Store(TDes8 &)const

Instructs this container to create a serialised version of itself and append it to the buffer that has been passed.

Return Value: KErrNone if successful, otherwise system wide error (e.g. KErrOverflow if the descriptor is too small) If unsuccessful, there is no guarantee as to the buffer or data stored in it.