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

Location

Location(provider: String?)

Constructs a new location with a named provider. By default all values are zero, and no optional values are present.

Location

Location(location: Location)

Constructs a new location copied from the given location.

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 latitude/longitude coordinate to a String representation. The outputType must be one of FORMAT_DEGREES, FORMAT_MINUTES, or FORMAT_SECONDS. The coordinate must be a number between -180.0 and 180.0, inclusive. 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

Deprecated: Prefer to use toString() along with whatever custom formatting is required instead of this method. It is not this class's job to manage print representations.

Dumps location information to the given Printer.

equals

open fun equals(other: Any?): Boolean

Location equality is provided primarily for test purposes. Comparing locations for equality in production may indicate incorrect assumptions, and should be avoided whenever possible.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getAccuracy

open fun getAccuracy(): Float

Returns the estimated horizontal accuracy radius in meters of this location at the 68th percentile confidence level. This means that there is a 68% chance that the true location of the device is within a distance of this uncertainty of the reported location. Another way of putting this is that if a circle with a radius equal to this accuracy is drawn around the reported location, there is a 68% chance that the true location falls within this circle. This accuracy value is only valid for horizontal positioning, and not vertical positioning.

This is only valid if hasAccuracy() is true. All locations generated by the LocationManager include horizontal accuracy.

getAltitude

open fun getAltitude(): Double

The altitude of this location in meters above the WGS84 reference ellipsoid.

This is only valid if hasAltitude() is true.

getBearing

open fun getBearing(): Float

Returns the bearing at the time of this location in degrees. Bearing is the horizontal direction of travel of this device and is unrelated to the device orientation. The bearing is guaranteed to be in the range [0, 360).

This is only valid if hasBearing() is true.

getBearingAccuracyDegrees

open fun getBearingAccuracyDegrees(): Float

Returns the estimated bearing accuracy in degrees of this location at the 68th percentile confidence level. This means that there is 68% chance that the true bearing at the time of this location falls within getBearing() ()} +/- this uncertainty.

This is only valid if hasBearingAccuracy() ()} is true.

getElapsedRealtimeAgeMillis

open fun getElapsedRealtimeAgeMillis(): Long

A convenience methods that returns the age of this location in milliseconds with respect to the current elapsed realtime.

getElapsedRealtimeAgeMillis

open fun getElapsedRealtimeAgeMillis(referenceRealtimeMs: Long): Long

A convenience method that returns the age of this location with respect to the given reference elapsed realtime.

getElapsedRealtimeMillis

open fun getElapsedRealtimeMillis(): Long

Return the time of this fix in milliseconds of elapsed realtime since system boot.

getElapsedRealtimeNanos

open fun getElapsedRealtimeNanos(): Long

Return the time of this fix in nanoseconds of elapsed realtime since system boot.

This value can be compared with android.os.SystemClock#elapsedRealtimeNanos to reliably order or compare locations. This is reliable because elapsed realtime is guaranteed to be monotonic and continues to increment even when the system is in deep sleep (unlike getTime). However, since elapsed realtime is with reference to system boot, it does not make sense to use this value to order or compare locations across boot cycles or devices.

All locations generated by the LocationManager are guaranteed to have a valid elapsed realtime set.

getElapsedRealtimeUncertaintyNanos

open fun getElapsedRealtimeUncertaintyNanos(): Double

Get the uncertainty in nanoseconds of the precision of getElapsedRealtimeNanos() at the 68th percentile confidence level. This means that there is 68% chance that the true elapsed realtime of this location is within getElapsedRealtimeNanos() +/- this uncertainty.

This is only valid if hasElapsedRealtimeUncertaintyNanos() is true.

getExtras

open fun getExtras(): Bundle?

Returns an optional bundle of additional information associated with this location. The keys and values within the bundle are determined by the location provider.

Common key/value pairs are listed below. There is no guarantee that these key/value pairs will be present for any location.

• satellites - the number of satellites used to derive a GNSS fix. This key was deprecated in API 34 because the information can be obtained through more accurate means, such as by referencing GnssStatus#usedInFix.

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.

getMslAltitudeAccuracyMeters

open fun getMslAltitudeAccuracyMeters(): Float

Returns the estimated Mean Sea Level altitude accuracy in meters of this location at the 68th percentile confidence level. This means that there is 68% chance that the true Mean Sea Level altitude of this location falls within getMslAltitudeMeters() +/- this uncertainty.

This is only valid if hasMslAltitudeAccuracy() is true.

getMslAltitudeMeters

open fun getMslAltitudeMeters(): Double

Returns the Mean Sea Level altitude of this location in meters.

This is only valid if hasMslAltitude() is true.

getProvider

open fun getProvider(): String?

Returns the name of the provider associated with this location.

getSpeed

open fun getSpeed(): Float

Returns the speed at the time of this location in meters per second. Note that the speed returned here may be more accurate than would be obtained simply by calculating distance / time for sequential positions, such as if the Doppler measurements from GNSS satellites are taken into account.

This is only valid if hasSpeed() is true.

getSpeedAccuracyMetersPerSecond

open fun getSpeedAccuracyMetersPerSecond(): Float

Returns the estimated speed accuracy in meters per second of this location at the 68th percentile confidence level. This means that there is 68% chance that the true speed at the time of this location falls within getSpeed() ()} +/- this uncertainty.

This is only valid if hasSpeedAccuracy() is true.

getTime

open fun getTime(): Long

Returns the Unix epoch time of this location fix, in milliseconds since the start of the Unix epoch (00:00:00 January 1, 1970 UTC).

There is no guarantee that different locations have times set from the same clock. Locations derived from the LocationManager#GPS_PROVIDER are guaranteed to have their time originate from the clock in use by the satellite constellation that provided the fix. Locations derived from other providers may use any clock to set their time, though it is most common to use the device's Unix epoch time system clock (which may be incorrect).

Note that the device's Unix epoch time system clock is not monotonic; it can jump forwards or backwards unpredictably and may be changed at any time by the user, so this time should not be used to order or compare locations. Prefer getElapsedRealtimeNanos for that purpose, as the elapsed realtime clock is guaranteed to be monotonic.

On the other hand, this method may be useful for presenting a human-readable time to the user, or as a heuristic for comparing location fixes across reboot or across devices.

All locations generated by the LocationManager are guaranteed to have this time set, however remember that the device's system clock may have changed since the location was generated.

getVerticalAccuracyMeters

open fun getVerticalAccuracyMeters(): Float

Returns the estimated altitude accuracy in meters of this location at the 68th percentile confidence level. This means that there is 68% chance that the true altitude of this location falls within getAltitude() ()} +/- this uncertainty.

This is only valid if hasVerticalAccuracy() is true.

hasAccuracy

open fun hasAccuracy(): Boolean

Returns true if this location has a horizontal accuracy, false otherwise.

hasAltitude

open fun hasAltitude(): Boolean

Returns true if this location has an altitude, false otherwise.

hasBearing

open fun hasBearing(): Boolean

True if this location has a bearing, false otherwise.

hasBearingAccuracy

open fun hasBearingAccuracy(): Boolean

Returns true if this location has a bearing accuracy, false otherwise.

hasElapsedRealtimeUncertaintyNanos

open fun hasElapsedRealtimeUncertaintyNanos(): Boolean

True if this location has an elapsed realtime uncertainty, false otherwise.

hasMslAltitude

open fun hasMslAltitude(): Boolean

Returns true if this location has a Mean Sea Level altitude, false otherwise.

hasMslAltitudeAccuracy

open fun hasMslAltitudeAccuracy(): Boolean

Returns true if this location has a Mean Sea Level altitude accuracy, false otherwise.

hasSpeed

open fun hasSpeed(): Boolean

True if this location has a speed, false otherwise.

hasSpeedAccuracy

open fun hasSpeedAccuracy(): Boolean

Returns true if this location has a speed accuracy, false otherwise.

hasVerticalAccuracy

open fun hasVerticalAccuracy(): Boolean

Returns true if this location has a vertical accuracy, false otherwise.

hashCode

open fun hashCode(): Int

isComplete

open fun isComplete(): Boolean

Return true if this location is considered complete. A location is considered complete if it has a non-null provider, accuracy, and non-zero time and elapsed realtime. The exact definition of completeness may change over time.

All locations supplied by the LocationManager are guaranteed to be complete.

isFromMockProvider

open fun isFromMockProvider(): Boolean

Deprecated: Prefer isMock() instead.

Returns true if this is a mock location. If this location comes from the Android framework, this indicates that the location was provided by a test location provider, and thus may not be related to the actual location of the device.

isMock

open fun isMock(): Boolean

Returns true if this location is marked as a mock location. If this location comes from the Android framework, this indicates that the location was provided by a test location provider, and thus may not be related to the actual location of the device.

removeAccuracy

open fun removeAccuracy(): Unit

Remove the horizontal accuracy from this location.

removeAltitude

open fun removeAltitude(): Unit

Removes the altitude from this location.

removeBearing

open fun removeBearing(): Unit

Remove the bearing from this location.

removeBearingAccuracy

open fun removeBearingAccuracy(): Unit

Remove the bearing accuracy from this location.

removeElapsedRealtimeUncertaintyNanos

open fun removeElapsedRealtimeUncertaintyNanos(): Unit

Removes the elapsed realtime uncertainty from this location.

removeMslAltitude

open fun removeMslAltitude(): Unit

Removes the Mean Sea Level altitude from this location.

removeMslAltitudeAccuracy

open fun removeMslAltitudeAccuracy(): Unit

Removes the Mean Sea Level altitude accuracy from this location.

removeSpeed

open fun removeSpeed(): Unit

Remove the speed from this location.

removeSpeedAccuracy

open fun removeSpeedAccuracy(): Unit

Remove the speed accuracy from this location.

removeVerticalAccuracy

open fun removeVerticalAccuracy(): Unit

Remove the vertical accuracy from this location.

reset

open fun reset(): Unit

Sets the provider to null, removes all optional fields, and sets the values of all other fields to zero.

set

open fun set(location: Location): Unit

Turns this location into a copy of the given location.

setAccuracy

open fun setAccuracy(horizontalAccuracyMeters: Float): Unit

Set the horizontal accuracy in meters of this location.

setAltitude

open fun setAltitude(altitudeMeters: Double): Unit

Set the altitude of this location in meters above the WGS84 reference ellipsoid.

setBearing

open fun setBearing(bearingDegrees: Float): Unit

Set the bearing at the time of this location, in degrees. The given bearing will be converted into the range [0, 360).

Note: passing in extremely high or low floating point values to this function may produce strange results due to the intricacies of floating point math.

setBearingAccuracyDegrees

open fun setBearingAccuracyDegrees(bearingAccuracyDegrees: Float): Unit

Set the bearing accuracy in degrees of this location.

setElapsedRealtimeNanos

open fun setElapsedRealtimeNanos(elapsedRealtimeNs: Long): Unit

Set the time of this location in nanoseconds of elapsed realtime since system boot.

setElapsedRealtimeUncertaintyNanos

open fun setElapsedRealtimeUncertaintyNanos(elapsedRealtimeUncertaintyNs: Double): Unit

Sets the uncertainty in nanoseconds of the precision of the elapsed realtime timestamp at a 68% confidence level.

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(latitudeDegrees: Double): Unit

Set the latitude of this location.

setLongitude

open fun setLongitude(longitudeDegrees: Double): Unit

Set the longitude of this location.

setMock

open fun setMock(mock: Boolean): Unit

Sets whether this location is marked as a mock location.

setMslAltitudeAccuracyMeters

open fun setMslAltitudeAccuracyMeters(mslAltitudeAccuracyMeters: Float): Unit

Sets the Mean Sea Level altitude accuracy of this location in meters.

setMslAltitudeMeters

open fun setMslAltitudeMeters(mslAltitudeMeters: Double): Unit

Sets the Mean Sea Level altitude of this location in meters.

setProvider

open fun setProvider(provider: String?): Unit

Sets the name of the provider associated with this location

setSpeed

open fun setSpeed(speedMetersPerSecond: Float): Unit

Set the speed at the time of this location, in meters per second.

setSpeedAccuracyMetersPerSecond

open fun setSpeedAccuracyMetersPerSecond(speedAccuracyMeterPerSecond: Float): Unit

Set the speed accuracy of this location in meters per second.

setTime

open fun setTime(timeMs: Long): Unit

Sets the Unix epoch time of this location fix, in milliseconds since the start of the Unix epoch (00:00:00 January 1 1970 UTC).

setVerticalAccuracyMeters

open fun setVerticalAccuracyMeters(altitudeAccuracyMeters: Float): Unit

Set the altitude accuracy of this location in meters.

toString

open fun toString(): String

Returns a string representation of the object.

writeToParcel

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

Flatten this object in to a Parcel.

CREATOR

static val CREATOR: Parcelable.Creator<Location!>