Location

FORMAT_DEGREES

static val FORMAT_DEGREES: Int

Constant used to specify formatting of a latitude or longitude in the form "[+-]DDD.DDDDD where D indicates degrees.

Value: 0

FORMAT_MINUTES

static val FORMAT_MINUTES: Int

Constant used to specify formatting of a latitude or longitude in the form "[+-]DDD:MM.MMMMM" where D indicates degrees and M indicates minutes of arc (1 minute = 1/60th of a degree).

Value: 1

FORMAT_SECONDS

static val FORMAT_SECONDS: Int

Constant used to specify formatting of a latitude or longitude in the form "DDD:MM:SS.SSSSS" where D indicates degrees, M indicates minutes of arc, and S indicates seconds of arc (1 minute = 1/60th of a degree, 1 second = 1/3600th of a degree).

Value: 2

<init>

Location(provider: String!)

Construct a new Location with a named provider.

By default time, latitude and longitude are 0, and the location has no bearing, altitude, speed, accuracy or extras.

<init>

Location(l: Location!)

Construct a new Location object that is copied from an existing one.

bearingTo

open fun bearingTo(dest: Location!): Float

Returns the approximate initial bearing in degrees East of true North when traveling along the shortest path between this location and the given location. The shortest path is defined using the WGS84 ellipsoid. Locations that are (nearly) antipodal may produce meaningless results.

convert

open static fun convert(
    coordinate: Double, 
    outputType: Int
): String!

Converts a coordinate to a String representation. The outputType may be one of FORMAT_DEGREES, FORMAT_MINUTES, or FORMAT_SECONDS. The coordinate must be a valid double between -180.0 and 180.0. This conversion is performed in a method that is dependent on the default locale, and so is not guaranteed to round-trip with convert(java.lang.String).

convert

open static fun convert(coordinate: String!): Double

Converts a String in one of the formats described by FORMAT_DEGREES, FORMAT_MINUTES, or FORMAT_SECONDS into a double. This conversion is performed in a locale agnostic method, and so is not guaranteed to round-trip with convert(double,int).

describeContents

open fun describeContents(): Int

distanceBetween

open static fun distanceBetween(
    startLatitude: Double, 
    startLongitude: Double, 
    endLatitude: Double, 
    endLongitude: Double, 
    results: FloatArray!
): Unit

Computes the approximate distance in meters between two locations, and optionally the initial and final bearings of the shortest path between them. Distance and bearing are defined using the WGS84 ellipsoid.

The computed distance is stored in results[0]. If results has length 2 or greater, the initial bearing is stored in results[1]. If results has length 3 or greater, the final bearing is stored in results[2].

distanceTo

open fun distanceTo(dest: Location!): Float

Returns the approximate distance in meters between this location and the given location. Distance is defined using the WGS84 ellipsoid.

dump

open fun dump(
    pw: Printer!, 
    prefix: String!
): Unit

getAccuracy

open fun getAccuracy(): Float

Get the estimated horizontal accuracy of this location, radial, in meters.

We define horizontal accuracy as the radius of 68% confidence. In other words, if you draw a circle centered at this location's latitude and longitude, and with a radius equal to the accuracy, then there is a 68% probability that the true location is inside the circle.

This accuracy estimation is only concerned with horizontal accuracy, and does not indicate the accuracy of bearing, velocity or altitude if those are included in this Location.

If this location does not have a horizontal accuracy, then 0.0 is returned. All locations generated by the LocationManager include horizontal accuracy.

getAltitude

open fun getAltitude(): Double

Get the altitude if available, in meters above the WGS 84 reference ellipsoid.

If this location does not have an altitude then 0.0 is returned.

getBearing

open fun getBearing(): Float

Get the bearing, in degrees.

Bearing is the horizontal direction of travel of this device, and is not related to the device orientation. It is guaranteed to be in the range (0.0, 360.0] if the device has a bearing.

If this location does not have a bearing then 0.0 is returned.

getBearingAccuracyDegrees

open fun getBearingAccuracyDegrees(): Float

Get the estimated bearing accuracy of this location, in degrees.

We define bearing accuracy at 68% confidence. Specifically, as 1-side of the 2-sided range on each side of the estimated bearing reported by getBearing(), within which there is a 68% probability of finding the true bearing.

In the case where the underlying distribution is assumed Gaussian normal, this would be considered 1 standard deviation.

For example, if getBearing() returns 60, and getBearingAccuracyDegrees() returns 10, then there is a 68% probability of the true bearing being between 50 and 70 degrees.

If this location does not have a bearing accuracy, then 0.0 is returned.

getElapsedRealtimeNanos

open fun getElapsedRealtimeNanos(): Long

Return the time of this fix, in elapsed real-time since system boot.

This value can be reliably compared to android.os.SystemClock#elapsedRealtimeNanos, to calculate the age of a fix and to compare Location fixes. This is reliable because elapsed real-time is guaranteed monotonic for each system boot and continues to increment even when the system is in deep sleep (unlike getTime.

All locations generated by the LocationManager are guaranteed to have a valid elapsed real-time.

getElapsedRealtimeUncertaintyNanos

open fun getElapsedRealtimeUncertaintyNanos(): Double

Get estimate of the relative precision of the alignment of the ElapsedRealtimeNanos timestamp, with the reported measurements in nanoseconds (68% confidence). This means that we have 68% confidence that the true timestamp of the event is within ElapsedReatimeNanos +/- uncertainty. Example : - getElapsedRealtimeNanos() returns 10000000 - getElapsedRealtimeUncertaintyNanos() returns 1000000 (equivalent to 1millisecond) This means that the event most likely happened between 9000000 and 11000000.

getExtras

open fun getExtras(): Bundle!

Returns additional provider-specific information about the location fix as a Bundle. The keys and values are determined by the provider. If no additional information is available, null is returned.

A number of common key/value pairs are listed below. Providers that use any of the keys on this list must provide the corresponding value as described below.

• satellites - the number of satellites used to derive the fix

getLatitude

open fun getLatitude(): Double

Get the latitude, in degrees.

All locations generated by the LocationManager will have a valid latitude.

getLongitude

open fun getLongitude(): Double

Get the longitude, in degrees.

All locations generated by the LocationManager will have a valid longitude.

getProvider

open fun getProvider(): String!

Returns the name of the provider that generated this fix.

getSpeed

open fun getSpeed(): Float

Get the speed if it is available, in meters/second over ground.

If this location does not have a speed then 0.0 is returned.

getSpeedAccuracyMetersPerSecond

open fun getSpeedAccuracyMetersPerSecond(): Float

Get the estimated speed accuracy of this location, in meters per second.

We define speed accuracy at 68% confidence. Specifically, as 1-side of the 2-sided range above and below the estimated speed reported by getSpeed(), within which there is a 68% probability of finding the true speed.

In the case where the underlying distribution is assumed Gaussian normal, this would be considered 1 standard deviation.

For example, if getSpeed() returns 5, and getSpeedAccuracyMetersPerSecond() returns 1, then there is a 68% probability of the true speed being between 4 and 6 meters per second.

Note that the speed and speed accuracy is often better than would be obtained simply from differencing sequential positions, such as when the Doppler measurements from GNSS satellites are used.

If this location does not have a speed accuracy, then 0.0 is returned.

getTime

open fun getTime(): Long

Return the UTC time of this fix, in milliseconds since January 1, 1970.

Note that the UTC time on a device is not monotonic: it can jump forwards or backwards unpredictably. So always use getElapsedRealtimeNanos when calculating time deltas.

On the other hand, getTime is useful for presenting a human readable time to the user, or for carefully comparing location fixes across reboot or across devices.

All locations generated by the LocationManager are guaranteed to have a valid UTC time, however remember that the system time may have changed since the location was generated.

getVerticalAccuracyMeters

open fun getVerticalAccuracyMeters(): Float

Get the estimated vertical accuracy of this location, in meters.

We define vertical accuracy at 68% confidence. Specifically, as 1-side of the 2-sided range above and below the estimated altitude reported by getAltitude(), within which there is a 68% probability of finding the true altitude.

In the case where the underlying distribution is assumed Gaussian normal, this would be considered 1 standard deviation.

For example, if getAltitude() returns 150, and getVerticalAccuracyMeters() returns 20 then there is a 68% probability of the true altitude being between 130 and 170 meters.

If this location does not have a vertical accuracy, then 0.0 is returned.

hasAccuracy

open fun hasAccuracy(): Boolean

True if this location has a horizontal accuracy.

All locations generated by the LocationManager have an horizontal accuracy.

hasAltitude

open fun hasAltitude(): Boolean

True if this location has an altitude.

hasBearing

open fun hasBearing(): Boolean

True if this location has a bearing.

hasBearingAccuracy

open fun hasBearingAccuracy(): Boolean

True if this location has a bearing accuracy.

hasElapsedRealtimeUncertaintyNanos

open fun hasElapsedRealtimeUncertaintyNanos(): Boolean

True if this location has a elapsed realtime accuracy.

hasSpeed

open fun hasSpeed(): Boolean

True if this location has a speed.

hasSpeedAccuracy

open fun hasSpeedAccuracy(): Boolean

True if this location has a speed accuracy.

hasVerticalAccuracy

open fun hasVerticalAccuracy(): Boolean

True if this location has a vertical accuracy.

isFromMockProvider

open fun isFromMockProvider(): Boolean

Returns true if the Location came from a mock provider.

removeAccuracy

open fun removeAccuracy(): Unit

Deprecated: use a new Location object for location updates.

Remove the horizontal accuracy from this location.

Following this call hasAccuracy will return false, and getAccuracy will return 0.0.

removeAltitude

open fun removeAltitude(): Unit

Deprecated: use a new Location object for location updates.

Remove the altitude from this location.

Following this call hasAltitude will return false, and getAltitude will return 0.0.

removeBearing

open fun removeBearing(): Unit

Deprecated: use a new Location object for location updates.

Remove the bearing from this location.

Following this call hasBearing will return false, and getBearing will return 0.0.

removeSpeed

open fun removeSpeed(): Unit

Deprecated: use a new Location object for location updates.

Remove the speed from this location.

Following this call hasSpeed will return false, and getSpeed will return 0.0.

reset

open fun reset(): Unit

Clears the contents of the location.

set

open fun set(l: Location!): Unit

Sets the contents of the location to the values from the given location.

setAccuracy

open fun setAccuracy(horizontalAccuracy: Float): Unit

Set the estimated horizontal accuracy of this location, meters.

See getAccuracy for the definition of horizontal accuracy.

Following this call hasAccuracy will return true.

setAltitude

open fun setAltitude(altitude: Double): Unit

Set the altitude, in meters above the WGS 84 reference ellipsoid.

Following this call hasAltitude will return true.

setBearing

open fun setBearing(bearing: Float): Unit

Set the bearing, in degrees.

Bearing is the horizontal direction of travel of this device, and is not related to the device orientation.

The input will be wrapped into the range (0.0, 360.0].

setBearingAccuracyDegrees

open fun setBearingAccuracyDegrees(bearingAccuracyDegrees: Float): Unit

Set the estimated bearing accuracy of this location, degrees.

See getBearingAccuracyDegrees for the definition of bearing accuracy.

Following this call hasBearingAccuracy will return true.

setElapsedRealtimeNanos

open fun setElapsedRealtimeNanos(time: Long): Unit

Set the time of this fix, in elapsed real-time since system boot.

setElapsedRealtimeUncertaintyNanos

open fun setElapsedRealtimeUncertaintyNanos(time: Double): Unit

Set estimate of the relative precision of the alignment of the ElapsedRealtimeNanos timestamp, with the reported measurements in nanoseconds (68% confidence).

setExtras

open fun setExtras(extras: Bundle!): Unit

Sets the extra information associated with this fix to the given Bundle.

Note this stores a copy of the given extras, so any changes to extras after calling this method won't be reflected in the location bundle.

setLatitude

open fun setLatitude(latitude: Double): Unit

Set the latitude, in degrees.

setLongitude

open fun setLongitude(longitude: Double): Unit

Set the longitude, in degrees.

setProvider

open fun setProvider(provider: String!): Unit

Sets the name of the provider that generated this fix.

setSpeed

open fun setSpeed(speed: Float): Unit

Set the speed, in meters/second over ground.

Following this call hasSpeed will return true.

setSpeedAccuracyMetersPerSecond

open fun setSpeedAccuracyMetersPerSecond(speedAccuracyMeterPerSecond: Float): Unit

Set the estimated speed accuracy of this location, meters per second.

See getSpeedAccuracyMetersPerSecond for the definition of speed accuracy.

Following this call hasSpeedAccuracy will return true.

setTime

open fun setTime(time: Long): Unit

Set the UTC time of this fix, in milliseconds since January 1, 1970.

setVerticalAccuracyMeters

open fun setVerticalAccuracyMeters(verticalAccuracyMeters: Float): Unit

Set the estimated vertical accuracy of this location, meters.

See getVerticalAccuracyMeters for the definition of vertical accuracy.

Following this call hasVerticalAccuracy will return true.

toString

open fun toString(): String

writeToParcel

open fun writeToParcel(
    parcel: Parcel!, 
    flags: Int
): Unit

CREATOR

static val CREATOR: Parcelable.Creator<Location!>