Symbian^3 Product Developer Library >

RParameterFamily Class Reference

class RParameterFamily

Wrapper round CParameterSetContainer presenting the following interface: For each Parameter Type (Requested, Acceptable and Granted) it contains 0..N parameter sets.

Public Member Functions
RParameterFamily()
IMPORT_C TIntAddParameterSet(XParameterSetBase *, TParameterSetType)
IMPORT_C voidAddParameterSetL(XParameterSetBase *, TParameterSetType)
IMPORT_C voidClearAllParameters(TParameterSetType)
IMPORT_C TIntClearParameterSetPointer(TInt, TParameterSetType)
IMPORT_C TIntCountParameterSets(TParameterSetType)
IMPORT_C TIntCountParameterSets()
IMPORT_C voidCreateL(RParameterFamilyBundle &, TUint32)
IMPORT_C TIntDeleteParameterSet(TInt)
IMPORT_C voidDeleteParameterSetL(TInt)
IMPORT_C voidDestroy()
IMPORT_C XParameterSetBase *FindParameterSet(Meta::STypeId, TParameterSetType)
const XParameterSetBase *FindParameterSet(const Meta::STypeId &, TParameterSetType)
IMPORT_C XParameterSetBase *GetParameterSetAtIndex(TUint, TParameterSetType)
const XParameterSetBase *GetParameterSetAtIndex(TUint, TParameterSetType)
IMPORT_C TUint32Id()
TBool IsNull()
IMPORT_C TUintLength()
IMPORT_C voidLoadL(RParameterFamilyBundle &, TPtrC8 &)
IMPORT_C TIntRemoveAndDestroyParameterSet(XParameterSetBase *, TParameterSetType)
IMPORT_C TIntRemoveParameterSet(XParameterSetBase *, TParameterSetType)
IMPORT_C TIntStore(TDes8 &)
Public Member Enumerations
enumTParameterSetType { ERequested = 0, EAcceptable = 1, EGranted = 2, ENumValues = 3 }
Private Attributes
CParameterSetContainer *iContainer

Constructor & Destructor Documentation

RParameterFamily()

RParameterFamily()[inline]

Member Functions Documentation

AddParameterSet(XParameterSetBase *, TParameterSetType)

IMPORT_C TIntAddParameterSet(XParameterSetBase *aParameterSet,
TParameterSetTypeaType
)

Adds a parameter set to a sub-connection parameter set family.

Parameters

XParameterSetBase * aParameterSet
TParameterSetType aTypeThe type of the set (requested, acceptable or granted)

AddParameterSetL(XParameterSetBase *, TParameterSetType)

IMPORT_C voidAddParameterSetL(XParameterSetBase *aParameterSet,
TParameterSetTypeaType
)

Adds a parameter set to a sub-connection parameter set family.

Exceptions
leaves

with KErrNoMemory in out of memory conditions, or KErrNotReady if the parameter family hasn't been prepared with LoadL or CreateL, or KErrArgument if aSet is invalid

Parameters

XParameterSetBase * aParameterSet
TParameterSetType aTypeThe type of the set (requested, acceptable or granted)

ClearAllParameters(TParameterSetType)

IMPORT_C voidClearAllParameters(TParameterSetTypeaType)

Clears (removes and deletes) all parameter sets with the type specified

Parameters

TParameterSetType aTypeThe type of the set to be deleted(requested, acceptable or granted)

ClearParameterSetPointer(TInt, TParameterSetType)

IMPORT_C TIntClearParameterSetPointer(TIntaIndex,
TParameterSetTypeaType
)

Parameters

TInt aIndex
TParameterSetType aType

CountParameterSets(TParameterSetType)

IMPORT_C TIntCountParameterSets(TParameterSetTypeaType)

Parameters

TParameterSetType aType

CountParameterSets()

IMPORT_C TIntCountParameterSets()

CreateL(RParameterFamilyBundle &, TUint32)

IMPORT_C voidCreateL(RParameterFamilyBundle &aBundle,
TUint32aFamilyId
)

Creates a new parameter set family. This class is used as a container for a number of parameter sets that make up a family. It is a specific instantiatable class and therefore creates an instance of CParameterFamily without using ECOM.

Exceptions
KErrInUse

if the container has already been prepared for use, KErrArgument if aBundle is invalid, or another system-wide error code

Parameters

RParameterFamilyBundle & aBundleFamily container (bundle) that this family is to be added to
TUint32 aFamilyId

DeleteParameterSet(TInt)

IMPORT_C TIntDeleteParameterSet(TIntaIndex)

Parameters

TInt aIndex

DeleteParameterSetL(TInt)

IMPORT_C voidDeleteParameterSetL(TIntaIndex)

Parameters

TInt aIndex

Destroy()

IMPORT_C voidDestroy()

Sub-connection parameter family destructor. It cleans up the arrays deleting all the parameter sets it owns

FindParameterSet(Meta::STypeId, TParameterSetType)

IMPORT_C XParameterSetBase *FindParameterSet(Meta::STypeIdaSetId,
TParameterSetTypeaType
)

Parameters

Meta::STypeId aSetId
TParameterSetType aType

FindParameterSet(const Meta::STypeId &, TParameterSetType)

const XParameterSetBase *FindParameterSet(const Meta::STypeId &aSetId,
TParameterSetTypeaType
)const [inline]

Parameters

const Meta::STypeId & aSetId
TParameterSetType aType

GetParameterSetAtIndex(TUint, TParameterSetType)

IMPORT_C XParameterSetBase *GetParameterSetAtIndex(TUintaIndex,
TParameterSetTypeaType
)

Parameters

TUint aIndex
TParameterSetType aType

GetParameterSetAtIndex(TUint, TParameterSetType)

const XParameterSetBase *GetParameterSetAtIndex(TUintaIndex,
TParameterSetTypeaType
)const [inline]

Parameters

TUint aIndex
TParameterSetType aType

Id()

IMPORT_C TUint32Id()const

Fetch the identity of the sub-connection parameter family

IsNull()

TBool IsNull()const [inline]

Length()

IMPORT_C TUintLength()const

Calculates the length of buffer required to serialise this parameter family.

LoadL(RParameterFamilyBundle &, TPtrC8 &)

IMPORT_C voidLoadL(RParameterFamilyBundle &aBundle,
TPtrC8 &aBuffer
)

Parameters

RParameterFamilyBundle & aBundle
TPtrC8 & aBuffer

RemoveAndDestroyParameterSet(XParameterSetBase *, TParameterSetType)

IMPORT_C TIntRemoveAndDestroyParameterSet(XParameterSetBase *aSetToRemove,
TParameterSetTypeaType
)

Removes a parameter set from a parameter set family and deletes it

Parameters

XParameterSetBase * aSetToRemoveParameter Set to be removed from the family
TParameterSetType aTypeThe type of the set (requested, acceptable or granted)

RemoveParameterSet(XParameterSetBase *, TParameterSetType)

IMPORT_C TIntRemoveParameterSet(XParameterSetBase *aSetToRemove,
TParameterSetTypeaType
)

Removes a parameter set from a parameter set family.

Parameters

XParameterSetBase * aSetToRemoveParameter Set to be removed from the family returning ownership to the calling method
TParameterSetType aTypeThe type of the set (requested, acceptable or granted)

Store(TDes8 &)

IMPORT_C TIntStore(TDes8 &aDes)const

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

Parameters

TDes8 & aDesBuffer to append the serialised object to

Member Enumerations Documentation

Enum TParameterSetType

Enumerators

ERequested = 0
EAcceptable = 1
EGranted = 2
ENumValues = 3

Member Data Documentation

CParameterSetContainer * iContainer

CParameterSetContainer *iContainer[private]

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.