Returned location information

The ReturnValue property returned by a synchronous GetLocation call and by callback for an asynchronous GetLocation or Trace call is an object containing the requested device location information. Each property in the object corresponds to one kind of location information.

The exact set of properties included in the ReturnValue object depends on the criteria defined for the GetLocation or Trace call and on the capabilities of the positioning system that provides the location information for the mobile device. If a particular piece of location information cannot be retrieved by the positioning system, the property for that information is not included in the ReturnValue object. For example, if basic location information is requested, the ReturnValue object only contains properties for longitude, latitude, and altitude; no other location information is returned. Similarly, if the positioning system used by the S60 device cannot provide satellite information, the SatelliteNumView and SatelliteNumViewUsed properties are not included in ReturnValue.

The WGS 84 datum is used to reference coordinates. The representation is in decimal degrees.

The following table describes the location information returned by a GetLocation or Trace call.

Table: ReturnValue properties for location information

Property

Description

Value type

Location information type

Longitude

Longitude estimate in degrees. The value range is [+180, -180].

number

Basic or Generic

Latitude

Latitude estimate in degrees. The value range is [+90, -90].

number

Basic or Generic

Altitude

Elevation estimate in meters relative to the WGS 84 datum.

number

Basic or Generic

SatelliteNumView

Number of satellites currently in view.

number

Generic

SatelliteNumViewUsed

Number of satellites used to obtain the location fix.

number

Generic

HorizontalSpeed

Horizontal speed estimate in meters per second. This is the speed of the device at the time the location fix was obtained.

number

Generic

HorizontalSpeedError

Horizontal speed error in meters per second.

number

Generic

TrueCourse

Current direction of movement in degrees in relation to true north.

number

Generic

TrueCourseError

TrueCourse error in degrees.

number

Generic

MagneticHeading

Current direction of movement in degrees in relation to magnetic north.

number

Generic

MagneticHeadingError

MagneticHeading error in degrees.

number

Generic

Heading

Current instantaneous direction of movement in degrees in relation to true north.

number

Generic

HeadingError

Heading error in degrees.

number

Generic

MagneticCourse

Current instantaneous direction of movement in degrees in relation to magnetic north.

number

Generic

MagneticCourseError

MagneticCourse error in degrees.

number

Generic