CPosModuleUpdate Class Reference

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.

Inherits from

Constructor & Destructor Documentation

CPosModuleUpdate()

CPosModuleUpdate ( ) [private]

CPosModuleUpdate(const CPosModuleUpdate &)

CPosModuleUpdate ( const CPosModuleUpdate & ) [private]

Parameters

const CPosModuleUpdate &

~CPosModuleUpdate()

~CPosModuleUpdate ( ) [virtual]

Destructor.

Member Functions Documentation

AvailabilityUpdate()

TBool AvailabilityUpdate ( ) const

Returns the update value for the module status attribute.

Returns the update value for the module status attribute.

ConstructL()

void ConstructL ( ) [private]

CostUpdate()

TPositionQuality::TCostIndicator CostUpdate ( ) const

Returns the update value for the cost attribute.

Returns the update value for the cost attribute.

NewLC()

IMPORT_C CPosModuleUpdate * NewLC ( ) [static]

Two-phased constructor.

SetUpdateAvailability(TBool)

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() .

Parameters

TBool aIsAvailable ETrue if the module should be available, EFalse otherwise.

SetUpdateCost(TPositionQuality::TCostIndicator)

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() .

Parameters

TPositionQuality::TCostIndicator aCost The new cost indicator value.

SetUpdateVisibility(TBool)

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() .

Parameters

TBool aIsVisible The new visibility value. ETrue - visible, otherwise not.

UpdateMap()

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 .

VisibilityUpdate()

TBool VisibilityUpdate ( ) const

Returns the update value for the visibility attribute.

Returns the update value for the visibility attribute.

operator=(const CPosModuleUpdate &)

CPosModuleUpdate & operator= ( const CPosModuleUpdate & ) [private]

Parameters

const CPosModuleUpdate &

Member Data Documentation

TPositionQuality::TCostIndicator iCostUpdate

TPositionQuality::TCostIndicator iCostUpdate [private]

TBool iIsAvailableUpdate

TBool iIsAvailableUpdate [private]

TBool iIsVisibleUpdate

TBool iIsVisibleUpdate [private]

TUint iUpdateMask

TUint iUpdateMask [private]