positioningpluginfwinternalcrkeys.h File Reference

const TUint32 KPSYInterfaceVersion

const TUint32 KPSYInterfaceVersion

The version of the Positioning Plug-in Information API implemented in this repository.

Key Type: Integer

const TUint32 KPSYPriority

const TUint32 KPSYPriority

The positioning module priority value is specified as one of the enumerated values of TModulePriority. The preferred priority may be overridden by Location Settings and when factory settings are reset. Location Settings decides the priority of the positioning module if this value is set to EPriorityAuto.

Key Type : Integer

const TUint32 KPSYStatus

const TUint32 KPSYStatus

The module status set to the positioning module when installed to the system.

Key Type: Integer

Values can be
  • 0: Not available and

  • 1: Available

const TUint32 KPSYTimeToFirstFix

const TUint32 KPSYTimeToFirstFix

The estimated time to obtain the initial location fix from the positioning plug-in after a connection is established. The value should not be a negative number and is mentioned in microseconds.

Key Type: Long Integer

const TUint32 KPSYTimeToNextFix

const TUint32 KPSYTimeToNextFix

The estimated time to obtain a fix when the current position is known. It value should not be a negative number and is mentioned in microseconds.

Key Type: Long Integer

const TUint32 KPSYHorizontalAccuracy

const TUint32 KPSYHorizontalAccuracy

This value specifies the estimated error for the latitude and longitude components of a position. The value is in meters.

Key Type: Real

const TUint32 KPSYVerticalAccuracy

const TUint32 KPSYVerticalAccuracy

The value specifies the error in the altitude component. The value is in meters.

Key Type: Real

const TUint32 KPSYCostIndicator

const TUint32 KPSYCostIndicator

This key indicates whether there will be a monetary charge for obtaining a fix. It is specified as one of the value of the enumeration TPositionQuality::TCostIndicator .

Key Type: Integer

If a positioning module is uncertain about the cost of obtaining a fix, it should use the value ECostPossible rather than ECostUnknown.

const TUint32 KPSYPowerConsumption

const TUint32 KPSYPowerConsumption

This key indicates the expected internal power usage involved in obtaining a fix. The power consumption is reported on a simple scale ranging from zero to High. It is specified as one of the values of the enumerator TPositionQuality::TPowerConsumption .

Key Type: Integer

const TUint32 KPSYTechnologyType

const TUint32 KPSYTechnologyType

Indicates the primary technologies used by this PSY to obtain position information. Its value is a bitmask which is a combination of the values specified in the enumerator TPositionModuleInfo::_TTechnologyType .

Key Type: Integer

const TUint32 KPSYDeviceLocation

const TUint32 KPSYDeviceLocation

Indicates whether the positioning hardware used by the PSY is integral or external. Its value is a bitmask which is a combination of the values specified in the enumerator TPositionModuleInfo::_TDeviceLocation .

Key Type: Integer

const TUint32 KPSYCapabilities

const TUint32 KPSYCapabilities

Indicates the various different types of position information the PSY is able to return. Its value is a bitmask which is a combination of the values specified in the enumerator TPositionModuleInfo::_TCapabilities .

Key Type: Integer

const TUint32 KPSYClassesSupported

const TUint32 KPSYClassesSupported

Indicates the different position data classes supported by this PSY. This is a bitmask specifying which TPositionInfoBase classes can be handled by the PSY. The bitmask is a combination of the value specified in the enumerator _TPositionInfoClassType.

Key Type: Integer

A PSY must always support at least TPositionInfo

const TUint32 KPSYVisibility

const TUint32 KPSYVisibility

Indicates whether the PSY is visible to clients of the Location API.

Key Type: Integer

The values can be
  • 0 : Invisible

  • 1 : Visible

A PSY is set to invisible typically if it is a proxy PSY.

const TUint32 KPSYNameResource

const TUint32 KPSYNameResource

Indicates the resource file name that contains the localized name for this PSY.

Key Type: Integer

If the key does not exist or the resource file does not exist then the name mentioned in the ECOM implementation resource file will be used as the PSY name.

const TInt KPSYNameResourceMaxLength

const TInt KPSYNameResourceMaxLength

The maximum length for the localized resource file name for the key KPSYNameResource.