| class CPosModuleUpdate : public CBase |
Encapsulates an update of the changeable attributes of a positioning module.
This class keeps track of which parameters have been set. Only those parameters will be updated.
To edit an attribute, create a CPosModuleUpdate and set the attribute which should be changed. Then use CPosModules::UpdateModuleL() to commit the change to Location Settings.
| Public Member Functions | |
|---|---|
| ~CPosModuleUpdate() | |
| TBool | AvailabilityUpdate() |
| TPositionQuality::TCostIndicator | CostUpdate() |
| IMPORT_C CPosModuleUpdate * | NewLC() |
| IMPORT_C void | SetUpdateAvailability(TBool) |
| IMPORT_C void | SetUpdateCost(TPositionQuality::TCostIndicator) |
| IMPORT_C void | SetUpdateVisibility(TBool) |
| TUint | UpdateMap() |
| TBool | VisibilityUpdate() |
| Private Member Functions | |
|---|---|
| CPosModuleUpdate() | |
| CPosModuleUpdate(const CPosModuleUpdate &) | |
| void | ConstructL() |
| CPosModuleUpdate & | operator=(const CPosModuleUpdate &) |
| Private Attributes | |
|---|---|
| TPositionQuality::TCostIndicator | iCostUpdate |
| TBool | iIsAvailableUpdate |
| TBool | iIsVisibleUpdate |
| TUint | iUpdateMask |
| CPosModuleUpdate | ( | const CPosModuleUpdate & | ) | [private] |
| const CPosModuleUpdate & |
| TBool | AvailabilityUpdate | ( | ) | const |
Returns the update value for the module status attribute.
Returns the update value for the module status attribute.
| TPositionQuality::TCostIndicator | CostUpdate | ( | ) | const |
Returns the update value for the cost attribute.
Returns the update value for the cost attribute.
| IMPORT_C void | SetUpdateAvailability | ( | TBool | aIsAvailable | ) |
Sets new module availability value.
Availability indicates if the positioning module is available for use via Location Acquisition API.
The change is committed by calling CPosModules::UpdateModuleL() .
| TBool aIsAvailable | ETrue if the module should be available, EFalse otherwise. |
| IMPORT_C void | SetUpdateCost | ( | TPositionQuality::TCostIndicator | aCost | ) |
Sets new cost attribute value.
Cost is just an indication of the charge involved when using a certain positioning module to retrieve a position. The cost indication may be inaccurate and can be updated by a client.
The change is committed by calling CPosModules::UpdateModuleL() .
| TPositionQuality::TCostIndicator aCost | The new cost indicator value. |
| IMPORT_C void | SetUpdateVisibility | ( | TBool | aIsVisible | ) |
Sets new visibility attribute value.
Visibility defines if this module should be listed by CPosModules::ModuleIdListL() and CPosModules::ModuleIdListLC() . It also affects RPositionServer::GetNumModules() and RPositionServer::GetModuleByIndex().
The change is committed by calling CPosModules::UpdateModuleL() .
| TBool aIsVisible | The new visibility value. ETrue - visible, otherwise not. |
| TUint | UpdateMap | ( | ) | const |
Returns the update bitmap.
Returns the update bitmap. The bitmap contains information of which attributes will be updated. Individual attributes can be masked out by applying the constants which start with KPosModUpdate .
| TBool | VisibilityUpdate | ( | ) | const |
Returns the update value for the visibility attribute.
Returns the update value for the visibility attribute.
| CPosModuleUpdate & | operator= | ( | const CPosModuleUpdate & | ) | [private] |
| const CPosModuleUpdate & |
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.