epoc32/include/lbsfieldids.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
     1.1 --- a/epoc32/include/lbsfieldids.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/lbsfieldids.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,372 @@
     1.4 -lbsfieldids.h
     1.5 +/*
     1.6 +* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:
    1.19 +* Name        : LbsFieldIds.h
    1.20 +* Part of     : Location Framework/Location FW
    1.21 +* Interface   : Location Acquisition API
    1.22 +* Position data Fields
    1.23 +* Version     : %version: 4 %
    1.24 +*
    1.25 +*/
    1.26 +
    1.27 +
    1.28 +
    1.29 +#ifndef __LBSFIELDIDS_H__
    1.30 +#define __LBSFIELDIDS_H__
    1.31 +
    1.32 +#include <e32std.h>
    1.33 +
    1.34 +/* This file contains the enumerations for the different positioning
    1.35 + * related fields that a positioning technology can return.
    1.36 + */
    1.37 + 
    1.38 +/**
    1.39 + * Standard position field identifiers.
    1.40 + * It defines the enumerated values that indicates the different types of
    1.41 + * positioning related information that a positioning module can return. 
    1.42 + * Each of these fields are categorised into different capabilities.
    1.43 + * Even though the client can request for any of these fields, 
    1.44 + * the positioning module may or may not return this information based 
    1.45 + * on its capability.
    1.46 + * The data type for each field is also specified here. This data type
    1.47 + * must be used when retrieving the value for this field using
    1.48 + * HPositionGenericInfo::GetValue()
    1.49 + * @publishedAll
    1.50 + * @released
    1.51 + */
    1.52 +enum _TPositionFieldId
    1.53 +	{
    1.54 +	/**  
    1.55 +    * Reserved field ID. Used to terminate an array of requested fields. 
    1.56 +     */
    1.57 +	EPositionFieldNone,
    1.58 +	/**
    1.59 +	 * A free field that can be used for a comment.
    1.60 +     * This field can be returned by any type of positioning technology.
    1.61 +	 * The value of this field uses data type TDes16.
    1.62 +     */
    1.63 +	EPositionFieldComment,
    1.64 +    
    1.65 +    /**
    1.66 +     * Fields related to Speed capability are part of this section.
    1.67 +     */
    1.68 +	EPositionFieldSpeedCapabilitiesBegin		= 100,
    1.69 +	/**
    1.70 +	 * Horizontal speed at which the terminal is travelling. 
    1.71 +	 * The value of this field is specified in metres per second and 
    1.72 +	 * it uses data type TReal32.
    1.73 +	 */
    1.74 +	EPositionFieldHorizontalSpeed,
    1.75 +	/**
    1.76 +	 * Accuracy of the horizontal speed defined by the field 
    1.77 +	 * #EPositionFieldHorizontalSpeed.
    1.78 +	 * The value of this field is specified in metres per second and 
    1.79 +	 * it uses data type TReal32.
    1.80 +	 */
    1.81 +	EPositionFieldHorizontalSpeedError,
    1.82 +	/**
    1.83 +	 * Vertical speed at which the terminal is travelling. 
    1.84 +	 * The value of this field is specified in metres per second and 
    1.85 +	 * it uses data type TReal32.
    1.86 +	 */
    1.87 +	EPositionFieldVerticalSpeed,
    1.88 +	/**
    1.89 +	 * Accuracy of the vertical speed defined by the field 
    1.90 +	 * #EPositionFieldVerticalSpeed.
    1.91 +	 * The value of this field is specified in metres per second and 
    1.92 +	 * it uses data type TReal32.
    1.93 +	 */
    1.94 +	EPositionFieldVerticalSpeedError,
    1.95 +
    1.96 +    /**
    1.97 +     * Fields related to Direction capability are part of this section.
    1.98 +     */
    1.99 +	EPositionFieldDirectionCapabilitiesBegin	= 200,
   1.100 +	/**
   1.101 +	 * Current direction measured with respect to the true north.
   1.102 +	 * The value of this field is specified in degrees and it
   1.103 +	 * uses data type TReal32.
   1.104 +	 */
   1.105 +	EPositionFieldTrueCourse,
   1.106 +	/**
   1.107 +	 * Accuracy of the current direction defined by the field 
   1.108 +	 * #EPositionFieldTrueCourse. This field is measured with respect
   1.109 +	 * to true north.
   1.110 +	 * The value of this field is specified in degrees and it
   1.111 +	 * uses data type TReal32.
   1.112 +	 */
   1.113 +	EPositionFieldTrueCourseError,
   1.114 +	/**
   1.115 +	 * Current direction measured with respect to the magnetic north.
   1.116 +	 * The value of this field is specified in degrees and it
   1.117 +	 * uses data type TReal32.
   1.118 +	 */
   1.119 +	EPositionFieldMagneticCourse,
   1.120 +	/**
   1.121 +	 * Accuracy of the current direction defined by the field 
   1.122 +	 * #EPositionFieldMagneticCourse. This field is measured with respect 
   1.123 +	 * to magnetic north.
   1.124 +	 * The value of this field is specified in degrees and it
   1.125 +	 * uses data type TReal32.
   1.126 +	 */
   1.127 +	EPositionFieldMagneticCourseError,
   1.128 +
   1.129 +    /**
   1.130 +     * Fields related to Compass capability are part of this section.
   1.131 +     */
   1.132 +	EPositionFieldCompassCapabilitiesBegin		= 300,
   1.133 +	/**
   1.134 +	 * Current instantaneous direction of traveling measured with respect 
   1.135 +	 * to the true north.
   1.136 +	 * The value of this field is specified in degrees and it
   1.137 +	 * uses data type TReal32.
   1.138 +	 */
   1.139 +	EPositionFieldHeading, 
   1.140 +	/**
   1.141 +	 * Accuracy of current instantaneous direction of traveling defined
   1.142 +     * by the field #EPositionFieldHeading. This field is measured with
   1.143 +	 * respect to the true north.
   1.144 +	 * The value of this field is specified in degrees and it
   1.145 +	 * uses data type TReal32.
   1.146 +	 */
   1.147 +	EPositionFieldHeadingError,
   1.148 +	/**
   1.149 +	 * Current instantaneous direction of traveling measured with respect 
   1.150 +	 * to the magnetic north.
   1.151 +	 * The value of this field is specified in degrees and it
   1.152 +	 * uses data type TReal32.
   1.153 +	 */
   1.154 +	EPositionFieldMagneticHeading, 
   1.155 +	/**
   1.156 +	 * Accuracy of current instantaneous direction of traveling defined
   1.157 +     * by the field #EPositionFieldMagneticHeading. This field is measured
   1.158 +	 * with respect to the magnetic north.
   1.159 +	 * The value of this field is specified in degrees and it
   1.160 +	 * uses data type TReal32.
   1.161 +	 */
   1.162 +	EPositionFieldMagneticHeadingError,
   1.163 +
   1.164 +    /**
   1.165 +     * Fields related to Address capability are part of this section.
   1.166 +     */
   1.167 +	EPositionFieldAddressCapabilitiesBegin		= 400,
   1.168 +	/**
   1.169 +	 * Name of the country.
   1.170 +	 * The value of this field uses data type TDes16.
   1.171 +	 */
   1.172 +	EPositionFieldCountry,
   1.173 +	/**
   1.174 +	 * Country as specified by the two letter ISO 3166-1 code.
   1.175 +	 * The value of this field uses data type TDes16.
   1.176 +	 */
   1.177 +	EPositionFieldCountryCode,
   1.178 +	/**
   1.179 +	 * Name of the state within the country specfied by the field 
   1.180 +	 * #EPositionFieldCountry.
   1.181 +	 * The value of this field uses data type TDes16.
   1.182 +	 */
   1.183 +	EPositionFieldState,
   1.184 +	/**
   1.185 +	 * Name of the city within the state specfied by the field 
   1.186 +	 * #EPositionFieldState.
   1.187 +	 * The value of this field uses data type TDes16.
   1.188 +	 */
   1.189 +	EPositionFieldCity,
   1.190 +	/**
   1.191 +	 * Name of the municipal district within the city specified by the field
   1.192 +     * #EPositionFieldCity.
   1.193 +	 * The value of this field uses data type TDes16.
   1.194 +	 */
   1.195 +	EPositionFieldDistrict,
   1.196 +	/**
   1.197 +	 * Street name and building number.
   1.198 +	 * The value of this field uses data type TDes16.
   1.199 +	 */
   1.200 +	EPositionFieldStreet,
   1.201 +	/**
   1.202 +	 * Additional details about the location within a building. For example,
   1.203 +	 * flat number.
   1.204 +	 * The value of this field uses data type TDes16.
   1.205 +	 */
   1.206 +	EPositionFieldStreetExtension,
   1.207 +	/**
   1.208 +	 * Name of the company, organization or building at the address.
   1.209 +	 * The value of this field uses data type TDes16.
   1.210 +	 */
   1.211 +	EPositionFieldLocationName,
   1.212 +	/**
   1.213 +	 * Post code or Zip code of the address.
   1.214 +	 * The value of this field uses data type TDes16.
   1.215 +	 */
   1.216 +	EPositionFieldPostalCode,
   1.217 +	/**
   1.218 +	 * Name of locality. Locality denotes a small geographical area. 
   1.219 +	 * Locality is usually not a part of the official address.
   1.220 +	 * The value of this field uses data type TDes16.
   1.221 +	 */
   1.222 +	EPositionFieldLocality,
   1.223 +	/**
   1.224 +	 * Information about the cross within the street field, 
   1.225 +	 * #EPositionFieldStreet.
   1.226 +	 * The value of this field uses data type TDes16.
   1.227 +	 */
   1.228 +	EPositionFieldCrossing1,
   1.229 +	/**
   1.230 +	 * Extension for the cross field defined by #EPositionFieldCrossing1.
   1.231 +	 * The value of this field uses data type TDes16.
   1.232 +	 */
   1.233 +	EPositionFieldCrossing2,
   1.234 +	/**
   1.235 +	 * Name of the county, region or province.
   1.236 +	 * The value of this field uses data type TDes16.
   1.237 +	 */
   1.238 +	EPositionFieldCounty,
   1.239 +
   1.240 +    /**
   1.241 +     * Fields related to Building capability are part of this section.
   1.242 +     */
   1.243 +	EPositionFieldBuildingCapabilitiesBegin		= 500,
   1.244 +	/**
   1.245 +	 * Name of the building.
   1.246 +	 * The value of this field uses data type TDes16.
   1.247 +	 */
   1.248 +	EPositionFieldBuildingName,
   1.249 +	/**
   1.250 +	 * Floor or level within the building.
   1.251 +	 * The value of this field uses data type TDes16.
   1.252 +	 */
   1.253 +	EPositionFieldBuildingFloor,
   1.254 +	/**
   1.255 +	 * Room name or number within the building.
   1.256 +	 * The value of this field uses data type TDes16.
   1.257 +	 */
   1.258 +	EPositionFieldBuildingRoom,
   1.259 +	/**
   1.260 +	 * Section of a building.
   1.261 +	 * The value of this field uses data type TDes16.
   1.262 +	 */
   1.263 +	EPositionFieldBuildingZone,
   1.264 +	/**
   1.265 +	 * Telephone number associated with the building.
   1.266 +	 * The value of this field uses data type TDes16.
   1.267 +	 */
   1.268 +	EPositionFieldBuildingTelephone,
   1.269 +
   1.270 +    /**
   1.271 +     * Fields related to NMEA capability are part of this section.
   1.272 +     */
   1.273 +	EPositionFieldNMEACapabilitiesBegin			= 600,
   1.274 +	/**
   1.275 +	 * Raw NMEA data. If the client requests this field then on completion,
   1.276 +	 * it contains the number of NMEA sentences provided by the positioning
   1.277 +	 * module.
   1.278 +	 * The value of this field uses data type TUint8.
   1.279 +	 */
   1.280 +	EPositionFieldNMEASentences,
   1.281 +	/**
   1.282 +	 * The first NMEA sentence. The rest of the sentences follow this field
   1.283 +	 * The value of this field uses data type TDes8.
   1.284 +	 */
   1.285 +	EPositionFieldNMEASentencesStart,
   1.286 +
   1.287 +    /**
   1.288 +     * Fields related to Satellite capability are part of this section.
   1.289 +     */
   1.290 +	EPositionFieldSatelliteCapabilitiesBegin	= 700,
   1.291 +	/**
   1.292 +	 * The number of satellites currently in view. 
   1.293 +	 * The value of this field uses data type TInt8.
   1.294 +	 */
   1.295 +	EPositionFieldSatelliteNumInView,
   1.296 +	/**
   1.297 +	 * The number of satellites being used to provide position information.
   1.298 +	 * The value of this field uses data type TInt8.
   1.299 +	 */
   1.300 +	EPositionFieldSatelliteNumUsed,
   1.301 +	/**
   1.302 +	 * The time as obtained from satellites. 
   1.303 +	 * The value of this field uses data type TTime.
   1.304 +	 */
   1.305 +	EPositionFieldSatelliteTime,
   1.306 +	/**
   1.307 +	 * The Horizontal dilution of precision. Dilution of precision is 
   1.308 +	 * associated with the accuracy of the field.
   1.309 +	 * The value of this field uses data type TReal32.
   1.310 +	 */
   1.311 +	EPositionFieldSatelliteHorizontalDoP,
   1.312 +	/**
   1.313 +	 * The Vertical dilution of precision.
   1.314 +	 * The value of this field uses data type TReal32.
   1.315 +	 */
   1.316 +	EPositionFieldSatelliteVerticalDoP,
   1.317 +	/**
   1.318 +	 * The dilution of precision in time.
   1.319 +	 * The value of this field uses data type TReal32.
   1.320 +	 */
   1.321 +	EPositionFieldSatelliteTimeDoP,
   1.322 +	/**
   1.323 +	 * The position dilution of precision.
   1.324 +	 * The value of this field uses data type TReal32.
   1.325 +	 */
   1.326 +	EPositionFieldSatellitePositionDoP,
   1.327 +	/**
   1.328 +	 * Altitude above the mean sea level.
   1.329 +	 * The value of this field uses data type TReal32.
   1.330 +	 */
   1.331 +	EPositionFieldSatelliteSeaLevelAltitude,
   1.332 +	/**
   1.333 +	 * The difference between the WGS-84 earth ellipsoid and the mean sea 
   1.334 +	 * level. A negative value indicates that the geoid is below the 
   1.335 +	 * WGS84 ellipsoid.
   1.336 +	 * The value of this field uses data type TReal32.
   1.337 +	 */
   1.338 +	EPositionFieldSatelliteGeoidalSeparation,
   1.339 +
   1.340 +	/**
   1.341 +     * Fields related to Media capability are part of this section.
   1.342 +	 */
   1.343 +	EPositionFieldMediaCapabilitiesBegin		= 800,
   1.344 +	/**
   1.345 +	 * Media link data field. If the client requests this field then on completion,
   1.346 +	 * it contains the number of media links provided by the positioning module.
   1.347 +	 * The value of this field uses data type TUint8.
   1.348 +	 */
   1.349 +	EPositionFieldMediaLinks,
   1.350 +	/**
   1.351 +	 * The first media link field relevant to this location. The rest of the links
   1.352 +	 * follow this field.
   1.353 +	 * The media link is of the format type/format/URI.
   1.354 +	 * Type and Format are the standard major and minor MIME types of the
   1.355 +	 * media. URI provides the location of the media.
   1.356 +	 * For example, text/html/http://www.s60.com
   1.357 +	 * The value of this field uses data type TDes8.
   1.358 +	 */
   1.359 +	EPositionFieldMediaLinksStart,
   1.360 +	/**
   1.361 +	 * The field id of the last media field. All media fields will be defined between
   1.362 +	 * #EPositionFieldMediaLinksStart and this field.
   1.363 +	 */
   1.364 +	EPositionFieldMedaiLinksEnd					= 899,
   1.365 +    
   1.366 +    /** 
   1.367 +     * Other propritery fields 
   1.368 +     */
   1.369 +	EPositionFieldProprietaryFieldsBegin		= 0x8000,
   1.370 +    /** 
   1.371 +     * the maximum field id value 
   1.372 +     */
   1.373 +	EPositionFieldIdLast = KMaxTUint16
   1.374 +	};
   1.375 +
   1.376 +#endif	//__LBSFIELDIDS_H__