CParameterSetContainer Class Reference
#include
<comms-infras/es_parameterbundle.h>
| class CParameterSetContainer : public 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 | ( | TUint32 | aContainerId | ) | [protected, inline] |
~CParameterSetContainer ( )
| IMPORT_C | ~CParameterSetContainer | ( | ) | [virtual] |
Member Function Documentation
AddParameterSet ( XParameterSetBase * )
AddParameterSetL ( XParameterSetBase * )
ClearParameterSetPointer ( TInt )
| void | ClearParameterSetPointer | ( | TInt | aIndex | ) | [inline] |
ConstructL ( CParameterBundleBase & )
Set up the container with empty sets
- Exceptions
-
| leaves |
with KErrNoMemory in out of memory conditions
|
| Parameter | Description | | aBundle | Bundle (parent container) that this new parameter set container is to be added to |
CountParameterSets ( )
|
TInt
| CountParameterSets | ( | ) | const [inline] |
DeleteParameterSet ( TInt )
| IMPORT_C TInt | DeleteParameterSet | ( | TInt | aIndex | ) | |
DeleteParameterSetL ( TInt )
| IMPORT_C void | DeleteParameterSetL | ( | TInt | aIndex | ) | |
Deletes set at index, and reorganises the array so it's 1 smaller
| Parameter | Description | | aIndex | - index of container to delete and remove from array |
Returns: throws KErrArgument if aIndex out of range
FindParameterSet ( const Meta::STypeId & )
Searches a container for a parameter set of the given type. Searches a parameter set container for a parameter set.
| Parameter | Description | | aSetId | The 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 & )
FindParameterSet ( const XParameterSetBase & )
Searches a container for a specific parameter set instance.
| Parameter | Description | | aRhs | The parameter set to find |
Returns: ETrue if set was found in parameter set container.
GetParameterSet ( TInt )
Searches a parameter set container for a parameter set.
Returns: Pointer to the set if found, otherwise a NULL pointer.
GrowToFitL ( TInt )
| IMPORT_C void | GrowToFitL | ( | TInt | aMinSize | ) | |
Makes room for a bulk setting operation
Length ( )
| IMPORT_C TInt | Length | ( | ) | const [virtual] |
Calculates the length of buffer required to serialise this parameter set container.
Returns: Length of buffer required.
Load ( TPtrC8 & )
Instructs this container to set its members based on the serialised data in the buffer passed.
| Parameter | Description | | aBuffer | Buffer containing the serialised container object |
Returns: KErrNone if successful, otherwise system wide error
LoadL ( CParameterBundleBase &, TPtrC8 & )
Creates a new parameter set container from a buffer containing the serialised object.
| Parameter | Description | | aBundle | Bundle that this container is to be added to |
| aBuffer | Buffer containing the serialised object information |
Returns: a pointer to a parameter set container if successful, otherwise leaves with system error code.
LoadL ( TPtrC8 & )
Creates a new parameter set container from a buffer containing the serialised object.
| Parameter | Description | | aBuffer | Buffer containing the serialised object information |
Returns: a pointer to a parameter set container if successful, otherwise leaves with system error code.
NewL ( CParameterBundleBase &, TUint32 )
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.
| Parameter | Description | | aBundle | Bundle that this container is to be added to |
| aContainerId | identifier for the specific container instance |
Returns: a pointer to a parameter set container if successful, otherwise leaves with system error code.
NewL ( TUint32 )
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.
| Parameter | Description | | aContainerId | identifier for the specific container instance |
Returns: a pointer to a parameter set container if successful, otherwise leaves with system error code.
RemoveParameterSet ( TInt )
Removes the parameter set at the index. Ownership is transfered to the calling method
| Parameter | Description | | 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 * )
ReplaceParameterSetL ( TInt, XParameterSetBase * )
Deletes set at index aIndex and replaces it with aParameterSet. Ownership of set passes to this parameter set container.
| Parameter | Description | | aIndex | - index of container to delete and replace |
Returns: throws KErrArgument if aIndex out of range
Store ( TDes8 & )
| IMPORT_C TInt | Store | ( | 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.