Collapse all Symbian^3 Application Developer Library

CSubConParameterBundle Class Reference

class CSubConParameterBundle : public CObject

Container for (bundle of) SubConnection parameter families.

May contain and 0..N parameter families.

Note: If the CSubConParameterBundle object takes ownership of any CSubConParameterFamily object, then when the bundle object is destroyed, any family owned by this object will also be destroyed.

THIS API IS DEPRECATED IN FAVOUR OF RParameterFamilyBundle

since v9.6

Inherits from

CSubConParameterBundle
- CObject
  - CBase

Public Member Functions
	~CSubConParameterBundle ()
IMPORT_C void	AddFamilyL ( CSubConParameterFamily *)
IMPORT_C void	ClearAllParameters ( CSubConParameterFamily::TParameterSetType )
IMPORT_C CSubConParameterFamily *	FindFamily ( TUint32 )
IMPORT_C CSubConParameterFamily *	FindFamily ( TUint32 )
IMPORT_C TUint	Length ()
IMPORT_C TInt	Load (const TDesC8 &)
IMPORT_C CSubConParameterBundle *	LoadL ( TDesC8 &)
IMPORT_C CSubConParameterBundle *	NewL ()
IMPORT_C TInt	Store ( TDes8 &)

Protected Member Functions
	CSubConParameterBundle ()

Private Member Functions
	CSubConParameterBundle (const CSubConParameterBundle &)
CSubConParameterBundle &	operator= (const CSubConParameterBundle &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	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()
	CObject::AccessCount()const
	CObject::CObject()
	CObject::Close()
	CObject::Dec()
	CObject::Extension_(TUint,TAny &,TAny )
	CObject::FullName()const
	CObject::Inc()
	CObject::Name()const
	CObject::Open()
	CObject::Owner()const
	CObject::SetName(const TDesC *)
	CObject::SetNameL(const TDesC *)
	CObject::SetOwner(CObject *)
	CObject::UniqueID()const
	CObject::~CObject()

Protected Attributes
RPointerArray < CSubConParameterFamily >	iFamilies

Constructor & Destructor Documentation

CSubConParameterBundle()

IMPORT_C

CSubConParameterBundle

(

)

[protected]

Empty sub-connection generic parameter bundle constructor

CSubConParameterBundle(const CSubConParameterBundle &)

CSubConParameterBundle

(

const CSubConParameterBundle &

aBundle

)

[private]

Copy Constructor

Parameters

const CSubConParameterBundle & aBundle

~CSubConParameterBundle()

IMPORT_C

~CSubConParameterBundle

(

)

Sub-connection parameter bundle destructor, clear up the families

Member Functions Documentation

AddFamilyL(CSubConParameterFamily *)

IMPORT_C void

AddFamilyL

(

CSubConParameterFamily *

aFamily

)

Add a sub-connection parameter family to the bundle.

Note: The CSubConParameterBundle object takes ownership of the parameter family that is passed into this method. When the bundle object is destroyed, any family owned by this object will also be destroyed.

Exceptions

leaves

with KErrNoMemory in out of memory conditions

Parameters

CSubConParameterFamily * aFamily

Family to be added (bundle takes ownership)

ClearAllParameters(CSubConParameterFamily::TParameterSetType)

IMPORT_C void

ClearAllParameters

(

CSubConParameterFamily::TParameterSetType

aType

)

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

Parameters

CSubConParameterFamily::TParameterSetType aType

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

FindFamily(TUint32)

IMPORT_C CSubConParameterFamily *

FindFamily

(

TUint32

aFamilyId

)

Search the sub-connection parameter bundle for a parameter family

Parameters

TUint32 aFamilyId

Id of the family to match against. It is an identifier for the specific family type, currently only 4, QoS (KSubConQoSFamily),Authorisation (KSubConAuthorisationFamily), CallDescrParams (KSubConnCallDescrParamsFamily) and ContextDescrParams (KSubConnContextDescrParamsFamily), are defined.

FindFamily(TUint32)

IMPORT_C CSubConParameterFamily *

FindFamily

(

TUint32

aFamilyId

)

const

Search the sub-connection parameter bundle for a parameter family

Parameters

TUint32 aFamilyId

Length()

IMPORT_C TUint

Length

(

)

const

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

Load(const TDesC8 &)

IMPORT_C TInt

Load

(

const TDesC8 &

aDes

)

Instructs this sub-connection bundle to set its members based on the serialiesd data in the buffer passed.

Parameters

const TDesC8 & aDes

Buffer containing the serialised bundle object

LoadL(TDesC8 &)

IMPORT_C CSubConParameterBundle *

LoadL

(

TDesC8 &

aDes

)

[static]

Creates a new sub-connection parameter set bunlde from a buffer containing the serialised object.

Parameters

TDesC8 & aDes

Buffer containing the serialised object information

NewL()

IMPORT_C CSubConParameterBundle *

NewL

(

)

[static]

Creates a new instance of a sub-connection parameter bundle (heap object) Can be used directly as a CObject or via the RSubConParameterBundle handle.

Exceptions

leaves

with KErrNoMemory in out of memory conditions

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 CSubConParameterBundle &)

CSubConParameterBundle &

operator=

(

const CSubConParameterBundle &

aBundle

)

[private]

Assignment operator

Parameters

const CSubConParameterBundle & aBundle

Member Data Documentation

RPointerArray< CSubConParameterFamily > iFamilies

RPointerArray < CSubConParameterFamily >

iFamilies

[protected]