CParameterBundleBase Class Reference

#include <comms-infras/es_parameterbundle.h>

Link against: esock.lib

class CParameterBundleBase : public CBase

Inherits from

  • CParameterBundleBase
    Protected Attributes
    RPointerArray< CParameterSetContainer >iSetContainers
    Public Member Functions
    virtual ~CParameterBundleBase()
    IMPORT_C TIntAddParamSetContainer(CParameterSetContainer &)
    IMPORT_C voidAddParamSetContainerL(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 TUintLength()
    CParameterBundleBase *NewL()
    IMPORT_C CParameterSetContainer *RemoveParamSetContainer(TInt)
    IMPORT_C TIntReplaceParamSetContainer(CParameterSetContainer *, CParameterSetContainer *)
    IMPORT_C voidReplaceParamSetContainerL(CParameterSetContainer *, CParameterSetContainer *)
    IMPORT_C TIntStore(TDes8 &)
    Protected Member Functions
    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

    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.

    Member Attribute Documentation

    iSetContainers

    RPointerArray< CParameterSetContainer >iSetContainers[protected]

    Constructor & Destructor Documentation

    CParameterBundleBase ( )

    CParameterBundleBase()[protected, inline]

    ~CParameterBundleBase ( )

    IMPORT_C~CParameterBundleBase()[virtual]

    Member Function Documentation

    AddParamSetContainer ( CParameterSetContainer & )

    IMPORT_C TIntAddParamSetContainer(CParameterSetContainer &aContainer)

    Add a parameter set container to the bundle.

    ParameterDescription
    aContainerContainer to be added (bundle takes ownership)

    Returns: Returns with KErrNoMemory in out of memory conditions

    AddParamSetContainerL ( CParameterSetContainer & )

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

    with KErrNoMemory in out of memory conditions

    ParameterDescription
    aContainerContainer to be added (bundle takes ownership)

    CountParamSetContainers ( )

    TInt CountParamSetContainers()const [inline]

    FindParamSetContainer ( TUint32 )

    IMPORT_C CParameterSetContainer *FindParamSetContainer(TUint32aContainerId)

    Search the parameter bundle for a parameter set container

    ParameterDescription
    aContainerIdId of the container to match against

    Returns: Matching container or NULL pointer if not found

    FindParamSetContainer ( TUint32 )

    const CParameterSetContainer *FindParamSetContainer(TUint32aContainerId)const [inline]

    FindParameterSet ( const Meta::STypeId & )

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

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

    ParameterDescription
    aTypeIdId of the set type to match against

    Returns: Matching set or NULL pointer if not found

    FindParameterSet ( const Meta::STypeId & )

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

    GetParamSetContainer ( TInt )

    IMPORT_C CParameterSetContainer *GetParamSetContainer(TIntaIndex)

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

    ParameterDescription
    aIndexindex of the container to get

    Returns: Matching container or NULL pointer if index out of range

    GetParamSetContainer ( TInt )

    const CParameterSetContainer *GetParamSetContainer(TIntaIndex)const [inline]

    Length ( )

    IMPORT_C TUintLength()const

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

    Returns: Length of buffer required.

    NewL ( )

    CParameterBundleBase *NewL()[static, inline]

    RemoveParamSetContainer ( TInt )

    IMPORT_C CParameterSetContainer *RemoveParamSetContainer(TIntaIndex)

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

    ParameterDescription
    aIndexindex of the container to remove

    Returns: The removed parameter set container

    ReplaceParamSetContainer ( CParameterSetContainer *, CParameterSetContainer * )

    IMPORT_C TIntReplaceParamSetContainer(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

    ParameterDescription
    aOldA parameter set container that exists in the parameter bundle
    aNewThe parameter set container that will take the place of the old one

    Returns: KErrNotFound if the parameter set container was not found in the bundle, otherwise KErrNone.

    ReplaceParamSetContainerL ( CParameterSetContainer *, CParameterSetContainer * )

    IMPORT_C voidReplaceParamSetContainerL(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

    ParameterDescription
    aOldA parameter set container that exists in the parameter bundle
    aNewThe parameter set container that will take the place of the old one

    Store ( TDes8 & )

    IMPORT_C TIntStore(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.

    ParameterDescription
    aDesBuffer to append the serialised object to

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

    © Nokia 2011.