lbsfieldids.h File Reference

API published in: S60 2nd Ed FP 2

Link against: lbs.lib

Capability Information

Required Capabilities

None

Exceptions

The capability Location is required in:

TInt RPositionServer::GetDefaultModuleId(TPositionModuleId& aModuleId) const;

TInt RPositionServer::GetNumModules(TUint& aNumModules) const;

TInt RPositionServer::GetModuleInfoByIndex(TInt aModuleIndex, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleInfoById(TPositionModuleId aModuleId, TPositionModuleInfoBase& aModuleInfo) const;

TInt RPositionServer::GetModuleStatus(TPositionModuleStatusBase& aPosModuleStatus, TPositionModuleId aModuleId) const;

void RPositionServer::NotifyModuleStatusEvent(TPositionModuleStatusEventBase& aStatusEvent,TRequestStatus& aStatus,const TPositionModuleId aModuleId = KPositionNullModuleId) const;

TInt RPositioner::SetRequestor(CRequestor::TRequestorType aType,CRequestor::TRequestorFormat aFormat,const TDesC& aData);

TInt RPositioner::SetRequestor(const RRequestorStack& aRequestorStack);

TInt RPositioner::SetUpdateOptions(const TPositionUpdateOptionsBase& aPosOption);

TInt RPositioner::GetUpdateOptions(TPositionUpdateOptionsBase& aPosOption) const;

void RPositioner::GetLastKnownPosition(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;

void RPositioner::NotifyPositionUpdate(TPositionInfoBase& aPosInfo,TRequestStatus& aStatus) const;


#include <e32std.h>

Go to the source code of this file.


Enumerations

enum   _TPositionFieldId {
  EPositionFieldNone, EPositionFieldComment, EPositionFieldSpeedCapabilitiesBegin = 100, EPositionFieldHorizontalSpeed,
  EPositionFieldHorizontalSpeedError, EPositionFieldVerticalSpeed, EPositionFieldVerticalSpeedError, EPositionFieldDirectionCapabilitiesBegin = 200,
  EPositionFieldTrueCourse, EPositionFieldTrueCourseError, EPositionFieldMagneticCourse, EPositionFieldMagneticCourseError,
  EPositionFieldCompassCapabilitiesBegin = 300, EPositionFieldHeading, EPositionFieldHeadingError, EPositionFieldMagneticHeading,
  EPositionFieldMagneticHeadingError, EPositionFieldAddressCapabilitiesBegin = 400, EPositionFieldCountry, EPositionFieldCountryCode,
  EPositionFieldState, EPositionFieldCity, EPositionFieldDistrict, EPositionFieldStreet,
  EPositionFieldStreetExtension, EPositionFieldLocationName, EPositionFieldPostalCode, EPositionFieldLocality,
  EPositionFieldCrossing1, EPositionFieldCrossing2, EPositionFieldCounty, EPositionFieldBuildingCapabilitiesBegin = 500,
  EPositionFieldBuildingName, EPositionFieldBuildingFloor, EPositionFieldBuildingRoom, EPositionFieldBuildingZone,
  EPositionFieldBuildingTelephone, EPositionFieldNMEACapabilitiesBegin = 600, EPositionFieldNMEASentences, EPositionFieldNMEASentencesStart,
  EPositionFieldSatelliteCapabilitiesBegin = 700, EPositionFieldSatelliteNumInView, EPositionFieldSatelliteNumUsed, EPositionFieldSatelliteTime,
  EPositionFieldSatelliteHorizontalDoP, EPositionFieldSatelliteVerticalDoP, EPositionFieldSatelliteTimeDoP, EPositionFieldSatellitePositionDoP,
  EPositionFieldSatelliteSeaLevelAltitude, EPositionFieldSatelliteGeoidalSeparation, EPositionFieldMediaCapabilitiesBegin = 800, EPositionFieldMediaLinks,
  EPositionFieldMediaLinksStart, EPositionFieldMedaiLinksEnd = 899, EPositionFieldProprietaryFieldsBegin = 0x8000, EPositionFieldIdLast = KMaxTUint16
}
  Standard position field identifiers. More...

Enumeration Type Documentation

enum _TPositionFieldId
 

Standard position field identifiers.

It defines the enumerated values that indicates the different types of positioning related information that a positioning module can return. Each of these fields are categorised into different capabilities.

Note:
Even though the client can request for any of these fields, the positioning module may or may not return this information based on its capability.

The data type for each field is also specified here. This data type must be used when retrieving the value for this field using HPositionGenericInfo::GetValue()

Enumerator:
EPositionFieldNone  Reserved field ID.

Used to terminate an array of requested fields.

EPositionFieldComment  A free field that can be used for a comment.

This field can be returned by any type of positioning technology. The value of this field uses data type TDes16.

EPositionFieldSpeedCapabilitiesBegin  Fields related to Speed capability are part of this section.
EPositionFieldHorizontalSpeed  Horizontal speed at which the terminal is travelling.

The value of this field is specified in metres per second and it uses data type TReal32.

EPositionFieldHorizontalSpeedError  Accuracy of the horizontal speed defined by the field EPositionFieldHorizontalSpeed.

The value of this field is specified in metres per second and it uses data type TReal32.

EPositionFieldVerticalSpeed  Vertical speed at which the terminal is travelling.

The value of this field is specified in metres per second and it uses data type TReal32.

EPositionFieldVerticalSpeedError  Accuracy of the vertical speed defined by the field EPositionFieldVerticalSpeed.

The value of this field is specified in metres per second and it uses data type TReal32.

EPositionFieldDirectionCapabilitiesBegin  Fields related to Direction capability are part of this section.
EPositionFieldTrueCourse  Current direction measured with respect to the true north.

The value of this field is specified in degrees and it uses data type TReal32.

EPositionFieldTrueCourseError  Accuracy of the current direction defined by the field EPositionFieldTrueCourse.

This field is measured with respect to true north. The value of this field is specified in degrees and it uses data type TReal32.

EPositionFieldMagneticCourse  Current direction measured with respect to the magnetic north.

The value of this field is specified in degrees and it uses data type TReal32.

EPositionFieldMagneticCourseError  Accuracy of the current direction defined by the field EPositionFieldMagneticCourse.

This field is measured with respect to magnetic north. The value of this field is specified in degrees and it uses data type TReal32.

EPositionFieldCompassCapabilitiesBegin  Fields related to Compass capability are part of this section.
EPositionFieldHeading  Current instantaneous direction of traveling measured with respect to the true north.

The value of this field is specified in degrees and it uses data type TReal32.

EPositionFieldHeadingError  Accuracy of current instantaneous direction of traveling defined by the field EPositionFieldHeading.

This field is measured with respect to the true north. The value of this field is specified in degrees and it uses data type TReal32.

EPositionFieldMagneticHeading  Current instantaneous direction of traveling measured with respect to the magnetic north.

The value of this field is specified in degrees and it uses data type TReal32.

EPositionFieldMagneticHeadingError  Accuracy of current instantaneous direction of traveling defined by the field EPositionFieldMagneticHeading.

This field is measured with respect to the magnetic north. The value of this field is specified in degrees and it uses data type TReal32.

EPositionFieldAddressCapabilitiesBegin  Fields related to Address capability are part of this section.
EPositionFieldCountry  Name of the country.

The value of this field uses data type TDes16.

EPositionFieldCountryCode  Country as specified by the two letter ISO 3166-1 code.

The value of this field uses data type TDes16.

EPositionFieldState  Name of the state within the country specfied by the field EPositionFieldCountry.

The value of this field uses data type TDes16.

EPositionFieldCity  Name of the city within the state specfied by the field EPositionFieldState.

The value of this field uses data type TDes16.

EPositionFieldDistrict  Name of the municipal district within the city specified by the field EPositionFieldCity.

The value of this field uses data type TDes16.

EPositionFieldStreet  Street name and building number.

The value of this field uses data type TDes16.

EPositionFieldStreetExtension  Additional details about the location within a building.

For example, flat number. The value of this field uses data type TDes16.

EPositionFieldLocationName  Name of the company, organization or building at the address.

The value of this field uses data type TDes16.

EPositionFieldPostalCode  Post code or Zip code of the address.

The value of this field uses data type TDes16.

EPositionFieldLocality  Name of locality.

Locality denotes a small geographical area. Locality is usually not a part of the official address. The value of this field uses data type TDes16.

EPositionFieldCrossing1  Information about the cross within the street field, EPositionFieldStreet.

The value of this field uses data type TDes16.

EPositionFieldCrossing2  Extension for the cross field defined by EPositionFieldCrossing1.

The value of this field uses data type TDes16.

EPositionFieldCounty  Name of the county, region or province.

The value of this field uses data type TDes16.

EPositionFieldBuildingCapabilitiesBegin  Fields related to Building capability are part of this section.
EPositionFieldBuildingName  Name of the building.

The value of this field uses data type TDes16.

EPositionFieldBuildingFloor  Floor or level within the building.

The value of this field uses data type TDes16.

EPositionFieldBuildingRoom  Room name or number within the building.

The value of this field uses data type TDes16.

EPositionFieldBuildingZone  Section of a building.

The value of this field uses data type TDes16.

EPositionFieldBuildingTelephone  Telephone number associated with the building.

The value of this field uses data type TDes16.

EPositionFieldNMEACapabilitiesBegin  Fields related to NMEA capability are part of this section.
EPositionFieldNMEASentences  Raw NMEA data.

If the client requests this field then on completion, it contains the number of NMEA sentences provided by the positioning module. The value of this field uses data type TUint8.

EPositionFieldNMEASentencesStart  The first NMEA sentence.

The rest of the sentences follow this field The value of this field uses data type TDes8.

EPositionFieldSatelliteCapabilitiesBegin  Fields related to Satellite capability are part of this section.
EPositionFieldSatelliteNumInView  The number of satellites currently in view.

The value of this field uses data type TInt8.

EPositionFieldSatelliteNumUsed  The number of satellites being used to provide position information.

The value of this field uses data type TInt8.

EPositionFieldSatelliteTime  The time as obtained from satellites.

The value of this field uses data type TTime.

EPositionFieldSatelliteHorizontalDoP  The Horizontal dilution of precision.

Dilution of precision is associated with the accuracy of the field. The value of this field uses data type TReal32.

EPositionFieldSatelliteVerticalDoP  The Vertical dilution of precision.

The value of this field uses data type TReal32.

EPositionFieldSatelliteTimeDoP  The dilution of precision in time.

The value of this field uses data type TReal32.

EPositionFieldSatellitePositionDoP  The position dilution of precision.

The value of this field uses data type TReal32.

EPositionFieldSatelliteSeaLevelAltitude  Altitude above the mean sea level.

The value of this field uses data type TReal32.

EPositionFieldSatelliteGeoidalSeparation  The difference between the WGS-84 earth ellipsoid and the mean sea level.

A negative value indicates that the geoid is below the WGS84 ellipsoid. The value of this field uses data type TReal32.

EPositionFieldMediaCapabilitiesBegin  Fields related to Media capability are part of this section.
EPositionFieldMediaLinks  Media link data field.

If the client requests this field then on completion, it contains the number of media links provided by the positioning module. The value of this field uses data type TUint8.

EPositionFieldMediaLinksStart  The first media link field relevant to this location.

The rest of the links follow this field. The media link is of the format type/format/URI. Type and Format are the standard major and minor MIME types of the media. URI provides the location of the media. For example, text/html/http://www.s60.com The value of this field uses data type TDes8.

EPositionFieldMedaiLinksEnd  The field id of the last media field.

All media fields will be defined between EPositionFieldMediaLinksStart and this field.

EPositionFieldProprietaryFieldsBegin  Other propritery fields.
EPositionFieldIdLast  the maximum field id value

Copyright © Nokia Corporation 2001-2008
Back to top