CParameterSetContainer Class Reference

#include <comms-infras/es_parameterbundle.h>

Link against: esock.lib

class CParameterSetContainer : public CBase

Inherits from

  • CParameterSetContainer
    Public Member Functions
    virtual ~CParameterSetContainer()
    IMPORT_C TIntAddParameterSet(XParameterSetBase *)
    IMPORT_C voidAddParameterSetL(XParameterSetBase *)
    voidClearParameterSetPointer(TInt)
    TInt CountParameterSets()
    IMPORT_C TIntDeleteParameterSet(TInt)
    IMPORT_C voidDeleteParameterSetL(TInt)
    IMPORT_C XParameterSetBase *FindParameterSet(const Meta::STypeId &)
    const XParameterSetBase *FindParameterSet(const Meta::STypeId &)
    IMPORT_C TBoolFindParameterSet(const XParameterSetBase &)
    IMPORT_C XParameterSetBase *GetParameterSet(TInt)
    const XParameterSetBase *GetParameterSet(TInt)
    IMPORT_C TIntGrowToFit(TInt)
    IMPORT_C voidGrowToFitL(TInt)
    TUint32 Id()
    virtual IMPORT_C TIntLength()
    virtual IMPORT_C TIntLoad(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 TIntReplaceParameterSet(TInt, XParameterSetBase *)
    IMPORT_C voidReplaceParameterSetL(TInt, XParameterSetBase *)
    virtual IMPORT_C TIntStore(TDes8 &)
    Protected Member Functions
    CParameterSetContainer(TUint32)
    IMPORT_C voidConstructL(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(TUint32aContainerId)[protected, inline]

    ~CParameterSetContainer ( )

    IMPORT_C~CParameterSetContainer()[virtual]

    Member Function Documentation

    AddParameterSet ( XParameterSetBase * )

    IMPORT_C TIntAddParameterSet(XParameterSetBase *aParameterSet)

    AddParameterSetL ( XParameterSetBase * )

    IMPORT_C voidAddParameterSetL(XParameterSetBase *aParameterSet)

    ClearParameterSetPointer ( TInt )

    voidClearParameterSetPointer(TIntaIndex)[inline]

    ConstructL ( CParameterBundleBase & )

    IMPORT_C voidConstructL(CParameterBundleBase &aBundle)[protected]

    Set up the container with empty sets

    Exceptions
    leaves

    with KErrNoMemory in out of memory conditions

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

    CountParameterSets ( )

    TInt CountParameterSets()const [inline]

    DeleteParameterSet ( TInt )

    IMPORT_C TIntDeleteParameterSet(TIntaIndex)

    DeleteParameterSetL ( TInt )

    IMPORT_C voidDeleteParameterSetL(TIntaIndex)

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

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

    Returns: 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.

    ParameterDescription
    aSetIdThe STypeId of the set

    Returns: 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 TBoolFindParameterSet(const XParameterSetBase &aRhs)

    Searches a container for a specific parameter set instance.

    ParameterDescription
    aRhsThe parameter set to find

    Returns: ETrue if set was found in parameter set container.

    GetParameterSet ( TInt )

    IMPORT_C XParameterSetBase *GetParameterSet(TIntaIndex)

    Searches a parameter set container for a parameter set.

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

    GetParameterSet ( TInt )

    const XParameterSetBase *GetParameterSet(TIntaIndex)const [inline]

    GrowToFit ( TInt )

    IMPORT_C TIntGrowToFit(TIntaMinSize)

    GrowToFitL ( TInt )

    IMPORT_C voidGrowToFitL(TIntaMinSize)

    Makes room for a bulk setting operation

    Id ( )

    TUint32 Id()const [inline]

    Length ( )

    IMPORT_C TIntLength()const [virtual]

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

    Returns: Length of buffer required.

    Load ( TPtrC8 & )

    IMPORT_C TIntLoad(TPtrC8 &aBuffer)[virtual]

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

    ParameterDescription
    aBufferBuffer containing the serialised container object

    Returns: 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.

    ParameterDescription
    aBundleBundle that this container is to be added to
    aBufferBuffer containing the serialised object information

    Returns: 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.

    ParameterDescription
    aBufferBuffer containing the serialised object information

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

    NewL ( CParameterBundleBase &, TUint32 )

    IMPORT_C CParameterSetContainer *NewL(CParameterBundleBase &aBundle,
    TUint32aContainerId = 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.

    ParameterDescription
    aBundleBundle that this container is to be added to
    aContainerIdidentifier for the specific container instance

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

    NewL ( TUint32 )

    IMPORT_C CParameterSetContainer *NewL(TUint32aContainerId = 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.

    ParameterDescription
    aContainerIdidentifier for the specific container instance

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

    RemoveParameterSet ( TInt )

    IMPORT_C XParameterSetBase *RemoveParameterSet(TIntaIndex)

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

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

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

    ReplaceParameterSet ( TInt, XParameterSetBase * )

    IMPORT_C TIntReplaceParameterSet(TIntaIndex,
    XParameterSetBase *aNewSet
    )

    ReplaceParameterSetL ( TInt, XParameterSetBase * )

    IMPORT_C voidReplaceParameterSetL(TIntaIndex,
    XParameterSetBase *aNewSet
    )

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

    ParameterDescription
    aIndex- index of container to delete and replace

    Returns: throws KErrArgument if aIndex out of range

    Store ( TDes8 & )

    IMPORT_C TIntStore(TDes8 &aBuffer)const [virtual]

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

    Returns: 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.