```
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 Boolean`	`hasAltitude`
`private Double`	`altitude`
`private Float`	`speed`
`private final Float`	`speedOptimal`
`private Float`	`bearing`
`private Float`	`accuracy`
`private Integer`	`sensorHeartRate`
`private Integer`	`sensorCadence`
`private Float`	`sensorSpeed`
`private Float`	`sensorPower`
`private Integer`	`sensorStrides`
`private Float`	`sensorTemperature`
`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 Boolean`	`getHasAltitude()`	Flag if altitude is set.
`final Unit`	`setHasAltitude(Boolean hasAltitude)`	Flag if altitude is set.
`final Double`	`getAltitude()`
`final Unit`	`setAltitude(Double altitude)`
`final Float`	`getSpeed()`
`final Unit`	`setSpeed(Float speed)`
`final Float`	`getSpeedOptimal()`
`final Float`	`getBearing()`
`final Unit`	`setBearing(Float bearing)`
`final Float`	`getAccuracy()`
`final Unit`	`setAccuracy(Float accuracy)`
`final Integer`	`getSensorHeartRate()`
`final Unit`	`setSensorHeartRate(Integer sensorHeartRate)`
`final Integer`	`getSensorCadence()`
`final Unit`	`setSensorCadence(Integer sensorCadence)`
`final Float`	`getSensorSpeed()`
`final Unit`	`setSensorSpeed(Float sensorSpeed)`
`final Float`	`getSensorPower()`
`final Unit`	`setSensorPower(Float sensorPower)`
`final Integer`	`getSensorStrides()`
`final Unit`	`setSensorStrides(Integer sensorStrides)`
`final Float`	`getSensorTemperature()`
`final Unit`	`setSensorTemperature(Float sensorTemperature)`
`final Storable`	`getCopy()`
`final ByteArray`	`getAsBytes()`
`final Unit`	`removeAltitude()`	Clears the altitude of this fix.
`final Unit`	`set(Location loc)`	Sets the contents of the location to the values from the given location.
`final Boolean`	`hasSpeed()`	Check if location contains speed information received from GPS hardware.
`final Unit`	`removeSpeed()`	Clears the speed of this location.
`final Boolean`	`hasSpeedOptimal()`	Check if any speed (GPS or from sensors) is stored.
`final Boolean`	`hasBearing()`	Check if the location is able to report bearing information.
`final Unit`	`removeBearing()`	Clears the bearing of this fix.
`final Boolean`	`hasAccuracy()`	Returns true if the provider is able to report accuracy information, false otherwise.
`final Unit`	`removeAccuracy()`	Clears the accuracy of this fix.
`final Boolean`	`hasSensorHeartRate()`	Returns true if the provider is able to report Heart rate information, false otherwise.
`final Unit`	`removeSensorHeartRate()`	Clears the accuracy of this fix.
`final Boolean`	`hasSensorCadence()`	Returns true if the provider is able to report cadence information, false otherwise.
`final Unit`	`removeSensorCadence()`	Clears the cadence of this fix.
`final Boolean`	`hasSensorSpeed()`	Check if the speed received from connected sensor exists.
`final Unit`	`removeSensorSpeed()`	Clears the sensor based speed.
`final Boolean`	`hasSensorPower()`	Returns true if the provider is able to report power value, false otherwise.
`final Unit`	`removeSensorPower()`	Clears the power of this fix.
`final Boolean`	`hasSensorStrides()`	Returns true if the provider is able to report strides value, false otherwise.
`final Unit`	`removeSensorStrides()`	Clears the num of strides.
`final Boolean`	`hasSensorTemperature()`	Returns true if the provider is able to report temperature value, false otherwise.
`final Unit`	`removeSensorTemperature()`	Clears the temperature value.
`final Unit`	`removeSensorAll()`	Clear all attached sensors values.
`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)
```
  - getHasAltitude
```
 final Boolean getHasAltitude()
```
    Flag if altitude is set.
  - setHasAltitude
```
 final Unit setHasAltitude(Boolean hasAltitude)
```
    Flag if altitude is set.
  - getAltitude
```
 final Double getAltitude()
```
  - setAltitude
```
 final Unit setAltitude(Double altitude)
```
  - getSpeed
```
 final Float getSpeed()
```
  - setSpeed
```
 final Unit setSpeed(Float speed)
```
  - getSpeedOptimal
```
 final Float getSpeedOptimal()
```
  - getBearing
```
 final Float getBearing()
```
  - setBearing
```
 final Unit setBearing(Float bearing)
```
  - getAccuracy
```
 final Float getAccuracy()
```
  - setAccuracy
```
 final Unit setAccuracy(Float accuracy)
```
  - getSensorHeartRate
```
 final Integer getSensorHeartRate()
```
  - setSensorHeartRate
```
 final Unit setSensorHeartRate(Integer sensorHeartRate)
```
  - getSensorCadence
```
 final Integer getSensorCadence()
```
  - setSensorCadence
```
 final Unit setSensorCadence(Integer sensorCadence)
```
  - getSensorSpeed
```
 final Float getSensorSpeed()
```
  - setSensorSpeed
```
 final Unit setSensorSpeed(Float sensorSpeed)
```
  - getSensorPower
```
 final Float getSensorPower()
```
  - setSensorPower
```
 final Unit setSensorPower(Float sensorPower)
```
  - getSensorStrides
```
 final Integer getSensorStrides()
```
  - setSensorStrides
```
 final Unit setSensorStrides(Integer sensorStrides)
```
  - getSensorTemperature
```
 final Float getSensorTemperature()
```
  - setSensorTemperature
```
 final Unit setSensorTemperature(Float sensorTemperature)
```
  - getCopy
```
 final Storable getCopy()
```
  - getAsBytes
```
 final ByteArray getAsBytes()
```
  - removeAltitude
```
 final Unit removeAltitude()
```
    Clears the altitude of this fix. Following this call, hasAltitude() will return false.
  - set
```
 final Unit set(Location loc)
```
    Sets the contents of the location to the values from the given location.
    
    Parameters:
    
    loc - source location object
  - hasSpeed
```
 final Boolean hasSpeed()
```
    Check if location contains speed information received from GPS hardware.
  - removeSpeed
```
 final Unit removeSpeed()
```
    Clears the speed of this location. Following this call, hasSpeed will return false.
  - hasSpeedOptimal
```
 final Boolean hasSpeedOptimal()
```
    Check if any speed (GPS or from sensors) is stored.
  - hasBearing
```
 final Boolean hasBearing()
```
    Check if the location is able to report bearing information.
  - removeBearing
```
 final Unit removeBearing()
```
    Clears the bearing of this fix. Following this call, hasBearing() will return false.
  - hasAccuracy
```
 final Boolean hasAccuracy()
```
    Returns true if the provider is able to report accuracy information, false otherwise. The default implementation returns false.
  - removeAccuracy
```
 final Unit removeAccuracy()
```
    Clears the accuracy of this fix. Following this call, hasAccuracy() will return false.
  - hasSensorHeartRate
```
 final Boolean hasSensorHeartRate()
```
    Returns true if the provider is able to report Heart rate information, false otherwise. The default implementation returns false.
  - removeSensorHeartRate
```
 final Unit removeSensorHeartRate()
```
    Clears the accuracy of this fix. Following this call, hasSensorHeartRate() will return false.
  - hasSensorCadence
```
 final Boolean hasSensorCadence()
```
    Returns true if the provider is able to report cadence information, false otherwise. The default implementation returns false.
  - removeSensorCadence
```
 final Unit removeSensorCadence()
```
    Clears the cadence of this fix. Following this call, hasCadence() will return false.
  - hasSensorSpeed
```
 final Boolean hasSensorSpeed()
```
    Check if the speed received from connected sensor exists.
  - removeSensorSpeed
```
 final Unit removeSensorSpeed()
```
    Clears the sensor based speed. After this, hasSensorSpeed will return 'false'.
  - hasSensorPower
```
 final Boolean hasSensorPower()
```
    Returns true if the provider is able to report power value, false otherwise. The default implementation returns false.
  - removeSensorPower
```
 final Unit removeSensorPower()
```
    Clears the power of this fix. Following this call, hasSensorPower() will return false.
  - hasSensorStrides
```
 final Boolean hasSensorStrides()
```
    Returns true if the provider is able to report strides value, false otherwise. The default implementation returns false.
  - removeSensorStrides
```
 final Unit removeSensorStrides()
```
    Clears the num of strides. Following this call, hasSensorStrides() will return false.
  - hasSensorTemperature
```
 final Boolean hasSensorTemperature()
```
    Returns true if the provider is able to report temperature value, false otherwise. The default implementation returns false.
  - removeSensorTemperature
```
 final Unit removeSensorTemperature()
```
    Clears the temperature value. Following this call, hasSensorTemperature() will return false.
  - removeSensorAll
```
 final Unit removeSensorAll()
```
    Clear all attached sensors values.
  - 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

getHasAltitude

setHasAltitude

getAltitude

setAltitude

getSpeed

setSpeed

getSpeedOptimal

getBearing

setBearing

getAccuracy

setAccuracy

getSensorHeartRate

setSensorHeartRate

getSensorCadence

setSensorCadence

getSensorSpeed

setSensorSpeed

getSensorPower

setSensorPower

getSensorStrides

setSensorStrides

getSensorTemperature

setSensorTemperature

getCopy

getAsBytes

removeAltitude

set

hasSpeed

removeSpeed

hasSpeedOptimal

hasBearing

removeBearing

hasAccuracy

removeAccuracy

hasSensorHeartRate

removeSensorHeartRate

hasSensorCadence

removeSensorCadence

hasSensorSpeed

removeSensorSpeed

hasSensorPower

removeSensorPower

hasSensorStrides

removeSensorStrides

hasSensorTemperature

removeSensorTemperature

removeSensorAll

toString

distanceTo

bearingTo

distanceAndBearingTo