Collapse all Symbian^3 Product Developer Library

CParameterSetContainer Class Reference

class CParameterSetContainer : public CBase

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

Inherits from

CParameterSetContainer
- CBase

Public Member Functions
	~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()
IMPORT_C TInt	Length()
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 *)
IMPORT_C TInt	Store(TDes8 &)

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

Private Member Functions
void	Copy(const TAny *)

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
TUint32	iContainerId
Meta::RMetaDataEComContainer	iParameterSets

Constructor & Destructor Documentation

CParameterSetContainer(TUint32)

CParameterSetContainer

(

TUint32

aContainerId

)

[protected, inline]

Parameters

TUint32 aContainerId

~CParameterSetContainer()

IMPORT_C

~CParameterSetContainer

(

)

[virtual]

Member Functions Documentation

AddParameterSet(XParameterSetBase *)

IMPORT_C TInt

AddParameterSet

(

XParameterSetBase *

aParameterSet

)

Parameters

XParameterSetBase * aParameterSet

AddParameterSetL(XParameterSetBase *)

IMPORT_C void

AddParameterSetL

(

XParameterSetBase *

aParameterSet

)

Parameters

XParameterSetBase * aParameterSet

ClearParameterSetPointer(TInt)

void

ClearParameterSetPointer

(

TInt

aIndex

)

[inline]

Parameters

TInt aIndex

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

CParameterBundleBase & aBundle

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

Copy(const TAny *)

void

Copy

(

const TAny *

)

[private, inline, virtual]

Parameters

const TAny *

CountParameterSets()

TInt

CountParameterSets

(

)

const [inline]

DeleteParameterSet(TInt)

IMPORT_C TInt

DeleteParameterSet

(

TInt

aIndex

)

Parameters

TInt aIndex

DeleteParameterSetL(TInt)

IMPORT_C void

DeleteParameterSetL

(

TInt

aIndex

)

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

Parameters

TInt aIndex

- index of container to delete and remove from array

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

const Meta::STypeId & aSetId

The STypeId of the set

FindParameterSet(const Meta::STypeId &)

const XParameterSetBase *

FindParameterSet

(

const Meta::STypeId &

aSetId

)

const [inline]

Parameters

const Meta::STypeId & aSetId

FindParameterSet(const XParameterSetBase &)

IMPORT_C TBool

FindParameterSet

(

const XParameterSetBase &

aRhs

)

Searches a container for a specific parameter set instance.

Parameters

const XParameterSetBase & aRhs

The parameter set to find

GetParameterSet(TInt)

IMPORT_C XParameterSetBase *

GetParameterSet

(

TInt

aIndex

)

Searches a parameter set container for a parameter set.

Parameters

TInt aIndex

GetParameterSet(TInt)

const XParameterSetBase *

GetParameterSet

(

TInt

aIndex

)

const [inline]

Parameters

TInt aIndex

GrowToFit(TInt)

IMPORT_C TInt

GrowToFit

(

TInt

aMinSize

)

Parameters

TInt aMinSize

GrowToFitL(TInt)

IMPORT_C void

GrowToFitL

(

TInt

aMinSize

)

Makes room for a bulk setting operation

Parameters

TInt aMinSize

Id()

TUint32

(

)

const [inline]

Length()

IMPORT_C TInt

Length

(

)

const [virtual]

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

Load(TPtrC8 &)

IMPORT_C TInt

Load

(

TPtrC8 &

aBuffer

)

[virtual]

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

Parameters

TPtrC8 & aBuffer

Buffer containing the serialised container object

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

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

LoadL(TPtrC8 &)

IMPORT_C CParameterSetContainer *

LoadL

(

TPtrC8 &

aBuffer

)

[static]

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

Parameters

TPtrC8 & aBuffer

Buffer containing the serialised object information

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

CParameterBundleBase & aBundle	Bundle that this container is to be added to
TUint32 aContainerId = 0	identifier for the specific container instance

NewL(TUint32)

IMPORT_C CParameterSetContainer *

NewL

(

TUint32

aContainerId = 0

)

[static]

Parameters

TUint32 aContainerId = 0

identifier for the specific container instance

RemoveParameterSet(TInt)

IMPORT_C XParameterSetBase *

RemoveParameterSet

(

TInt

aIndex

)

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

Parameters

TInt aIndex

- index of container to delete and remove from array

ReplaceParameterSet(TInt, XParameterSetBase *)

IMPORT_C TInt	ReplaceParameterSet	(	TInt	aIndex,
			XParameterSetBase *	aNewSet
		)

Parameters

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

TInt aIndex	- index of container to delete and replace
XParameterSetBase * aNewSet

Store(TDes8 &)

IMPORT_C TInt

Store

(

TDes8 &

aBuffer

)

const [virtual]

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

Parameters

TDes8 & aBuffer

Member Data Documentation

TUint32 iContainerId

TUint32

iContainerId

[private]

Meta::RMetaDataEComContainer iParameterSets

Meta::RMetaDataEComContainer

iParameterSets

[private]