Added in API level 34

Location


class Location : Parcelable

Point in the time and space. Used in ExerciseRoute.

Summary

Nested classes

Builder class for Location

Inherited constants
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 methods
Int

Boolean
equals(other: Any?)

Length?

Returns altitude of this location time point.

Length?

Returns horizontal accuracy of this location time point.

Double

Returns latitude of this location

Double

Returns longitude of this location

Instant

Returns time when this location has been recorded

Length?

Returns vertical accuracy of this location time point.

Int

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Public methods

describeContents

Added in API level 34
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 34
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAltitude

Added in API level 34
fun getAltitude(): Length?

Returns altitude of this location time point. Returns null if no altitude was specified.

getHorizontalAccuracy

Added in API level 34
fun getHorizontalAccuracy(): Length?

Returns horizontal accuracy of this location time point. Returns null if no horizontal accuracy was specified.

getLatitude

Added in API level 34
fun getLatitude(): Double

Returns latitude of this location

Return
Double Value is between -90.0 and 90.0 inclusive

getLongitude

Added in API level 34
fun getLongitude(): Double

Returns longitude of this location

Return
Double Value is between -180.0 and 180.0 inclusive

getTime

Added in API level 34
fun getTime(): Instant

Returns time when this location has been recorded

Return
Instant This value cannot be null.

getVerticalAccuracy

Added in API level 34
fun getVerticalAccuracy(): Length?

Returns vertical accuracy of this location time point. Returns null if no vertical accuracy was specified.

hashCode

Added in API level 34
fun hashCode(): Int
Return
Int a hash code value for this object.

writeToParcel

Added in API level 34
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
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

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<ExerciseRoute.Location!>