Position (geo 0.6.6 API)

java.lang.Object
- com.github.davidmoten.geo.Position

```
public class Position
extends Object
```
Encapsulates latitude, longitude and altitude. Provides great circle navigation methods. Immutable.

Author:

dave

Constructor Summary

Constructors
Constructor and Description

Position(double lat, double lon)

Position(double lat, double lon, double altitudeMetres)

Constructors
Constructor and Description
`Position(double lat, double lon)`
`Position(double lat, double lon, double altitudeMetres)`

Method Summary

Methods
Modifier and Type	Method and Description
`static Position`	`create(double lat, double lon)`
`Position`	`ensureContinuous(Position lastPosition)` normalize the lat lon values of this to ensure that no large longitude jumps are made from lastPosition (e.g.
`boolean`	`equals(Object o)`
`double`	`getAlt()` Returns the altitue in metres.
`double`	`getBearingDegrees(Position position)` Returns the Great Circle bearing to the given position from this.
`static double`	`getBearingDifferenceDegrees(double bearing1, double bearing2)` Returns difference in degrees in the range -180 to 180
`Position`	`getClosestIntersectionWithSegment(Position p1, Position p2)`
`double`	`getDistanceToKm(Position position)` returns distance between two WGS84 positions according to Vincenty's formula from Wikipedia
`double`	`getDistanceToPathKm(List<Position> positions)`
`double`	`getDistanceToSegmentKm(Position p1, Position p2)`
`double`	`getLat()` Returns the latitude in decimal degrees.
`double`	`getLon()` Returns the longitude in decimal degrees.
`Position`	`getPositionAlongPath(Position position, double proportion)` Returns a position along a path according to the proportion value
`int`	`hashCode()`
`boolean`	`isOutside(List<Position> path, double minDistanceKm)`
`boolean`	`isWithin(List<Position> positions)`
`static double`	`longitudeDiff(double a, double b)` Returns the difference between two longitude values.
`Position`	`predict(double distanceKm, double courseDegrees)` Predicts position travelling along a great circle arc based on the Haversine formula.
`static double`	`to180(double d)` Converts an angle in degrees to range -180< x <= 180.
`static double`	`toDegrees(double degrees, double minutes, double seconds)` Returns the value in decimal degrees of a DMS (degrees minutes seconds) value.
`static String`	`toDegreesMinutesDecimalMinutesLatitude(double lat)`
`static String`	`toDegreesMinutesDecimalMinutesLongitude(double lon)` Returns a string representation of a longitude value in the format 00.00[W\|E].
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Position
```
public Position(double lat,
        double lon)
```
    Parameters:
    lat - in degrees
    lon - in degrees
  - Position
```
public Position(double lat,
        double lon,
        double altitudeMetres)
```
    Parameters:
    lat - in degrees
    lon - in degrees
    altitudeMetres - in metres
- Method Detail
  - getLat
```
public final double getLat()
```
    Returns the latitude in decimal degrees.
    
    Returns:
  - getLon
```
public final double getLon()
```
    Returns the longitude in decimal degrees.
    
    Returns:
  - getAlt
```
public final double getAlt()
```
    Returns the altitue in metres.
    
    Returns:
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - predict
```
public final Position predict(double distanceKm,
               double courseDegrees)
```
    Predicts position travelling along a great circle arc based on the Haversine formula. From http://www.movable-type.co.uk/scripts/latlong.html
    
    Parameters:
    distanceKm -
    courseDegrees -
    
    Returns:
  - toDegrees
```
public static double toDegrees(double degrees,
               double minutes,
               double seconds)
```
    Returns the value in decimal degrees of a DMS (degrees minutes seconds) value.
    
    Parameters:
    degrees -
    minutes -
    seconds -
    
    Returns:
  - getDistanceToKm
```
public final double getDistanceToKm(Position position)
```
    returns distance between two WGS84 positions according to Vincenty's formula from Wikipedia
    
    Parameters:
    position -
    
    Returns:
  - getBearingDegrees
```
public final double getBearingDegrees(Position position)
```
    Returns the Great Circle bearing to the given position from this.
    
    Parameters:
    position -
    
    Returns:
  - getBearingDifferenceDegrees
```
public static double getBearingDifferenceDegrees(double bearing1,
                                 double bearing2)
```
    Returns difference in degrees in the range -180 to 180
    
    Parameters:
    bearing1 - degrees between -360 and 360
    bearing2 - degrees between -360 and 360
    
    Returns:
  - toDegreesMinutesDecimalMinutesLatitude
```
public static String toDegreesMinutesDecimalMinutesLatitude(double lat)
```
  - toDegreesMinutesDecimalMinutesLongitude
```
public static String toDegreesMinutesDecimalMinutesLongitude(double lon)
```
    Returns a string representation of a longitude value in the format 00.00[W|E]. For example -25.3 is 25.30W
    
    Parameters:
    lon -
    
    Returns:
  - getPositionAlongPath
```
public final Position getPositionAlongPath(Position position,
                            double proportion)
```
    Returns a position along a path according to the proportion value
    
    Parameters:
    position -
    proportion - is between 0 and 1 inclusive
    
    Returns:
  - ensureContinuous
```
public final Position ensureContinuous(Position lastPosition)
```
    normalize the lat lon values of this to ensure that no large longitude jumps are made from lastPosition (e.g. 179 to -180)
    
    Parameters:
    lastPosition -
  - isWithin
```
public final boolean isWithin(List<Position> positions)
```
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getDistanceToPathKm
```
public final double getDistanceToPathKm(List<Position> positions)
```
  - getDistanceToSegmentKm
```
public final double getDistanceToSegmentKm(Position p1,
                            Position p2)
```
  - getClosestIntersectionWithSegment
```
public final Position getClosestIntersectionWithSegment(Position p1,
                                         Position p2)
```
  - isOutside
```
public boolean isOutside(List<Position> path,
                double minDistanceKm)
```
    Parameters:
    path -
    minDistanceKm -
    
    Returns:
  - create
```
public static Position create(double lat,
              double lon)
```
  - longitudeDiff
```
public static double longitudeDiff(double a,
                   double b)
```
    Returns the difference between two longitude values. The returned value is always >=0.
    
    Parameters:
    a -
    b -
    
    Returns:
  - to180
```
public static double to180(double d)
```
    Converts an angle in degrees to range -180< x <= 180.
    
    Parameters:
    d -
    
    Returns:

Class Position

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Position

Position

Method Detail

getLat

getLon

getAlt

toString

predict

toDegrees

getDistanceToKm

getBearingDegrees

getBearingDifferenceDegrees

toDegreesMinutesDecimalMinutesLatitude

toDegreesMinutesDecimalMinutesLongitude

getPositionAlongPath

ensureContinuous

isWithin

equals

hashCode

getDistanceToPathKm

getDistanceToSegmentKm

getClosestIntersectionWithSegment

isOutside

create

longitudeDiff

to180