Added in API level 34

Location

class Location : Parcelable
kotlin.Any
   ↳ android.health.connect.datatypes.ExerciseRoute.Location

Point in the time and space. Used in ExerciseRoute.

Summary

Nested classes

Builder class for Location
Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
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.
Properties
static Parcelable.Creator<ExerciseRoute.Location!>

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

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.

Parameters
obj the reference object with which to compare.
o This value may be null.
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.0f and 90.0f inclusive

getLongitude

Added in API level 34
fun getLongitude(): Double

Returns longitude of this location

Return
Double Value is between -180.0f and 180.0f 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!>