Symbian^3 Application Developer Library >

CParameterBundleBase Class Reference

class CParameterBundleBase : public CBase

Bundle of (i.e. container for) parameter set containers.

The basic object shape and base type container manipulators. To be used only by CParameterBundle<PARAMETERSETCONTAINERTYPE,SUBCLASS>

May contain and 0..N parameter families.

Inherits from

Public Member Functions
~CParameterBundleBase ()
IMPORT_C TInt AddParamSetContainer ( CParameterSetContainer &)
IMPORT_C void AddParamSetContainerL ( CParameterSetContainer &)
TInt CountParamSetContainers ()
IMPORT_C CParameterSetContainer * FindParamSetContainer ( TUint32 )
const CParameterSetContainer * FindParamSetContainer ( TUint32 )
IMPORT_C XParameterSetBase * FindParameterSet (const Meta::STypeId &)
const XParameterSetBase * FindParameterSet (const Meta::STypeId &)
IMPORT_C CParameterSetContainer * GetParamSetContainer ( TInt )
const CParameterSetContainer * GetParamSetContainer ( TInt )
IMPORT_C TUint Length ()
CParameterBundleBase * NewL ()
IMPORT_C CParameterSetContainer * RemoveParamSetContainer ( TInt )
IMPORT_C TInt ReplaceParamSetContainer ( CParameterSetContainer *, CParameterSetContainer *)
IMPORT_C void ReplaceParamSetContainerL ( CParameterSetContainer *, CParameterSetContainer *)
IMPORT_C TInt Store ( TDes8 &)
Protected Member Functions
CParameterBundleBase ()
Private Member Functions
CParameterBundleBase (const CParameterBundleBase &)
CParameterBundleBase & operator= (const 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()
Protected Attributes
RPointerArray < CParameterSetContainer > iSetContainers

Constructor & Destructor Documentation

CParameterBundleBase()

CParameterBundleBase ( ) [protected, inline]

CParameterBundleBase(const CParameterBundleBase &)

CParameterBundleBase ( const CParameterBundleBase & aBundle ) [private]

Parameters

const CParameterBundleBase & aBundle

~CParameterBundleBase()

IMPORT_C ~CParameterBundleBase ( ) [virtual]

Member Functions Documentation

AddParamSetContainer(CParameterSetContainer &)

IMPORT_C TInt AddParamSetContainer ( CParameterSetContainer & aContainer )

Add a parameter set container to the bundle.

Parameters

CParameterSetContainer & aContainer Container to be added (bundle takes ownership)

AddParamSetContainerL(CParameterSetContainer &)

IMPORT_C void AddParamSetContainerL ( CParameterSetContainer & aContainer )
Add a parameter set container to the bundle.
Exceptions
Leaves

with KErrNoMemory in out of memory conditions

Parameters

CParameterSetContainer & aContainer Container to be added (bundle takes ownership)

CountParamSetContainers()

TInt CountParamSetContainers ( ) const [inline]

FindParamSetContainer(TUint32)

IMPORT_C CParameterSetContainer * FindParamSetContainer ( TUint32 aContainerId )

Search the parameter bundle for a parameter set container

Parameters

TUint32 aContainerId Id of the container to match against

FindParamSetContainer(TUint32)

const CParameterSetContainer * FindParamSetContainer ( TUint32 aContainerId ) const [inline]

Parameters

TUint32 aContainerId

FindParameterSet(const Meta::STypeId &)

IMPORT_C XParameterSetBase * FindParameterSet ( const Meta::STypeId & aTypeId )

Deep search the parameter bundle for a parameter set of given type

Parameters

const Meta::STypeId & aTypeId Id of the set type to match against

FindParameterSet(const Meta::STypeId &)

const XParameterSetBase * FindParameterSet ( const Meta::STypeId & aTypeId ) const [inline]

Parameters

const Meta::STypeId & aTypeId

GetParamSetContainer(TInt)

IMPORT_C CParameterSetContainer * GetParamSetContainer ( TInt aIndex )

Pick out the parameter set container at the given index in the bundle.

Parameters

TInt aIndex index of the container to get

GetParamSetContainer(TInt)

const CParameterSetContainer * GetParamSetContainer ( TInt aIndex ) const [inline]

Parameters

TInt aIndex

Length()

IMPORT_C TUint Length ( ) const

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

NewL()

CParameterBundleBase * NewL ( ) [static, inline]

RemoveParamSetContainer(TInt)

IMPORT_C CParameterSetContainer * RemoveParamSetContainer ( TInt aIndex )

Remove a parameter set container from the bundle, returning ownership to the calling method

Parameters

TInt aIndex index of the container to remove

ReplaceParamSetContainer(CParameterSetContainer *, CParameterSetContainer *)

IMPORT_C TInt ReplaceParamSetContainer ( CParameterSetContainer * aOld,
CParameterSetContainer * aNew
)

Replaces a given parameter set container with another. The old parameter set container is deleted, and the parameter bundle takes ownership of the new one

Parameters

CParameterSetContainer * aOld A parameter set container that exists in the parameter bundle
CParameterSetContainer * aNew The parameter set container that will take the place of the old one

ReplaceParamSetContainerL(CParameterSetContainer *, CParameterSetContainer *)

IMPORT_C void ReplaceParamSetContainerL ( CParameterSetContainer * aOld,
CParameterSetContainer * aNew
)
Replaces a given parameter set container with another. The old parameter set container is deleted, and the parameter bundle takes ownership of the new one
Exceptions
Leaves

with KErrNotFound if the parameter set container was not found in the bundle

Parameters

CParameterSetContainer * aOld A parameter set container that exists in the parameter bundle
CParameterSetContainer * aNew The parameter set container that will take the place of the old one

Store(TDes8 &)

IMPORT_C TInt Store ( TDes8 & aDes ) const

Instructs this sub-connection parameter bundle to create a serilised version of itself and append it to the buffer that has been passed.

Parameters

TDes8 & aDes Buffer to append the serialised object to

operator=(const CParameterBundleBase &)

CParameterBundleBase & operator= ( const CParameterBundleBase & aBundle ) [private]

Parameters

const CParameterBundleBase & aBundle

Member Data Documentation

RPointerArray< CParameterSetContainer > iSetContainers

RPointerArray < CParameterSetContainer > iSetContainers [protected]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.