1 /*

     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef POSITIONINGPLUGINFWINTERNALCRKEYS_H

    21 #define POSITIONINGPLUGINFWINTERNALCRKEYS_H

    22 

    23 /**

    24  * @file PositioningPluginFWInternalCRKeys.h

    25  * This header file defines central repository keys for publishing PSY static

    26  * capabilities and basic setup information related to the PSY. Each PSY should 

    27  * define these values for the specific PSY through central repository.

    28  * @publishedPartner

    29  * @released

    30  * 

    31  */

    32 

    33 

    34 /**

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

    36  * 

    37  * Key Type: Integer

    38  */	

    39 const TUint32 KPSYInterfaceVersion    = 0x00000001;

    40 

    41 /**

    42  * The positioning module priority value is specified as one of the enumerated values of TModulePriority.

    43  * The preferred priority may be overridden by Location Settings and when factory settings are reset.

    44  * Location Settings decides the priority of the positioning module if this value is set to EPriorityAuto.

    45  * 

    46  * Key Type : Integer

    47  */

    48 const TUint32 KPSYPriority            = 0x00000002;

    49 

    50 /**

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

    52  * 

    53  * Key Type: Integer

    54  * 

    55  * Values can be

    56  * - 0: Not available and	

    57  * - 1: Available

    58  */

    59 const TUint32 KPSYStatus              = 0x00000003;

    60 

    61 /**

    62  * The estimated time to obtain the initial location fix from the positioning 

    63  * plug-in after a connection is established. The value should not be a 

    64  * negative number and is mentioned in microseconds.

    65  * 

    66  * Key Type: Long Integer

    67  */

    68 const TUint32 KPSYTimeToFirstFix      = 0x00000004;

    69 

    70 /**

    71  * The estimated time to obtain a fix when the current position is known.

    72  * It value should not be a negative number and is mentioned in microseconds.

    73  * 

    74  * Key Type: Long Integer

    75  */

    76 const TUint32 KPSYTimeToNextFix       = 0x00000005;

    77 

    78 /**

    79  * This value specifies the estimated error for the latitude and longitude 

    80  * components of a position. The value is in meters.

    81  * 

    82  * Key Type: Real

    83  */

    84 const TUint32 KPSYHorizontalAccuracy  = 0x00000006;

    85 

    86 /**

    87  * The value specifies the error in the altitude component.

    88  * The value is in meters.

    89  * 

    90  * Key Type: Real

    91  */

    92 const TUint32 KPSYVerticalAccuracy    = 0x00000007;

    93 

    94 /**

    95  * This key indicates whether there will be a monetary charge for obtaining a fix.

    96  * It is specified as one of the value of the enumeration 

    97  * TPositionQuality::TCostIndicator.

    98  * 

    99  * Key Type: Integer

   100  * 

   101  * If a positioning module is uncertain about the cost of obtaining a fix, 

   102  * it should use the value ECostPossible rather than ECostUnknown.

   103  */

   104 const TUint32 KPSYCostIndicator       = 0x00000008;

   105 

   106 /**

   107  * This key indicates the expected internal power usage involved in obtaining a fix.

   108  * The power consumption is reported on a simple scale ranging from zero to High.

   109  * It is specified as one of the values of the enumerator TPositionQuality::TPowerConsumption.

   110  * 

   111  * Key Type: Integer

   112  */

   113 const TUint32 KPSYPowerConsumption    = 0x00000009;

   114 

   115 /**

   116  * Indicates the primary technologies used by this PSY to obtain position information.

   117  * Its value is a bitmask which is a combination of the values specified in the

   118  * enumerator TPositionModuleInfo::_TTechnologyType.

   119  * 

   120  * Key Type: Integer

   121  */

   122 const TUint32 KPSYTechnologyType      = 0x0000000a;

   123 

   124 /**

   125  * Indicates whether the positioning hardware used by the PSY is integral or external.

   126  * Its value is a bitmask which is a combination of the values specified in the

   127  * enumerator TPositionModuleInfo::_TDeviceLocation.

   128  * 

   129  * Key Type: Integer

   130  */

   131 const TUint32 KPSYDeviceLocation      = 0x0000000b;

   132 

   133 /**

   134  * Indicates the various different types of position information the PSY is able to return.

   135  * Its value is a bitmask which is a combination of the values specified in the

   136  * enumerator TPositionModuleInfo::_TCapabilities.

   137  * 

   138  * Key Type: Integer

   139  */

   140 const TUint32 KPSYCapabilities        = 0x0000000c;

   141 

   142 /**

   143  * Indicates the different position data classes supported by this PSY.

   144  * This is a bitmask specifying which TPositionInfoBase classes can be handled

   145  * by the PSY. The bitmask is a combination of the value specified in the 

   146  * enumerator _TPositionInfoClassType.

   147  * 

   148  * Key Type: Integer

   149  *

   150  * A PSY must always support at least TPositionInfo

   151  */

   152 const TUint32 KPSYClassesSupported    = 0x0000000d;

   153 

   154 /**

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

   156  * 

   157  * Key Type: Integer

   158  * 

   159  * The values can be

   160  * - 0 : Invisible

   161  * - 1 : Visible

   162  *

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

   164  */

   165 const TUint32 KPSYVisibility          = 0x0000000e;

   166 

   167 /**

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

   169  * 

   170  * Key Type: Integer

   171  *

   172  * If the key does not exist or the resource file does not exist then the name

   173  * mentioned in the ECOM implementation resource file will be used as the PSY

   174  * name.

   175  */

   176 const TUint32 KPSYNameResource        = 0x0000000f;

   177 

   178 /**

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

   180  */

   181 const TInt KPSYNameResourceMaxLength = 64;

   182 

   183 #endif      // POSITIONINGPLUGINFWINTERNALCRKEYS_H