Collapse all Symbian^3 Application 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 TInt	AddParameterSet ( XParameterSetBase *, TParameterSetType )
IMPORT_C void	AddParameterSetL ( XParameterSetBase *, TParameterSetType )
IMPORT_C void	ClearAllParameters ( TParameterSetType )
IMPORT_C TInt	ClearParameterSetPointer ( TInt , TParameterSetType )
IMPORT_C TInt	CountParameterSets ( TParameterSetType )
IMPORT_C TInt	CountParameterSets ()
IMPORT_C void	CreateL ( RParameterFamilyBundle &, TUint32 )
IMPORT_C TInt	DeleteParameterSet ( TInt )
IMPORT_C void	DeleteParameterSetL ( TInt )
IMPORT_C void	Destroy ()
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 TUint32	Id ()
TBool	IsNull ()
IMPORT_C TUint	Length ()
IMPORT_C void	LoadL ( RParameterFamilyBundle &, TPtrC8 &)
IMPORT_C TInt	RemoveAndDestroyParameterSet ( XParameterSetBase *, TParameterSetType )
IMPORT_C TInt	RemoveParameterSet ( XParameterSetBase *, TParameterSetType )
IMPORT_C TInt	Store ( TDes8 &)

Public Member Enumerations
enum	TParameterSetType { 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 TInt	AddParameterSet	(	XParameterSetBase *	aParameterSet,
			TParameterSetType	aType
		)

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

Parameters

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

AddParameterSetL(XParameterSetBase *, TParameterSetType)

IMPORT_C void	AddParameterSetL	(	XParameterSetBase *	aParameterSet,
			TParameterSetType	aType
		)

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 aType	The type of the set (requested, acceptable or granted)

ClearAllParameters(TParameterSetType)

IMPORT_C void

ClearAllParameters

(

TParameterSetType

aType

)

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

Parameters

TParameterSetType aType

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

ClearParameterSetPointer(TInt, TParameterSetType)

IMPORT_C TInt	ClearParameterSetPointer	(	TInt	aIndex,
			TParameterSetType	aType
		)

Parameters

TInt aIndex
TParameterSetType aType

CountParameterSets(TParameterSetType)

IMPORT_C TInt

CountParameterSets

(

TParameterSetType

aType

)

Parameters

TParameterSetType aType

CountParameterSets()

IMPORT_C TInt

CountParameterSets

(

)

CreateL(RParameterFamilyBundle &, TUint32)

IMPORT_C void	CreateL	(	RParameterFamilyBundle &	aBundle,
			TUint32	aFamilyId
		)

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 & aBundle	Family container (bundle) that this family is to be added to
TUint32 aFamilyId

DeleteParameterSet(TInt)

IMPORT_C TInt

DeleteParameterSet

(

TInt

aIndex

)

Parameters

TInt aIndex

DeleteParameterSetL(TInt)

IMPORT_C void

DeleteParameterSetL

(

TInt

aIndex

)

Parameters

TInt aIndex

Destroy()

IMPORT_C void

Destroy

(

)

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::STypeId	aSetId,
			TParameterSetType	aType
		)

Parameters

Meta::STypeId aSetId
TParameterSetType aType

FindParameterSet(const Meta::STypeId &, TParameterSetType)

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

Parameters

const Meta::STypeId & aSetId
TParameterSetType aType

GetParameterSetAtIndex(TUint, TParameterSetType)

IMPORT_C XParameterSetBase *	GetParameterSetAtIndex	(	TUint	aIndex,
			TParameterSetType	aType
		)

Parameters

TUint aIndex
TParameterSetType aType

GetParameterSetAtIndex(TUint, TParameterSetType)

const XParameterSetBase *	GetParameterSetAtIndex	(	TUint	aIndex,
			TParameterSetType	aType
		)	const [inline]

Parameters

TUint aIndex
TParameterSetType aType

Id()

IMPORT_C TUint32

(

)

const

Fetch the identity of the sub-connection parameter family

IsNull()

TBool

IsNull

(

)

const [inline]

Length()

IMPORT_C TUint

Length

(

)

const

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

LoadL(RParameterFamilyBundle &, TPtrC8 &)

IMPORT_C void	LoadL	(	RParameterFamilyBundle &	aBundle,
			TPtrC8 &	aBuffer
		)

Parameters

RParameterFamilyBundle & aBundle
TPtrC8 & aBuffer

RemoveAndDestroyParameterSet(XParameterSetBase *, TParameterSetType)

IMPORT_C TInt	RemoveAndDestroyParameterSet	(	XParameterSetBase *	aSetToRemove,
			TParameterSetType	aType
		)

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

Parameters

XParameterSetBase * aSetToRemove	Parameter Set to be removed from the family
TParameterSetType aType	The type of the set (requested, acceptable or granted)

RemoveParameterSet(XParameterSetBase *, TParameterSetType)

IMPORT_C TInt	RemoveParameterSet	(	XParameterSetBase *	aSetToRemove,
			TParameterSetType	aType
		)

Removes a parameter set from a parameter set family.

Parameters

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

Store(TDes8 &)

IMPORT_C TInt

Store

(

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 & aDes

Buffer 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]