2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
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".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
15 * Name : LbsFieldIds.h
16 * Part of : Location Framework/Location FW
17 * Interface : Location Acquisition API
18 * Position data Fields
19 * Version : %version: 4 %
25 #ifndef __LBSFIELDIDS_H__
26 #define __LBSFIELDIDS_H__
30 /* This file contains the enumerations for the different positioning
31 * related fields that a positioning technology can return.
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
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()
48 enum _TPositionFieldId
51 * Reserved field ID. Used to terminate an array of requested fields.
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.
59 EPositionFieldComment,
62 * Fields related to Speed capability are part of this section.
64 EPositionFieldSpeedCapabilitiesBegin = 100,
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.
70 EPositionFieldHorizontalSpeed,
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.
77 EPositionFieldHorizontalSpeedError,
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.
83 EPositionFieldVerticalSpeed,
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.
90 EPositionFieldVerticalSpeedError,
93 * Fields related to Direction capability are part of this section.
95 EPositionFieldDirectionCapabilitiesBegin = 200,
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.
101 EPositionFieldTrueCourse,
103 * Accuracy of the current direction defined by the field
104 * #EPositionFieldTrueCourse. This field is measured with respect
106 * The value of this field is specified in degrees and it
107 * uses data type TReal32.
109 EPositionFieldTrueCourseError,
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.
115 EPositionFieldMagneticCourse,
117 * Accuracy of the current direction defined by the field
118 * #EPositionFieldMagneticCourse. This field is measured with respect
120 * The value of this field is specified in degrees and it
121 * uses data type TReal32.
123 EPositionFieldMagneticCourseError,
126 * Fields related to Compass capability are part of this section.
128 EPositionFieldCompassCapabilitiesBegin = 300,
130 * Current instantaneous direction of traveling measured with respect
132 * The value of this field is specified in degrees and it
133 * uses data type TReal32.
135 EPositionFieldHeading,
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.
143 EPositionFieldHeadingError,
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.
150 EPositionFieldMagneticHeading,
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.
158 EPositionFieldMagneticHeadingError,
161 * Fields related to Address capability are part of this section.
163 EPositionFieldAddressCapabilitiesBegin = 400,
165 * Name of the country.
166 * The value of this field uses data type TDes16.
168 EPositionFieldCountry,
170 * Country as specified by the two letter ISO 3166-1 code.
171 * The value of this field uses data type TDes16.
173 EPositionFieldCountryCode,
175 * Name of the state within the country specfied by the field
176 * #EPositionFieldCountry.
177 * The value of this field uses data type TDes16.
181 * Name of the city within the state specfied by the field
182 * #EPositionFieldState.
183 * The value of this field uses data type TDes16.
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.
191 EPositionFieldDistrict,
193 * Street name and building number.
194 * The value of this field uses data type TDes16.
196 EPositionFieldStreet,
198 * Additional details about the location within a building. For example,
200 * The value of this field uses data type TDes16.
202 EPositionFieldStreetExtension,
204 * Name of the company, organization or building at the address.
205 * The value of this field uses data type TDes16.
207 EPositionFieldLocationName,
209 * Post code or Zip code of the address.
210 * The value of this field uses data type TDes16.
212 EPositionFieldPostalCode,
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.
218 EPositionFieldLocality,
220 * Information about the cross within the street field,
221 * #EPositionFieldStreet.
222 * The value of this field uses data type TDes16.
224 EPositionFieldCrossing1,
226 * Extension for the cross field defined by #EPositionFieldCrossing1.
227 * The value of this field uses data type TDes16.
229 EPositionFieldCrossing2,
231 * Name of the county, region or province.
232 * The value of this field uses data type TDes16.
234 EPositionFieldCounty,
237 * Fields related to Building capability are part of this section.
239 EPositionFieldBuildingCapabilitiesBegin = 500,
241 * Name of the building.
242 * The value of this field uses data type TDes16.
244 EPositionFieldBuildingName,
246 * Floor or level within the building.
247 * The value of this field uses data type TDes16.
249 EPositionFieldBuildingFloor,
251 * Room name or number within the building.
252 * The value of this field uses data type TDes16.
254 EPositionFieldBuildingRoom,
256 * Section of a building.
257 * The value of this field uses data type TDes16.
259 EPositionFieldBuildingZone,
261 * Telephone number associated with the building.
262 * The value of this field uses data type TDes16.
264 EPositionFieldBuildingTelephone,
267 * Fields related to NMEA capability are part of this section.
269 EPositionFieldNMEACapabilitiesBegin = 600,
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
274 * The value of this field uses data type TUint8.
276 EPositionFieldNMEASentences,
278 * The first NMEA sentence. The rest of the sentences follow this field
279 * The value of this field uses data type TDes8.
281 EPositionFieldNMEASentencesStart,
284 * Fields related to Satellite capability are part of this section.
286 EPositionFieldSatelliteCapabilitiesBegin = 700,
288 * The number of satellites currently in view.
289 * The value of this field uses data type TInt8.
291 EPositionFieldSatelliteNumInView,
293 * The number of satellites being used to provide position information.
294 * The value of this field uses data type TInt8.
296 EPositionFieldSatelliteNumUsed,
298 * The time as obtained from satellites.
299 * The value of this field uses data type TTime.
301 EPositionFieldSatelliteTime,
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.
307 EPositionFieldSatelliteHorizontalDoP,
309 * The Vertical dilution of precision.
310 * The value of this field uses data type TReal32.
312 EPositionFieldSatelliteVerticalDoP,
314 * The dilution of precision in time.
315 * The value of this field uses data type TReal32.
317 EPositionFieldSatelliteTimeDoP,
319 * The position dilution of precision.
320 * The value of this field uses data type TReal32.
322 EPositionFieldSatellitePositionDoP,
324 * Altitude above the mean sea level.
325 * The value of this field uses data type TReal32.
327 EPositionFieldSatelliteSeaLevelAltitude,
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
332 * The value of this field uses data type TReal32.
334 EPositionFieldSatelliteGeoidalSeparation,
337 * Fields related to Media capability are part of this section.
339 EPositionFieldMediaCapabilitiesBegin = 800,
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.
345 EPositionFieldMediaLinks,
347 * The first media link field relevant to this location. The rest of the links
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.
355 EPositionFieldMediaLinksStart,
357 * The field id of the last media field. All media fields will be defined between
358 * #EPositionFieldMediaLinksStart and this field.
360 EPositionFieldMedaiLinksEnd = 899,
363 * Other propritery fields
365 EPositionFieldProprietaryFieldsBegin = 0x8000,
367 * the maximum field id value
369 EPositionFieldIdLast = KMaxTUint16
372 #endif //__LBSFIELDIDS_H__