Location

Kotlin |Java

open class Location : Parcelable

kotlin.Any
↳	android.location.Location

A data class representing a geographic location.

A location can consist of a latitude, longitude, timestamp, and other information such as bearing, altitude and velocity.

All locations generated by the LocationManager are guaranteed to have a valid latitude, longitude, and timestamp (both UTC time and elapsed real-time since boot), all other parameters are optional.

Summary

Constants
static Int	`FORMAT_DEGREES` Constant used to specify formatting of a latitude or longitude in the form "[+-]DDD.
static Int	`FORMAT_MINUTES` Constant used to specify formatting of a latitude or longitude in the form "[+-]DDD:MM.
static Int	`FORMAT_SECONDS` Constant used to specify formatting of a latitude or longitude in the form "DDD:MM:SS.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`<init>(provider: String!)` Construct a new Location with a named provider.
`<init>(l: Location!)` Construct a new Location object that is copied from an existing one.

Public methods
open Float	`bearingTo(dest: Location!)` Returns the approximate initial bearing in degrees East of true North when traveling along the shortest path between this location and the given location.
open static String!	`convert(coordinate: Double, outputType: Int)` Converts a coordinate to a String representation.
open static Double	`convert(coordinate: String!)` Converts a String in one of the formats described by FORMAT_DEGREES, FORMAT_MINUTES, or FORMAT_SECONDS into a double.
open Int	`describeContents()`
open static Unit	`distanceBetween(startLatitude: Double, startLongitude: Double, endLatitude: Double, endLongitude: Double, results: FloatArray!)` Computes the approximate distance in meters between two locations, and optionally the initial and final bearings of the shortest path between them.
open Float	`distanceTo(dest: Location!)` Returns the approximate distance in meters between this location and the given location.
open Unit	`dump(pw: Printer!, prefix: String!)`
open Float	`getAccuracy()` Get the estimated horizontal accuracy of this location, radial, in meters.
open Double	`getAltitude()` Get the altitude if available, in meters above the WGS 84 reference ellipsoid.
open Float	`getBearing()` Get the bearing, in degrees.
open Float	`getBearingAccuracyDegrees()` Get the estimated bearing accuracy of this location, in degrees.
open Long	`getElapsedRealtimeNanos()` Return the time of this fix, in elapsed real-time since system boot.
open Double	`getElapsedRealtimeUncertaintyNanos()` Get estimate of the relative precision of the alignment of the ElapsedRealtimeNanos timestamp, with the reported measurements in nanoseconds (68% confidence).
open Bundle!	`getExtras()` Returns additional provider-specific information about the location fix as a Bundle.
open Double	`getLatitude()` Get the latitude, in degrees.
open Double	`getLongitude()` Get the longitude, in degrees.
open String!	`getProvider()` Returns the name of the provider that generated this fix.
open Float	`getSpeed()` Get the speed if it is available, in meters/second over ground.
open Float	`getSpeedAccuracyMetersPerSecond()` Get the estimated speed accuracy of this location, in meters per second.
open Long	`getTime()` Return the UTC time of this fix, in milliseconds since January 1, 1970.
open Float	`getVerticalAccuracyMeters()` Get the estimated vertical accuracy of this location, in meters.
open Boolean	`hasAccuracy()` True if this location has a horizontal accuracy.
open Boolean	`hasAltitude()` True if this location has an altitude.
open Boolean	`hasBearing()` True if this location has a bearing.
open Boolean	`hasBearingAccuracy()` True if this location has a bearing accuracy.
open Boolean	`hasElapsedRealtimeUncertaintyNanos()` True if this location has a elapsed realtime accuracy.
open Boolean	`hasSpeed()` True if this location has a speed.
open Boolean	`hasSpeedAccuracy()` True if this location has a speed accuracy.
open Boolean	`hasVerticalAccuracy()` True if this location has a vertical accuracy.
open Boolean	`isFromMockProvider()` Returns true if the Location came from a mock provider.
open Unit	`removeAccuracy()` Remove the horizontal accuracy from this location.
open Unit	`removeAltitude()` Remove the altitude from this location.
open Unit	`removeBearing()` Remove the bearing from this location.
open Unit	`removeSpeed()` Remove the speed from this location.
open Unit	`reset()` Clears the contents of the location.
open Unit	`set(l: Location!)` Sets the contents of the location to the values from the given location.
open Unit	`setAccuracy(horizontalAccuracy: Float)` Set the estimated horizontal accuracy of this location, meters.
open Unit	`setAltitude(altitude: Double)` Set the altitude, in meters above the WGS 84 reference ellipsoid.
open Unit	`setBearing(bearing: Float)` Set the bearing, in degrees.
open Unit	`setBearingAccuracyDegrees(bearingAccuracyDegrees: Float)` Set the estimated bearing accuracy of this location, degrees.
open Unit	`setElapsedRealtimeNanos(time: Long)` Set the time of this fix, in elapsed real-time since system boot.
open Unit	`setElapsedRealtimeUncertaintyNanos(time: Double)` Set estimate of the relative precision of the alignment of the ElapsedRealtimeNanos timestamp, with the reported measurements in nanoseconds (68% confidence).
open Unit	`setExtras(extras: Bundle!)` Sets the extra information associated with this fix to the given Bundle.
open Unit	`setLatitude(latitude: Double)` Set the latitude, in degrees.
open Unit	`setLongitude(longitude: Double)` Set the longitude, in degrees.
open Unit	`setProvider(provider: String!)` Sets the name of the provider that generated this fix.
open Unit	`setSpeed(speed: Float)` Set the speed, in meters/second over ground.
open Unit	`setSpeedAccuracyMetersPerSecond(speedAccuracyMeterPerSecond: Float)` Set the estimated speed accuracy of this location, meters per second.
open Unit	`setTime(time: Long)` Set the UTC time of this fix, in milliseconds since January 1, 1970.
open Unit	`setVerticalAccuracyMeters(verticalAccuracyMeters: Float)` Set the estimated vertical accuracy of this location, meters.
open String	`toString()`
open Unit	`writeToParcel(parcel: Parcel!, flags: Int)`

Properties
static Parcelable.Creator<Location!>	`CREATOR`

Exceptions
`java.lang.NullPointerException`	if coordinate is null
`java.lang.IllegalArgumentException`	if the coordinate is not in one of the valid formats.

Parameters
`startLatitude`	Double: the starting latitude
`startLongitude`	Double: the starting longitude
`endLatitude`	Double: the ending latitude
`endLongitude`	Double: the ending longitude
`results`	FloatArray!: an array of floats to hold the results

Parameters
`dest`	The Parcel in which the object should be written.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Location

Summary

Constants

FORMAT_DEGREES

FORMAT_MINUTES

FORMAT_SECONDS

Public constructors

<init>

<init>

Public methods

bearingTo

convert

convert

describeContents

distanceBetween

distanceTo

dump

getAccuracy

getAltitude

getBearing

getBearingAccuracyDegrees

getElapsedRealtimeNanos

getElapsedRealtimeUncertaintyNanos

getExtras

getLatitude

getLongitude

getProvider

getSpeed

getSpeedAccuracyMetersPerSecond

getTime

getVerticalAccuracyMeters

hasAccuracy

hasAltitude

hasBearing

hasBearingAccuracy

hasElapsedRealtimeUncertaintyNanos

hasSpeed

hasSpeedAccuracy

hasVerticalAccuracy

isFromMockProvider

removeAccuracy

removeAltitude

removeBearing

removeSpeed

reset

set

setAccuracy

setAltitude

setBearing

setBearingAccuracyDegrees

setElapsedRealtimeNanos

setElapsedRealtimeUncertaintyNanos

setExtras

setLatitude

setLongitude

setProvider

setSpeed

setSpeedAccuracyMetersPerSecond

setTime

setVerticalAccuracyMeters

toString

writeToParcel

Properties

CREATOR