All Implemented Interfaces:
```
public class Location
extends Storable
                    
```
Container for location related information.
Class is made open because of WhereYouGo request: https://github.com/asamm/locus-api/issues/30

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Location.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private Long`	`id`
`private String`	`provider`
`private Long`	`time`
`private Double`	`latitude`
`private Double`	`longitude`
`private Double`	`altitude`
`private final Boolean`	`hasAltitude`
`private Float`	`speed`
`private final Boolean`	`hasSpeed`
`private Float`	`bearing`
`private final Boolean`	`hasBearing`
`private Float`	`accuracyHor`
`private final Boolean`	`hasAccuracyHor`
`private Float`	`accuracyVer`
`private final Boolean`	`hasAccuracyVer`
`private Short`	`sensorCadence`
`private final Boolean`	`hasSensorCadence`
`private Short`	`sensorHeartRate`
`private final Boolean`	`hasSensorHeartRate`
`private Float`	`sensorSpeed`
`private final Boolean`	`hasSensorSpeed`
`private Float`	`sensorPower`
`private final Boolean`	`hasSensorPower`
`private Integer`	`sensorStrides`
`private final Boolean`	`hasSensorStrides`
`private Float`	`sensorTemperature`
`private final Boolean`	`hasSensorTemperature`
`private Short`	`gnssQuality`
`private final Boolean`	`hasGnssQuality`
`private Float`	`gnssHdop`
`private final Boolean`	`hasGnssHdop`
`private Float`	`gnssVdop`
`private final Boolean`	`hasGnssVdop`
`private Float`	`gnssPdop`
`private final Boolean`	`hasGnssPdop`
`private Short`	`gnssSatsUsed`
`private final Boolean`	`hasGnssSatsUsed`
`private Short`	`gnssSatsVisible`
`private final Boolean`	`hasGnssSatsVisible`
`private final Float`	`speedOptimal`
`private final Storable`	`copy`
`private final ByteArray`	`asBytes`

Constructor Summary

Constructors
Constructor	Description
`Location(Double lat, Double lon)`
`Location(Location loc)`
`Location()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Long`	`getId()`	Location unique ID.
`final Unit`	`setId(Long id)`	Location unique ID.
`final String`	`getProvider()`	Provider for location source.
`final Unit`	`setProvider(String provider)`	Provider for location source.
`final Long`	`getTime()`	UTC time of this location (in ms).
`final Unit`	`setTime(Long time)`	UTC time of this location (in ms).
`final Double`	`getLatitude()`	Latitude of location in WGS coordinates.
`final Unit`	`setLatitude(Double latitude)`
`final Double`	`getLongitude()`	Longitude of location in WGS coordinates.
`final Unit`	`setLongitude(Double longitude)`
`final Double`	`getAltitude()`
`final Unit`	`setAltitude(Double altitude)`
`final Boolean`	`getHasAltitude()`
`final Float`	`getSpeed()`
`final Unit`	`setSpeed(Float speed)`
`final Boolean`	`getHasSpeed()`
`final Float`	`getBearing()`
`final Unit`	`setBearing(Float bearing)`
`final Boolean`	`getHasBearing()`
`final Float`	`getAccuracyHor()`
`final Unit`	`setAccuracyHor(Float accuracyHor)`
`final Boolean`	`getHasAccuracyHor()`
`final Float`	`getAccuracyVer()`
`final Unit`	`setAccuracyVer(Float accuracyVer)`
`final Boolean`	`getHasAccuracyVer()`
`final Short`	`getSensorCadence()`
`final Unit`	`setSensorCadence(Short sensorCadence)`
`final Boolean`	`getHasSensorCadence()`
`final Short`	`getSensorHeartRate()`
`final Unit`	`setSensorHeartRate(Short sensorHeartRate)`
`final Boolean`	`getHasSensorHeartRate()`
`final Float`	`getSensorSpeed()`
`final Unit`	`setSensorSpeed(Float sensorSpeed)`
`final Boolean`	`getHasSensorSpeed()`
`final Float`	`getSensorPower()`
`final Unit`	`setSensorPower(Float sensorPower)`
`final Boolean`	`getHasSensorPower()`
`final Integer`	`getSensorStrides()`
`final Unit`	`setSensorStrides(Integer sensorStrides)`
`final Boolean`	`getHasSensorStrides()`
`final Float`	`getSensorTemperature()`
`final Unit`	`setSensorTemperature(Float sensorTemperature)`
`final Boolean`	`getHasSensorTemperature()`
`final Short`	`getGnssQuality()`
`final Unit`	`setGnssQuality(Short gnssQuality)`
`final Boolean`	`getHasGnssQuality()`
`final Float`	`getGnssHdop()`
`final Unit`	`setGnssHdop(Float gnssHdop)`
`final Boolean`	`getHasGnssHdop()`
`final Float`	`getGnssVdop()`
`final Unit`	`setGnssVdop(Float gnssVdop)`
`final Boolean`	`getHasGnssVdop()`
`final Float`	`getGnssPdop()`
`final Unit`	`setGnssPdop(Float gnssPdop)`
`final Boolean`	`getHasGnssPdop()`
`final Short`	`getGnssSatsUsed()`
`final Unit`	`setGnssSatsUsed(Short gnssSatsUsed)`
`final Boolean`	`getHasGnssSatsUsed()`
`final Short`	`getGnssSatsVisible()`
`final Unit`	`setGnssSatsVisible(Short gnssSatsVisible)`
`final Boolean`	`getHasGnssSatsVisible()`
`final Float`	`getSpeedOptimal()`
`final Storable`	`getCopy()`
`final ByteArray`	`getAsBytes()`
`final Unit`	`removeAltitude()`
`final Unit`	`removeSpeed()`
`final Unit`	`removeBearing()`
`final Unit`	`removeAccuracyHor()`
`final Unit`	`removeAccuracyVer()`
`final Unit`	`removeSensorCadence()`
`final Unit`	`removeSensorHeartRate()`
`final Unit`	`removeSensorSpeed()`
`final Unit`	`removeSensorPower()`
`final Unit`	`removeSensorStrides()`
`final Unit`	`removeSensorTemperature()`
`final Unit`	`removeGnssQuality()`
`final Unit`	`removeGnssHdop()`
`final Unit`	`removeGnssVdop()`
`final Unit`	`removeGnssPdop()`
`final Unit`	`removeGnssSatsUsed()`
`final Unit`	`removeGnssSatsVisible()`
`final Unit`	`set(Location loc)`	Sets the contents of the location to the values from the given location.
`final Boolean`	`hasSpeedOptimal()`	Check if any speed (GPS or from sensors) is stored.
`final Unit`	`removeSensorAll()`	Remove all attached sensors values.
`final Unit`	`removeGnssAll()`	Remove all values related to GNSS metadata.
`String`	`toString()`
`final Float`	`distanceTo(Location dest)`	Returns the approximate distance in meters between this location and the given location.
`final Float`	`bearingTo(Location dest)`	Returns the approximate initial bearing in degrees East of true North when traveling along the shortest path between this location and the given location.
`final FloatArray`	`distanceAndBearingTo(Location dest)`	Compute bearing and distance values at once

Methods inherited from class locus.api.objects.extra.Location
read, read, read, write
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Location
```
Location(Double lat, Double lon)
```

Location
```
Location(Location loc)
```

Location
```
Location()
```

Method Detail

getId
```
 final Long getId()
```
Location unique ID.

setId
```
 final Unit setId(Long id)
```
Location unique ID.

getProvider
```
 final String getProvider()
```
Provider for location source.

setProvider

 final Unit setProvider(String provider)

Provider for location source.

getTime
```
 final Long getTime()
```
UTC time of this location (in ms).

setTime
```
 final Unit setTime(Long time)
```
UTC time of this location (in ms).

getLatitude
```
 final Double getLatitude()
```
Latitude of location in WGS coordinates.

setLatitude

 final Unit setLatitude(Double latitude)

getLongitude
```
 final Double getLongitude()
```
Longitude of location in WGS coordinates.

setLongitude

 final Unit setLongitude(Double longitude)

getAltitude
```
 final Double getAltitude()
```

setAltitude

 final Unit setAltitude(Double altitude)

getHasAltitude
```
 final Boolean getHasAltitude()
```

getSpeed
```
 final Float getSpeed()
```

setSpeed
```
 final Unit setSpeed(Float speed)
```

getHasSpeed
```
 final Boolean getHasSpeed()
```

getBearing
```
 final Float getBearing()
```

setBearing
```
 final Unit setBearing(Float bearing)
```

getHasBearing
```
 final Boolean getHasBearing()
```

getAccuracyHor
```
 final Float getAccuracyHor()
```

setAccuracyHor

 final Unit setAccuracyHor(Float accuracyHor)

getHasAccuracyHor
```
 final Boolean getHasAccuracyHor()
```

getAccuracyVer
```
 final Float getAccuracyVer()
```

setAccuracyVer

 final Unit setAccuracyVer(Float accuracyVer)

getHasAccuracyVer
```
 final Boolean getHasAccuracyVer()
```

getSensorCadence
```
 final Short getSensorCadence()
```

setSensorCadence

 final Unit setSensorCadence(Short sensorCadence)

getHasSensorCadence
```
 final Boolean getHasSensorCadence()
```

getSensorHeartRate
```
 final Short getSensorHeartRate()
```

setSensorHeartRate

 final Unit setSensorHeartRate(Short sensorHeartRate)

getHasSensorHeartRate
```
 final Boolean getHasSensorHeartRate()
```

getSensorSpeed
```
 final Float getSensorSpeed()
```

setSensorSpeed

 final Unit setSensorSpeed(Float sensorSpeed)

getHasSensorSpeed
```
 final Boolean getHasSensorSpeed()
```

getSensorPower
```
 final Float getSensorPower()
```

setSensorPower

 final Unit setSensorPower(Float sensorPower)

getHasSensorPower
```
 final Boolean getHasSensorPower()
```

getSensorStrides
```
 final Integer getSensorStrides()
```

setSensorStrides

 final Unit setSensorStrides(Integer sensorStrides)

getHasSensorStrides
```
 final Boolean getHasSensorStrides()
```

getSensorTemperature
```
 final Float getSensorTemperature()
```

setSensorTemperature

 final Unit setSensorTemperature(Float sensorTemperature)

getHasSensorTemperature

 final Boolean getHasSensorTemperature()

getGnssQuality
```
 final Short getGnssQuality()
```

setGnssQuality

 final Unit setGnssQuality(Short gnssQuality)

getHasGnssQuality
```
 final Boolean getHasGnssQuality()
```

getGnssHdop
```
 final Float getGnssHdop()
```

setGnssHdop

 final Unit setGnssHdop(Float gnssHdop)

getHasGnssHdop
```
 final Boolean getHasGnssHdop()
```

getGnssVdop
```
 final Float getGnssVdop()
```

setGnssVdop

 final Unit setGnssVdop(Float gnssVdop)

getHasGnssVdop
```
 final Boolean getHasGnssVdop()
```

getGnssPdop
```
 final Float getGnssPdop()
```

setGnssPdop

 final Unit setGnssPdop(Float gnssPdop)

getHasGnssPdop
```
 final Boolean getHasGnssPdop()
```

getGnssSatsUsed
```
 final Short getGnssSatsUsed()
```

setGnssSatsUsed

 final Unit setGnssSatsUsed(Short gnssSatsUsed)

getHasGnssSatsUsed
```
 final Boolean getHasGnssSatsUsed()
```

getGnssSatsVisible
```
 final Short getGnssSatsVisible()
```

setGnssSatsVisible

 final Unit setGnssSatsVisible(Short gnssSatsVisible)

getHasGnssSatsVisible
```
 final Boolean getHasGnssSatsVisible()
```

getSpeedOptimal
```
 final Float getSpeedOptimal()
```

getCopy
```
 final Storable getCopy()
```

getAsBytes
```
 final ByteArray getAsBytes()
```

removeAltitude
```
 final Unit removeAltitude()
```

removeSpeed
```
 final Unit removeSpeed()
```

removeBearing
```
 final Unit removeBearing()
```

removeAccuracyHor
```
 final Unit removeAccuracyHor()
```

removeAccuracyVer
```
 final Unit removeAccuracyVer()
```

removeSensorCadence
```
 final Unit removeSensorCadence()
```

removeSensorHeartRate
```
 final Unit removeSensorHeartRate()
```

removeSensorSpeed
```
 final Unit removeSensorSpeed()
```

removeSensorPower
```
 final Unit removeSensorPower()
```

removeSensorStrides
```
 final Unit removeSensorStrides()
```

removeSensorTemperature
```
 final Unit removeSensorTemperature()
```

removeGnssQuality
```
 final Unit removeGnssQuality()
```

removeGnssHdop
```
 final Unit removeGnssHdop()
```

removeGnssVdop
```
 final Unit removeGnssVdop()
```

removeGnssPdop
```
 final Unit removeGnssPdop()
```

removeGnssSatsUsed
```
 final Unit removeGnssSatsUsed()
```

removeGnssSatsVisible
```
 final Unit removeGnssSatsVisible()
```

set
```
 final Unit set(Location loc)
```
Sets the contents of the location to the values from the given location.

hasSpeedOptimal

@Deprecated(message = "Work with speed value directly") final Boolean hasSpeedOptimal()

Check if any speed (GPS or from sensors) is stored.

removeSensorAll
```
 final Unit removeSensorAll()
```
Remove all attached sensors values.

removeGnssAll
```
 final Unit removeGnssAll()
```
Remove all values related to GNSS metadata.

toString
```
 String toString()
```

distanceTo
```
 final Float distanceTo(Location dest)
```
Returns the approximate distance in meters between this location and the given location. Distance is defined using the WGS84 ellipsoid.

Parameters:

dest - the destination location

bearingTo
```
 final Float bearingTo(Location dest)
```
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.

Parameters:

dest - the destination location

distanceAndBearingTo
```
 final FloatArray distanceAndBearingTo(Location dest)
```
Compute bearing and distance values at once

Parameters:

dest - the destination location

Class Location

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class locus.api.objects.extra.Location

Methods inherited from class java.lang.Object

Constructor Detail

Location

Location

Location

Method Detail

getId

setId

getProvider

setProvider

getTime

setTime

getLatitude

setLatitude

getLongitude

setLongitude

getAltitude

setAltitude

getHasAltitude

getSpeed

setSpeed

getHasSpeed

getBearing

setBearing

getHasBearing

getAccuracyHor

setAccuracyHor

getHasAccuracyHor

getAccuracyVer

setAccuracyVer

getHasAccuracyVer

getSensorCadence

setSensorCadence

getHasSensorCadence

getSensorHeartRate

setSensorHeartRate

getHasSensorHeartRate

getSensorSpeed

setSensorSpeed

getHasSensorSpeed

getSensorPower

setSensorPower

getHasSensorPower

getSensorStrides

setSensorStrides

getHasSensorStrides

getSensorTemperature

setSensorTemperature

getHasSensorTemperature

getGnssQuality

setGnssQuality

getHasGnssQuality

getGnssHdop

setGnssHdop

getHasGnssHdop

getGnssVdop

setGnssVdop

getHasGnssVdop

getGnssPdop

setGnssPdop

getHasGnssPdop

getGnssSatsUsed

setGnssSatsUsed

getHasGnssSatsUsed

getGnssSatsVisible

setGnssSatsVisible

getHasGnssSatsVisible

getSpeedOptimal

getCopy

getAsBytes

removeAltitude

removeSpeed

removeBearing