```
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.ValueContainer`
`public final class`	`Location.ValueContainerInt`
`public class`	`Location.ValueContainerFloat`
`public final class`	`Location.ValueContainerDouble`
`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 final Location.ValueContainerDouble`	`altitude`
`private final Location.ValueContainerFloat`	`speed`
`private final Location.ValueContainerFloat`	`bearing`
`private final Location.ValueContainerFloat`	`accuracy`
`private Location.ValueContainerInt`	`sensorCadence`
`private Location.ValueContainerInt`	`sensorHeartRate`
`private Location.ValueContainerFloat`	`sensorSpeed`
`private Location.ValueContainerFloat`	`sensorPower`
`private Location.ValueContainerInt`	`sensorStrides`
`private Location.ValueContainerFloat`	`sensorTemperature`
`private final Location.ValueContainerInt`	`gnssStatus`
`private final Location.ValueContainerFloat`	`gnssHdop`
`private final Location.ValueContainerFloat`	`gnssVdop`
`private final Location.ValueContainerFloat`	`gnssPdop`
`private final Location.ValueContainerInt`	`gnssSatsUsed`
`private final Location.ValueContainerInt`	`gnssSatsVisible`
`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()`

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 Location.ValueContainerDouble`	`getAltitude()`	Altitude value of the location (in m).
`final Location.ValueContainerFloat`	`getSpeed()`	Speed of the device in meters/second.
`final Location.ValueContainerFloat`	`getBearing()`	Direction of travel in degrees East of true North.
`final Location.ValueContainerFloat`	`getAccuracy()`	Accuracy of the fix.
`final Location.ValueContainerInt`	`getSensorCadence()`	Cadence value.
`final Unit`	`setSensorCadence(Location.ValueContainerInt sensorCadence)`	Cadence value.
`final Location.ValueContainerInt`	`getSensorHeartRate()`	Heart rate value in BMP.
`final Unit`	`setSensorHeartRate(Location.ValueContainerInt sensorHeartRate)`	Heart rate value in BMP.
`final Location.ValueContainerFloat`	`getSensorSpeed()`	Speed of the device over ground in meters/second.
`final Unit`	`setSensorSpeed(Location.ValueContainerFloat sensorSpeed)`	Speed of the device over ground in meters/second.
`final Location.ValueContainerFloat`	`getSensorPower()`	Power value of the fix in W.
`final Unit`	`setSensorPower(Location.ValueContainerFloat sensorPower)`	Power value of the fix in W.
`final Location.ValueContainerInt`	`getSensorStrides()`	The num of strides.
`final Unit`	`setSensorStrides(Location.ValueContainerInt sensorStrides)`	The num of strides.
`final Location.ValueContainerFloat`	`getSensorTemperature()`	Temperature value.
`final Unit`	`setSensorTemperature(Location.ValueContainerFloat sensorTemperature)`	Temperature value.
`final Location.ValueContainerInt`	`getGnssStatus()`
`final Location.ValueContainerFloat`	`getGnssHdop()`	Horizontal dilution of precision for current location.
`final Location.ValueContainerFloat`	`getGnssVdop()`	Vertical dilution of precision for current location.
`final Location.ValueContainerFloat`	`getGnssPdop()`	Position (3D) dilution of precision for current location.
`final Location.ValueContainerInt`	`getGnssSatsUsed()`	Number of used satellites used to obtain current location.
`final Location.ValueContainerInt`	`getGnssSatsVisible()`	Number of used satellites used to obtain current location.
`final Float`	`getSpeedOptimal()`
`final Storable`	`getCopy()`
`final ByteArray`	`getAsBytes()`
`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 Location.ValueContainerDouble getAltitude()
```
    Altitude value of the location (in m). If 'hasData' is false, 0.0f is returned.
  - getSpeed
```
 final Location.ValueContainerFloat getSpeed()
```
    Speed of the device in meters/second.
  - getBearing
```
 final Location.ValueContainerFloat getBearing()
```
    Direction of travel in degrees East of true North. If 'hasData' is false, 0.0 is returned (in degree).
  - getAccuracy
```
 final Location.ValueContainerFloat getAccuracy()
```
    Accuracy of the fix. If 'hasData' is false, 0.0 is returned (in m).
  - getSensorCadence
```
 final Location.ValueContainerInt getSensorCadence()
```
    Cadence value. If hasCadence() is false, 0 is returned.
  - setSensorCadence
```
 final Unit setSensorCadence(Location.ValueContainerInt sensorCadence)
```
    Cadence value. If hasCadence() is false, 0 is returned.
  - getSensorHeartRate
```
 final Location.ValueContainerInt getSensorHeartRate()
```
    Heart rate value in BMP. If hasSensorHeartRate() is false, 0 is returned.
  - setSensorHeartRate
```
 final Unit setSensorHeartRate(Location.ValueContainerInt sensorHeartRate)
```
    Heart rate value in BMP. If hasSensorHeartRate() is false, 0 is returned.
  - getSensorSpeed
```
 final Location.ValueContainerFloat getSensorSpeed()
```
    Speed of the device over ground in meters/second. This speed is defined only when 'speed sensor' is connected and supply valid values.
    If 'hasData' is 'false', 0.0f is returned (in m/s).
  - setSensorSpeed
```
 final Unit setSensorSpeed(Location.ValueContainerFloat sensorSpeed)
```
    Speed of the device over ground in meters/second. This speed is defined only when 'speed sensor' is connected and supply valid values.
    If 'hasData' is 'false', 0.0f is returned (in m/s).
  - getSensorPower
```
 final Location.ValueContainerFloat getSensorPower()
```
    Power value of the fix in W. If hasSensorPower() is false, 0.0 is returned.
  - setSensorPower
```
 final Unit setSensorPower(Location.ValueContainerFloat sensorPower)
```
    Power value of the fix in W. If hasSensorPower() is false, 0.0 is returned.
  - getSensorStrides
```
 final Location.ValueContainerInt getSensorStrides()
```
    The num of strides. If hasSensorStrides() is false, 0 is returned.
  - setSensorStrides
```
 final Unit setSensorStrides(Location.ValueContainerInt sensorStrides)
```
    The num of strides. If hasSensorStrides() is false, 0 is returned.
  - getSensorTemperature
```
 final Location.ValueContainerFloat getSensorTemperature()
```
    Temperature value. If hasSensorTemperature() is false, 0.0f is returned.
  - setSensorTemperature
```
 final Unit setSensorTemperature(Location.ValueContainerFloat sensorTemperature)
```
    Temperature value. If hasSensorTemperature() is false, 0.0f is returned.
  - getGnssStatus
```
 final Location.ValueContainerInt getGnssStatus()
```
  - getGnssHdop
```
 final Location.ValueContainerFloat getGnssHdop()
```
    Horizontal dilution of precision for current location.
    More info: https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation).
  - getGnssVdop
```
 final Location.ValueContainerFloat getGnssVdop()
```
    Vertical dilution of precision for current location.
    More info: https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation).
  - getGnssPdop
```
 final Location.ValueContainerFloat getGnssPdop()
```
    Position (3D) dilution of precision for current location.
    More info: https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation).
  - getGnssSatsUsed
```
 final Location.ValueContainerInt getGnssSatsUsed()
```
    Number of used satellites used to obtain current location.
  - getGnssSatsVisible
```
 final Location.ValueContainerInt getGnssSatsVisible()
```
    Number of used satellites used to obtain current location.
  - getSpeedOptimal
```
 final Float getSpeedOptimal()
```
  - getCopy
```
 final Storable getCopy()
```
  - getAsBytes
```
 final ByteArray getAsBytes()
```
  - 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

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

getSpeed

getBearing

getAccuracy

getSensorCadence

setSensorCadence

getSensorHeartRate

setSensorHeartRate

getSensorSpeed

setSensorSpeed

getSensorPower

setSensorPower

getSensorStrides

setSensorStrides

getSensorTemperature

setSensorTemperature

getGnssStatus

getGnssHdop

getGnssVdop

getGnssPdop

getGnssSatsUsed

getGnssSatsVisible

getSpeedOptimal

getCopy

getAsBytes

set

hasSpeedOptimal

removeSensorAll

removeGnssAll

toString

distanceTo

bearingTo

distanceAndBearingTo