epoc32/include/lbsfieldids.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2006-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 * Name        : LbsFieldIds.h
    16 * Part of     : Location Framework/Location FW
    17 * Interface   : Location Acquisition API
    18 * Position data Fields
    19 * Version     : %version: 4 %
    20 *
    21 */
    22 
    23 
    24 
    25 #ifndef __LBSFIELDIDS_H__
    26 #define __LBSFIELDIDS_H__
    27 
    28 #include <e32std.h>
    29 
    30 /* This file contains the enumerations for the different positioning
    31  * related fields that a positioning technology can return.
    32  */
    33  
    34 /**
    35  * Standard position field identifiers.
    36  * It defines the enumerated values that indicates the different types of
    37  * positioning related information that a positioning module can return. 
    38  * Each of these fields are categorised into different capabilities.
    39  * Even though the client can request for any of these fields, 
    40  * the positioning module may or may not return this information based 
    41  * on its capability.
    42  * The data type for each field is also specified here. This data type
    43  * must be used when retrieving the value for this field using
    44  * HPositionGenericInfo::GetValue()
    45  * @publishedAll
    46  * @released
    47  */
    48 enum _TPositionFieldId
    49 	{
    50 	/**  
    51     * Reserved field ID. Used to terminate an array of requested fields. 
    52      */
    53 	EPositionFieldNone,
    54 	/**
    55 	 * A free field that can be used for a comment.
    56      * This field can be returned by any type of positioning technology.
    57 	 * The value of this field uses data type TDes16.
    58      */
    59 	EPositionFieldComment,
    60     
    61     /**
    62      * Fields related to Speed capability are part of this section.
    63      */
    64 	EPositionFieldSpeedCapabilitiesBegin		= 100,
    65 	/**
    66 	 * Horizontal speed at which the terminal is travelling. 
    67 	 * The value of this field is specified in metres per second and 
    68 	 * it uses data type TReal32.
    69 	 */
    70 	EPositionFieldHorizontalSpeed,
    71 	/**
    72 	 * Accuracy of the horizontal speed defined by the field 
    73 	 * #EPositionFieldHorizontalSpeed.
    74 	 * The value of this field is specified in metres per second and 
    75 	 * it uses data type TReal32.
    76 	 */
    77 	EPositionFieldHorizontalSpeedError,
    78 	/**
    79 	 * Vertical speed at which the terminal is travelling. 
    80 	 * The value of this field is specified in metres per second and 
    81 	 * it uses data type TReal32.
    82 	 */
    83 	EPositionFieldVerticalSpeed,
    84 	/**
    85 	 * Accuracy of the vertical speed defined by the field 
    86 	 * #EPositionFieldVerticalSpeed.
    87 	 * The value of this field is specified in metres per second and 
    88 	 * it uses data type TReal32.
    89 	 */
    90 	EPositionFieldVerticalSpeedError,
    91 
    92     /**
    93      * Fields related to Direction capability are part of this section.
    94      */
    95 	EPositionFieldDirectionCapabilitiesBegin	= 200,
    96 	/**
    97 	 * Current direction measured with respect to the true north.
    98 	 * The value of this field is specified in degrees and it
    99 	 * uses data type TReal32.
   100 	 */
   101 	EPositionFieldTrueCourse,
   102 	/**
   103 	 * Accuracy of the current direction defined by the field 
   104 	 * #EPositionFieldTrueCourse. This field is measured with respect
   105 	 * to true north.
   106 	 * The value of this field is specified in degrees and it
   107 	 * uses data type TReal32.
   108 	 */
   109 	EPositionFieldTrueCourseError,
   110 	/**
   111 	 * Current direction measured with respect to the magnetic north.
   112 	 * The value of this field is specified in degrees and it
   113 	 * uses data type TReal32.
   114 	 */
   115 	EPositionFieldMagneticCourse,
   116 	/**
   117 	 * Accuracy of the current direction defined by the field 
   118 	 * #EPositionFieldMagneticCourse. This field is measured with respect 
   119 	 * to magnetic north.
   120 	 * The value of this field is specified in degrees and it
   121 	 * uses data type TReal32.
   122 	 */
   123 	EPositionFieldMagneticCourseError,
   124 
   125     /**
   126      * Fields related to Compass capability are part of this section.
   127      */
   128 	EPositionFieldCompassCapabilitiesBegin		= 300,
   129 	/**
   130 	 * Current instantaneous direction of traveling measured with respect 
   131 	 * to the true north.
   132 	 * The value of this field is specified in degrees and it
   133 	 * uses data type TReal32.
   134 	 */
   135 	EPositionFieldHeading, 
   136 	/**
   137 	 * Accuracy of current instantaneous direction of traveling defined
   138      * by the field #EPositionFieldHeading. This field is measured with
   139 	 * respect to the true north.
   140 	 * The value of this field is specified in degrees and it
   141 	 * uses data type TReal32.
   142 	 */
   143 	EPositionFieldHeadingError,
   144 	/**
   145 	 * Current instantaneous direction of traveling measured with respect 
   146 	 * to the magnetic north.
   147 	 * The value of this field is specified in degrees and it
   148 	 * uses data type TReal32.
   149 	 */
   150 	EPositionFieldMagneticHeading, 
   151 	/**
   152 	 * Accuracy of current instantaneous direction of traveling defined
   153      * by the field #EPositionFieldMagneticHeading. This field is measured
   154 	 * with respect to the magnetic north.
   155 	 * The value of this field is specified in degrees and it
   156 	 * uses data type TReal32.
   157 	 */
   158 	EPositionFieldMagneticHeadingError,
   159 
   160     /**
   161      * Fields related to Address capability are part of this section.
   162      */
   163 	EPositionFieldAddressCapabilitiesBegin		= 400,
   164 	/**
   165 	 * Name of the country.
   166 	 * The value of this field uses data type TDes16.
   167 	 */
   168 	EPositionFieldCountry,
   169 	/**
   170 	 * Country as specified by the two letter ISO 3166-1 code.
   171 	 * The value of this field uses data type TDes16.
   172 	 */
   173 	EPositionFieldCountryCode,
   174 	/**
   175 	 * Name of the state within the country specfied by the field 
   176 	 * #EPositionFieldCountry.
   177 	 * The value of this field uses data type TDes16.
   178 	 */
   179 	EPositionFieldState,
   180 	/**
   181 	 * Name of the city within the state specfied by the field 
   182 	 * #EPositionFieldState.
   183 	 * The value of this field uses data type TDes16.
   184 	 */
   185 	EPositionFieldCity,
   186 	/**
   187 	 * Name of the municipal district within the city specified by the field
   188      * #EPositionFieldCity.
   189 	 * The value of this field uses data type TDes16.
   190 	 */
   191 	EPositionFieldDistrict,
   192 	/**
   193 	 * Street name and building number.
   194 	 * The value of this field uses data type TDes16.
   195 	 */
   196 	EPositionFieldStreet,
   197 	/**
   198 	 * Additional details about the location within a building. For example,
   199 	 * flat number.
   200 	 * The value of this field uses data type TDes16.
   201 	 */
   202 	EPositionFieldStreetExtension,
   203 	/**
   204 	 * Name of the company, organization or building at the address.
   205 	 * The value of this field uses data type TDes16.
   206 	 */
   207 	EPositionFieldLocationName,
   208 	/**
   209 	 * Post code or Zip code of the address.
   210 	 * The value of this field uses data type TDes16.
   211 	 */
   212 	EPositionFieldPostalCode,
   213 	/**
   214 	 * Name of locality. Locality denotes a small geographical area. 
   215 	 * Locality is usually not a part of the official address.
   216 	 * The value of this field uses data type TDes16.
   217 	 */
   218 	EPositionFieldLocality,
   219 	/**
   220 	 * Information about the cross within the street field, 
   221 	 * #EPositionFieldStreet.
   222 	 * The value of this field uses data type TDes16.
   223 	 */
   224 	EPositionFieldCrossing1,
   225 	/**
   226 	 * Extension for the cross field defined by #EPositionFieldCrossing1.
   227 	 * The value of this field uses data type TDes16.
   228 	 */
   229 	EPositionFieldCrossing2,
   230 	/**
   231 	 * Name of the county, region or province.
   232 	 * The value of this field uses data type TDes16.
   233 	 */
   234 	EPositionFieldCounty,
   235 
   236     /**
   237      * Fields related to Building capability are part of this section.
   238      */
   239 	EPositionFieldBuildingCapabilitiesBegin		= 500,
   240 	/**
   241 	 * Name of the building.
   242 	 * The value of this field uses data type TDes16.
   243 	 */
   244 	EPositionFieldBuildingName,
   245 	/**
   246 	 * Floor or level within the building.
   247 	 * The value of this field uses data type TDes16.
   248 	 */
   249 	EPositionFieldBuildingFloor,
   250 	/**
   251 	 * Room name or number within the building.
   252 	 * The value of this field uses data type TDes16.
   253 	 */
   254 	EPositionFieldBuildingRoom,
   255 	/**
   256 	 * Section of a building.
   257 	 * The value of this field uses data type TDes16.
   258 	 */
   259 	EPositionFieldBuildingZone,
   260 	/**
   261 	 * Telephone number associated with the building.
   262 	 * The value of this field uses data type TDes16.
   263 	 */
   264 	EPositionFieldBuildingTelephone,
   265 
   266     /**
   267      * Fields related to NMEA capability are part of this section.
   268      */
   269 	EPositionFieldNMEACapabilitiesBegin			= 600,
   270 	/**
   271 	 * Raw NMEA data. If the client requests this field then on completion,
   272 	 * it contains the number of NMEA sentences provided by the positioning
   273 	 * module.
   274 	 * The value of this field uses data type TUint8.
   275 	 */
   276 	EPositionFieldNMEASentences,
   277 	/**
   278 	 * The first NMEA sentence. The rest of the sentences follow this field
   279 	 * The value of this field uses data type TDes8.
   280 	 */
   281 	EPositionFieldNMEASentencesStart,
   282 
   283     /**
   284      * Fields related to Satellite capability are part of this section.
   285      */
   286 	EPositionFieldSatelliteCapabilitiesBegin	= 700,
   287 	/**
   288 	 * The number of satellites currently in view. 
   289 	 * The value of this field uses data type TInt8.
   290 	 */
   291 	EPositionFieldSatelliteNumInView,
   292 	/**
   293 	 * The number of satellites being used to provide position information.
   294 	 * The value of this field uses data type TInt8.
   295 	 */
   296 	EPositionFieldSatelliteNumUsed,
   297 	/**
   298 	 * The time as obtained from satellites. 
   299 	 * The value of this field uses data type TTime.
   300 	 */
   301 	EPositionFieldSatelliteTime,
   302 	/**
   303 	 * The Horizontal dilution of precision. Dilution of precision is 
   304 	 * associated with the accuracy of the field.
   305 	 * The value of this field uses data type TReal32.
   306 	 */
   307 	EPositionFieldSatelliteHorizontalDoP,
   308 	/**
   309 	 * The Vertical dilution of precision.
   310 	 * The value of this field uses data type TReal32.
   311 	 */
   312 	EPositionFieldSatelliteVerticalDoP,
   313 	/**
   314 	 * The dilution of precision in time.
   315 	 * The value of this field uses data type TReal32.
   316 	 */
   317 	EPositionFieldSatelliteTimeDoP,
   318 	/**
   319 	 * The position dilution of precision.
   320 	 * The value of this field uses data type TReal32.
   321 	 */
   322 	EPositionFieldSatellitePositionDoP,
   323 	/**
   324 	 * Altitude above the mean sea level.
   325 	 * The value of this field uses data type TReal32.
   326 	 */
   327 	EPositionFieldSatelliteSeaLevelAltitude,
   328 	/**
   329 	 * The difference between the WGS-84 earth ellipsoid and the mean sea 
   330 	 * level. A negative value indicates that the geoid is below the 
   331 	 * WGS84 ellipsoid.
   332 	 * The value of this field uses data type TReal32.
   333 	 */
   334 	EPositionFieldSatelliteGeoidalSeparation,
   335 
   336 	/**
   337      * Fields related to Media capability are part of this section.
   338 	 */
   339 	EPositionFieldMediaCapabilitiesBegin		= 800,
   340 	/**
   341 	 * Media link data field. If the client requests this field then on completion,
   342 	 * it contains the number of media links provided by the positioning module.
   343 	 * The value of this field uses data type TUint8.
   344 	 */
   345 	EPositionFieldMediaLinks,
   346 	/**
   347 	 * The first media link field relevant to this location. The rest of the links
   348 	 * follow this field.
   349 	 * The media link is of the format type/format/URI.
   350 	 * Type and Format are the standard major and minor MIME types of the
   351 	 * media. URI provides the location of the media.
   352 	 * For example, text/html/http://www.s60.com
   353 	 * The value of this field uses data type TDes8.
   354 	 */
   355 	EPositionFieldMediaLinksStart,
   356 	/**
   357 	 * The field id of the last media field. All media fields will be defined between
   358 	 * #EPositionFieldMediaLinksStart and this field.
   359 	 */
   360 	EPositionFieldMedaiLinksEnd					= 899,
   361     
   362     /** 
   363      * Other propritery fields 
   364      */
   365 	EPositionFieldProprietaryFieldsBegin		= 0x8000,
   366     /** 
   367      * the maximum field id value 
   368      */
   369 	EPositionFieldIdLast = KMaxTUint16
   370 	};
   371 
   372 #endif	//__LBSFIELDIDS_H__