williamr@2: /*
williamr@2: * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@2: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: * Name        : LbsFieldIds.h
williamr@2: * Part of     : Location Framework/Location FW
williamr@2: * Interface   : Location Acquisition API
williamr@2: * Position data Fields
williamr@2: * Version     : %version: 4 %
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef __LBSFIELDIDS_H__
williamr@2: #define __LBSFIELDIDS_H__
williamr@2: 
williamr@2: #include <e32std.h>
williamr@2: 
williamr@2: /* This file contains the enumerations for the different positioning
williamr@2:  * related fields that a positioning technology can return.
williamr@2:  */
williamr@2:  
williamr@2: /**
williamr@2:  * Standard position field identifiers.
williamr@2:  * It defines the enumerated values that indicates the different types of
williamr@2:  * positioning related information that a positioning module can return. 
williamr@2:  * Each of these fields are categorised into different capabilities.
williamr@2:  * Even though the client can request for any of these fields, 
williamr@2:  * the positioning module may or may not return this information based 
williamr@2:  * on its capability.
williamr@2:  * The data type for each field is also specified here. This data type
williamr@2:  * must be used when retrieving the value for this field using
williamr@2:  * HPositionGenericInfo::GetValue()
williamr@2:  * @publishedAll
williamr@2:  * @released
williamr@2:  */
williamr@2: enum _TPositionFieldId
williamr@2: 	{
williamr@2: 	/**  
williamr@2:     * Reserved field ID. Used to terminate an array of requested fields. 
williamr@2:      */
williamr@2: 	EPositionFieldNone,
williamr@2: 	/**
williamr@2: 	 * A free field that can be used for a comment.
williamr@2:      * This field can be returned by any type of positioning technology.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2:      */
williamr@2: 	EPositionFieldComment,
williamr@2:     
williamr@2:     /**
williamr@2:      * Fields related to Speed capability are part of this section.
williamr@2:      */
williamr@2: 	EPositionFieldSpeedCapabilitiesBegin		= 100,
williamr@2: 	/**
williamr@2: 	 * Horizontal speed at which the terminal is travelling. 
williamr@2: 	 * The value of this field is specified in metres per second and 
williamr@2: 	 * it uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldHorizontalSpeed,
williamr@2: 	/**
williamr@2: 	 * Accuracy of the horizontal speed defined by the field 
williamr@2: 	 * #EPositionFieldHorizontalSpeed.
williamr@2: 	 * The value of this field is specified in metres per second and 
williamr@2: 	 * it uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldHorizontalSpeedError,
williamr@2: 	/**
williamr@2: 	 * Vertical speed at which the terminal is travelling. 
williamr@2: 	 * The value of this field is specified in metres per second and 
williamr@2: 	 * it uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldVerticalSpeed,
williamr@2: 	/**
williamr@2: 	 * Accuracy of the vertical speed defined by the field 
williamr@2: 	 * #EPositionFieldVerticalSpeed.
williamr@2: 	 * The value of this field is specified in metres per second and 
williamr@2: 	 * it uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldVerticalSpeedError,
williamr@2: 
williamr@2:     /**
williamr@2:      * Fields related to Direction capability are part of this section.
williamr@2:      */
williamr@2: 	EPositionFieldDirectionCapabilitiesBegin	= 200,
williamr@2: 	/**
williamr@2: 	 * Current direction measured with respect to the true north.
williamr@2: 	 * The value of this field is specified in degrees and it
williamr@2: 	 * uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldTrueCourse,
williamr@2: 	/**
williamr@2: 	 * Accuracy of the current direction defined by the field 
williamr@2: 	 * #EPositionFieldTrueCourse. This field is measured with respect
williamr@2: 	 * to true north.
williamr@2: 	 * The value of this field is specified in degrees and it
williamr@2: 	 * uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldTrueCourseError,
williamr@2: 	/**
williamr@2: 	 * Current direction measured with respect to the magnetic north.
williamr@2: 	 * The value of this field is specified in degrees and it
williamr@2: 	 * uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldMagneticCourse,
williamr@2: 	/**
williamr@2: 	 * Accuracy of the current direction defined by the field 
williamr@2: 	 * #EPositionFieldMagneticCourse. This field is measured with respect 
williamr@2: 	 * to magnetic north.
williamr@2: 	 * The value of this field is specified in degrees and it
williamr@2: 	 * uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldMagneticCourseError,
williamr@2: 
williamr@2:     /**
williamr@2:      * Fields related to Compass capability are part of this section.
williamr@2:      */
williamr@2: 	EPositionFieldCompassCapabilitiesBegin		= 300,
williamr@2: 	/**
williamr@2: 	 * Current instantaneous direction of traveling measured with respect 
williamr@2: 	 * to the true north.
williamr@2: 	 * The value of this field is specified in degrees and it
williamr@2: 	 * uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldHeading, 
williamr@2: 	/**
williamr@2: 	 * Accuracy of current instantaneous direction of traveling defined
williamr@2:      * by the field #EPositionFieldHeading. This field is measured with
williamr@2: 	 * respect to the true north.
williamr@2: 	 * The value of this field is specified in degrees and it
williamr@2: 	 * uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldHeadingError,
williamr@2: 	/**
williamr@2: 	 * Current instantaneous direction of traveling measured with respect 
williamr@2: 	 * to the magnetic north.
williamr@2: 	 * The value of this field is specified in degrees and it
williamr@2: 	 * uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldMagneticHeading, 
williamr@2: 	/**
williamr@2: 	 * Accuracy of current instantaneous direction of traveling defined
williamr@2:      * by the field #EPositionFieldMagneticHeading. This field is measured
williamr@2: 	 * with respect to the magnetic north.
williamr@2: 	 * The value of this field is specified in degrees and it
williamr@2: 	 * uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldMagneticHeadingError,
williamr@2: 
williamr@2:     /**
williamr@2:      * Fields related to Address capability are part of this section.
williamr@2:      */
williamr@2: 	EPositionFieldAddressCapabilitiesBegin		= 400,
williamr@2: 	/**
williamr@2: 	 * Name of the country.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldCountry,
williamr@2: 	/**
williamr@2: 	 * Country as specified by the two letter ISO 3166-1 code.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldCountryCode,
williamr@2: 	/**
williamr@2: 	 * Name of the state within the country specfied by the field 
williamr@2: 	 * #EPositionFieldCountry.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldState,
williamr@2: 	/**
williamr@2: 	 * Name of the city within the state specfied by the field 
williamr@2: 	 * #EPositionFieldState.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldCity,
williamr@2: 	/**
williamr@2: 	 * Name of the municipal district within the city specified by the field
williamr@2:      * #EPositionFieldCity.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldDistrict,
williamr@2: 	/**
williamr@2: 	 * Street name and building number.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldStreet,
williamr@2: 	/**
williamr@2: 	 * Additional details about the location within a building. For example,
williamr@2: 	 * flat number.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldStreetExtension,
williamr@2: 	/**
williamr@2: 	 * Name of the company, organization or building at the address.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldLocationName,
williamr@2: 	/**
williamr@2: 	 * Post code or Zip code of the address.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldPostalCode,
williamr@2: 	/**
williamr@2: 	 * Name of locality. Locality denotes a small geographical area. 
williamr@2: 	 * Locality is usually not a part of the official address.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldLocality,
williamr@2: 	/**
williamr@2: 	 * Information about the cross within the street field, 
williamr@2: 	 * #EPositionFieldStreet.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldCrossing1,
williamr@2: 	/**
williamr@2: 	 * Extension for the cross field defined by #EPositionFieldCrossing1.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldCrossing2,
williamr@2: 	/**
williamr@2: 	 * Name of the county, region or province.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldCounty,
williamr@2: 
williamr@2:     /**
williamr@2:      * Fields related to Building capability are part of this section.
williamr@2:      */
williamr@2: 	EPositionFieldBuildingCapabilitiesBegin		= 500,
williamr@2: 	/**
williamr@2: 	 * Name of the building.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldBuildingName,
williamr@2: 	/**
williamr@2: 	 * Floor or level within the building.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldBuildingFloor,
williamr@2: 	/**
williamr@2: 	 * Room name or number within the building.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldBuildingRoom,
williamr@2: 	/**
williamr@2: 	 * Section of a building.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldBuildingZone,
williamr@2: 	/**
williamr@2: 	 * Telephone number associated with the building.
williamr@2: 	 * The value of this field uses data type TDes16.
williamr@2: 	 */
williamr@2: 	EPositionFieldBuildingTelephone,
williamr@2: 
williamr@2:     /**
williamr@2:      * Fields related to NMEA capability are part of this section.
williamr@2:      */
williamr@2: 	EPositionFieldNMEACapabilitiesBegin			= 600,
williamr@2: 	/**
williamr@2: 	 * Raw NMEA data. If the client requests this field then on completion,
williamr@2: 	 * it contains the number of NMEA sentences provided by the positioning
williamr@2: 	 * module.
williamr@2: 	 * The value of this field uses data type TUint8.
williamr@2: 	 */
williamr@2: 	EPositionFieldNMEASentences,
williamr@2: 	/**
williamr@2: 	 * The first NMEA sentence. The rest of the sentences follow this field
williamr@2: 	 * The value of this field uses data type TDes8.
williamr@2: 	 */
williamr@2: 	EPositionFieldNMEASentencesStart,
williamr@2: 
williamr@2:     /**
williamr@2:      * Fields related to Satellite capability are part of this section.
williamr@2:      */
williamr@2: 	EPositionFieldSatelliteCapabilitiesBegin	= 700,
williamr@2: 	/**
williamr@2: 	 * The number of satellites currently in view. 
williamr@2: 	 * The value of this field uses data type TInt8.
williamr@2: 	 */
williamr@2: 	EPositionFieldSatelliteNumInView,
williamr@2: 	/**
williamr@2: 	 * The number of satellites being used to provide position information.
williamr@2: 	 * The value of this field uses data type TInt8.
williamr@2: 	 */
williamr@2: 	EPositionFieldSatelliteNumUsed,
williamr@2: 	/**
williamr@2: 	 * The time as obtained from satellites. 
williamr@2: 	 * The value of this field uses data type TTime.
williamr@2: 	 */
williamr@2: 	EPositionFieldSatelliteTime,
williamr@2: 	/**
williamr@2: 	 * The Horizontal dilution of precision. Dilution of precision is 
williamr@2: 	 * associated with the accuracy of the field.
williamr@2: 	 * The value of this field uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldSatelliteHorizontalDoP,
williamr@2: 	/**
williamr@2: 	 * The Vertical dilution of precision.
williamr@2: 	 * The value of this field uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldSatelliteVerticalDoP,
williamr@2: 	/**
williamr@2: 	 * The dilution of precision in time.
williamr@2: 	 * The value of this field uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldSatelliteTimeDoP,
williamr@2: 	/**
williamr@2: 	 * The position dilution of precision.
williamr@2: 	 * The value of this field uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldSatellitePositionDoP,
williamr@2: 	/**
williamr@2: 	 * Altitude above the mean sea level.
williamr@2: 	 * The value of this field uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldSatelliteSeaLevelAltitude,
williamr@2: 	/**
williamr@2: 	 * The difference between the WGS-84 earth ellipsoid and the mean sea 
williamr@2: 	 * level. A negative value indicates that the geoid is below the 
williamr@2: 	 * WGS84 ellipsoid.
williamr@2: 	 * The value of this field uses data type TReal32.
williamr@2: 	 */
williamr@2: 	EPositionFieldSatelliteGeoidalSeparation,
williamr@2: 
williamr@2: 	/**
williamr@2:      * Fields related to Media capability are part of this section.
williamr@2: 	 */
williamr@2: 	EPositionFieldMediaCapabilitiesBegin		= 800,
williamr@2: 	/**
williamr@2: 	 * Media link data field. If the client requests this field then on completion,
williamr@2: 	 * it contains the number of media links provided by the positioning module.
williamr@2: 	 * The value of this field uses data type TUint8.
williamr@2: 	 */
williamr@2: 	EPositionFieldMediaLinks,
williamr@2: 	/**
williamr@2: 	 * The first media link field relevant to this location. The rest of the links
williamr@2: 	 * follow this field.
williamr@2: 	 * The media link is of the format type/format/URI.
williamr@2: 	 * Type and Format are the standard major and minor MIME types of the
williamr@2: 	 * media. URI provides the location of the media.
williamr@2: 	 * For example, text/html/http://www.s60.com
williamr@2: 	 * The value of this field uses data type TDes8.
williamr@2: 	 */
williamr@2: 	EPositionFieldMediaLinksStart,
williamr@2: 	/**
williamr@2: 	 * The field id of the last media field. All media fields will be defined between
williamr@2: 	 * #EPositionFieldMediaLinksStart and this field.
williamr@2: 	 */
williamr@2: 	EPositionFieldMedaiLinksEnd					= 899,
williamr@2:     
williamr@2:     /** 
williamr@2:      * Other propritery fields 
williamr@2:      */
williamr@2: 	EPositionFieldProprietaryFieldsBegin		= 0x8000,
williamr@2:     /** 
williamr@2:      * the maximum field id value 
williamr@2:      */
williamr@2: 	EPositionFieldIdLast = KMaxTUint16
williamr@2: 	};
williamr@2: 
williamr@2: #endif	//__LBSFIELDIDS_H__