lbsadminsettings.h File Reference

const TLbsAdminSetting KLbsSettingNone

const TLbsAdminSettingKLbsSettingNone

No setting

const TLbsAdminSetting KLbsSettingHomeSelfLocate

const TLbsAdminSettingKLbsSettingHomeSelfLocate

Self locate configuration for Home Network CLbsAdmin::TSelfLocateService

const TLbsAdminSetting KLbsSettingRoamingSelfLocate

const TLbsAdminSettingKLbsSettingRoamingSelfLocate

Self locate configuration when roaming CLbsAdmin::TSelfLocateService

const TLbsAdminSetting KLbsSettingQualityProfileSelfLocate

const TLbsAdminSettingKLbsSettingQualityProfileSelfLocate

Positioning quality profile for the Self Locate requests. Used when the application does not specify its own criteria. Profile definitions TBD. TProfileId

const TLbsAdminSetting KLbsSettingHomeExternalLocate

const TLbsAdminSettingKLbsSettingHomeExternalLocate

External locate configuration for Home Network.

Defines if external location requests (received from the network or from the Network Privacy API or the Privacy Request API) are processed. This setting is not checked when LBS is configured to use a Privacy Q&N Notifier (if KLbsSettingPrivacyHandler == CLbsAdmin::EPrivacyHandleByAdvancedNotifier) - requests are always sent to the Notifier.

The setting may be retrieved in two ways. The default setting may be read by using the CLbsAdmin::TExternalLocateService type when calling CLbsAdmin::Get(). By using the TLbsAdminExtLocServicesInfo type it is possible to get both, the default setting, and the module specific settings.

Module specific settings supersede the default setting.

CLbsAdmin::TExternalLocateService TLbsAdminExtLocServicesInfo KLbsSettingPrivacyHandler

const TLbsAdminSetting KLbsSettingRoamingExternalLocate

const TLbsAdminSettingKLbsSettingRoamingExternalLocate

External locate configuration when roaming. For additional information see KLbsSettingHomeExternalLocate.CLbsAdmin::TExternalLocateService TLbsAdminExtLocServicesInfo KLbsSettingPrivacyHandler

const TLbsAdminSetting KLbsSettingQualityProfileExternalLocate

const TLbsAdminSettingKLbsSettingQualityProfileExternalLocate

Positioning quality profile for the External Locate requests. Used when the application does not specify its own criteria. Profile definitions TBD. TProfileId

const TLbsAdminSetting KLbsSettingHomeEmergencyLocate

const TLbsAdminSettingKLbsSettingHomeEmergencyLocate

Emergency External locate configuration for Home Network. CLbsAdmin::TExternalLocateService

const TLbsAdminSetting KLbsSettingRoamingEmergencyLocate

const TLbsAdminSettingKLbsSettingRoamingEmergencyLocate

Emergency External locate configuration when roaming CLbsAdmin::TExternalLocateService

const TLbsAdminSetting KLbsSettingHomeTransmitLocate

const TLbsAdminSettingKLbsSettingHomeTransmitLocate

Send to 3rd party for Home Network CLbsAdmin::TTransmitLocateService

const TLbsAdminSetting KLbsSettingRoamingTransmitLocate

const TLbsAdminSettingKLbsSettingRoamingTransmitLocate

Send to 3rd party when roaming CLbsAdmin::TTransmitLocateService

const TLbsAdminSetting KLbsSettingQualityProfileTransmitLocate

const TLbsAdminSettingKLbsSettingQualityProfileTransmitLocate

Positioning quality profile for the Transmit to 3rd party requests. Used when the application does not specify its own criteria. Profile definitions TBD. TProfileId

const TLbsAdminSetting KLbsSettingHomeGpsMode

const TLbsAdminSettingKLbsSettingHomeGpsMode

GPS mode when in home network CLbsAdmin::TGpsMode

const TLbsAdminSetting KLbsSettingRoamingGpsMode

const TLbsAdminSettingKLbsSettingRoamingGpsMode

GPS mode when roaming CLbsAdmin::TGpsMode

const TLbsAdminSetting KLbsSettingHomeProtocolModule

const TLbsAdminSettingKLbsSettingHomeProtocolModule

Network Protocol module(s) for Home Network.

The setting may be retrieved in two ways. The Id of the default module may be read by using the TProtocolModuleId type when calling CLbsAdmin::Get(). By using the TLbsAdminProtocolModulesInfo type it is possible to retrieve a list of all the Protocol Modules to be loaded.

TProtocolModuleId TLbsAdminProtocolModulesInfo

const TLbsAdminSetting KLbsSettingRoamingProtocolModule

const TLbsAdminSettingKLbsSettingRoamingProtocolModule

Network Protocol module(s) when roaming. For details see KLbsSettingHomeProtocolModule.TProtocolModuleId TLbsAdminProtocolModulesInfo

const TLbsAdminSetting KLbsSettingLbsSystemStartMode

const TLbsAdminSettingKLbsSettingLbsSystemStartMode

System mode configuration CLbsAdmin::TLbsSystemStartMode

const TLbsAdminSetting KLbsSettingPrivacyTimeoutAction

const TLbsAdminSettingKLbsSettingPrivacyTimeoutAction

const TLbsAdminSetting KLbsSettingPrivacyHandler

const TLbsAdminSettingKLbsSettingPrivacyHandler

Privacy Handler selection CLbsAdmin::TPrivacyHandler

const TLbsAdminSetting KLbsSettingBehaviourMode

const TLbsAdminSettingKLbsSettingBehaviourMode

LBS behaviour mode selection CLbsAdmin::TLbsBehaviourMode

const TLbsAdminSetting KLbsSettingLogger

const TLbsAdminSettingKLbsSettingLogger

Usage Logging This setting is designed to only be read on LBS system startup. Changing it via this API while LBS is running could cause undefined behaviour. CLbsAdmin::TLogger

const TLbsAdminSetting KLbsSpecialFeatureMaximumRequestDelay

const TLbsAdminSettingKLbsSpecialFeatureMaximumRequestDelay

Enabling LBS special features. Extra caution and full understanding of the effects is required when manipulating special features. A user MUST NOT be allowed to change them (e.g. through a UI Control Panel type application). A licensee must decide which features will be supported and fix them before a phone's release.

These settings are read-only.

KLbsSpecialFeatureMaximumRequestDelay KLbsSpecialFeatureAllowTBFinalNetPos KLbsSpecialFeatureIgnoreAccuracy KLbsSpecialFeatureWithholdDeliveryOfReferencePositions KLbsSettingLogger This feature allows LBS to temporarily buffer the following locations and errors: a single Reference Location from the network, a single Final Network Location from the network or a single Error Code from an AGPS Module.Reason for introducing the feature: When using RPositioner from the Location Acquisition API there are very short periods of time when the LBS subsystem has no outstanding location request. This happens when an application has received an asynchronous notification (CActive::RunL()) signalling completion of a previous request, but has not yet sent a new request by calling RPositioner::NotifyPositionUpdate().

The time is defined in milliseconds and is of TLbsTimeIntervalMilliSeconds type. Acceptable values are between 0 and KLbsMaximumRequestDelayMax (values above this report KErrAgrument) where 0 turns the feature OFF. Note that under normal circumstances using values greater than 100ms should not be required and suggests problems with a user application or platform performance (e.g. a high priority process is using nearly 100% of CPU time).

The feature must NOT be used to accommodate for badly behaving applications that do not reissue RPositioner::NotifyPositionUpdate() immediately.

This setting is read-only, and is disabled if a value of 0 is used.

TLbsTimeIntervalMilliSeconds KLbsSettingMaximumRequestDelay RPositioner::NotifyPositionUpdate() MLbsNetworkProtocolObserver::ProcessLocationUpdate()

const TLbsAdminSetting KLbsSpecialFeatureAllowTBFinalNetPos

const TLbsAdminSettingKLbsSpecialFeatureAllowTBFinalNetPos

This feature enables the delivery of Terminal Based Final Network Locations to a local application.

This feature may cause very serious side effects (including not up to date locations being reported to the client application) and must NOT be normally used.

This setting is read-only.

TSpecialFeature RPositioner::NotifyPositionUpdate() MLbsNetworkProtocolObserver::ProcessLocationUpdate()

const TLbsAdminSetting KLbsSpecialFeatureWithholdDeliveryOfReferencePositions

const TLbsAdminSettingKLbsSpecialFeatureWithholdDeliveryOfReferencePositions

This feature enables the delivery of reference positions to a local application that has opened the RPositioner by explicitly specifying the module ID.

This feature may cause very serious side effects (including not up to date locations being reported to the client application) and must NOT be normally used.

This setting is read-only.

TSpecialFeature RPositioner::NotifyPositionUpdate()

const TLbsAdminSetting KLbsProtocolModuleLoading

const TLbsAdminSettingKLbsProtocolModuleLoading

Specifies the Protocol Module loading strategy. There are two loading strategies supported. Loading just one Protocol Module saves memory, but requires the LBS system to be restarted in order to load a different module (e.g. after roaming status change). Loading all (both roaming and home) Protocol Modules uses more memory, but does not require restarting LBS when roaming status changes. The latter strategy should be used if emergency call support is required (to avoid memory allocation failures).

TLbsAdminProtocolModuleLoadingInfo

const TLbsAdminSetting KLbsSettingMaximumExternalLocateRequests

const TLbsAdminSettingKLbsSettingMaximumExternalLocateRequests

The maximum number of external locate requests that can be active at any time.

The value 0 is reserved for future use. The value 1 is the default, this allows only one active external locate request at a time. Values greater than 1 allow multiple requests to be handled simultaneously. Values up to KMaxTInt can be set, but memory limitations restrict the number of requests that can be supported. A privacy request will leave with error code KErrNoMemory if there is insufficient free memory to support it.

If the maximum number of simultaneous requests is reached, then any further requests are rejected. This setting is read only on LBS system startup. Setting it via the LBS Admin API has no effect while LBS running. Setting will take effect during next LBS system startup. MLbsPrivacyRequestObserver::OnPrivacyResponse() MPosVerificationObserver::HandleVerifyComplete()

const TLbsAdminSetting KLbsSettingPrivacyShutdownDelay

const TLbsAdminSettingKLbsSettingPrivacyShutdownDelay

The time to wait after the last privacy client disconnects before shutting down LBS. Only used with the Network Privacy API and the Privacy Request API. This setting is read only on LBS system startup. Setting it via the LBS Admin API has no effect while LBS running. Setting will take effect during next LBS system startup.

Time is specified in microseconds.

CPosNetworkPrivacy CLbsPrivacyRequest

const TLbsAdminSetting KLbsSettingPrivacyMaxNetworkSessions

const TLbsAdminSettingKLbsSettingPrivacyMaxNetworkSessions

The maximum number of concurrent network privacy sessions allowed with the Network Privacy API. This setting is read only on LBS system startup. Setting it via the LBS Admin API has no effect while LBS running. Setting will take effect during next LBS system startup.

The value 0 disallows any network privacy sessions

CPosNetworkPrivacy

const TLbsAdminSetting KLbsSettingPrivacyConnectionTimeout

const TLbsAdminSettingKLbsSettingPrivacyConnectionTimeout

The connection timeout for sessions using the Network Privacy API. This setting is read only on LBS system startup. Setting it via the LBS Admin API has no effect while LBS running. Setting will take effect during next LBS system startup.

Time is specified in microseconds.

CPosNetworkPrivacy

const TLbsAdminSetting KLbsSpecialFeatureIgnoreAccuracy

const TLbsAdminSettingKLbsSpecialFeatureIgnoreAccuracy

This feature enables the withholding of the delivery of reference positions to a local application that has opened the RPositioner by explicitly specifying a GPS module ID

TSpecialFeature RPositioner::NotifyPositionUpdate

const TLbsAdminSetting KLbsSettingPrivacyAppTimeout

const TLbsAdminSettingKLbsSettingPrivacyAppTimeout

Privacy Timeout Time in milliseconds that LBS will wait for a response from the privacy controller application / notifier A value of zero means never timeout/wait forever. KLbsSettingPrivacyAppTimeout TLbsTimeIntervalMilliSeconds

const TLbsAdminSetting KLbsSpecialFeatureIntermediateFutileUpdate

const TLbsAdminSettingKLbsSpecialFeatureIntermediateFutileUpdate

This feature enables the LBS subsystem to check for 'futile' GPS updates between location requests when LBS is working in either Terminal Assisted Mode or Simultaneous Terminal Assisted Mode & Terminal Based Mode (also known as Hybrid Mode).

The LBS subsystem does not normally return a location update to the network if it occurs while there is no outstanding location request from the network. This is normally the correct behaviour.

In Hybrid Mode or Terminal Assisted Mode, a licensee's GPS module may decide that there is no way of getting a GPS fix and return a 'futile' update during the session. If the update happens while there is no outstanding network request then it is ignored and the futile update is not sent to the network.

Turning this setting on enables the LBS subsystem to look for futile updates between location requests and to return the updates to the network.

This feature only applies when the LBS subsystem is working in Hybrid Mode or Terminal Assisted Mode. This feature may cause very serious side effects and must NOT be normally used.

This setting is read-only. TSpecialFeature

const TLbsAdminSetting KLbsSettingHomeNetworkInducedLocate

const TLbsAdminSettingKLbsSettingHomeNetworkInducedLocate

Network induced locate configuration for Home Network. CLbsAdmin::TExternalLocateService

const TLbsAdminSetting KLbsSettingRoamingNetworkInducedLocate

const TLbsAdminSettingKLbsSettingRoamingNetworkInducedLocate

Network induced locate configuration when roaming CLbsAdmin::TExternalLocateService

const TLbsAdminSetting KLbsSettingSetClockModule

const TLbsAdminSettingKLbsSettingSetClockModule

Licensee specific Set Clock Module Id. A null value means that a default, internal implementation should be used. TLbsSetClockModuleId

const TLbsAdminSetting KLbsSettingClockAdjustInterval

const TLbsAdminSettingKLbsSettingClockAdjustInterval

Automatic clock adjustment interval in microseconds. The value defines the time between consecutive attempts to automatically adjust the clock. Relevant only if automatic clock adjustment is enabled. CLbsAdmin::KLbsSettingClockAdjust CLbsAdmin::KLbsSettingClockAdjustThreshold

const TLbsAdminSetting KLbsSettingClockAdjustThreshold

const TLbsAdminSettingKLbsSettingClockAdjustThreshold

Automatic clock adjustment threshold in microseconds. If the difference between the system UTC time and the GPS based UTC time is less than the threshold then the system clock is not being adjusted. Relevant only if automatic clock adjustment is enabled. CLbsAdmin::KLbsSettingClockAdjust TTimeIntervalMilliSeconds

const TLbsAdminSetting KLbsSettingAllowManualClockAdjust

const TLbsAdminSettingKLbsSettingAllowManualClockAdjust

Allow the system clock to be adjusted manually (synchronised with GPS on user demand). CLbsAdmin::TClockAdjust

const TLbsAdminSetting KLbsSettingClockAdjust

const TLbsAdminSettingKLbsSettingClockAdjust

Synchronise the handset clock with the time obtained from GPS. CLbsAdmin::TClockAdjust