LatLng (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.types.custom.LatLng

```
public class LatLng
extends Object
```
Latitude and Longitude coordinate.
This class implements most methods in GeoUtils, as this as the first parameter.
Java conversion of Geodesy representation conversion functions (c) Chris Veness 2002-2014
- www.movable-type.co.uk/scripts/latlong.html.
. Rules:
- The degress is expressed in 360 degrees not radians.
- The latitude range is -90.0 to 90.0.
- The longitude range is -180.0 to 180.0.
- If latitude is less then zero than the compass is "S" otherwise "N"
- If longitude is less then zero than the compass is "W" otherwise "E"
- If either latitude or longitude is outside the range, they are normalize to be inside the range.
Converting to DMS (Degrees,Minutes,Seconds,Compass):
- Latitude
- Longtitude
- [ 36.119] is [036.0° 07.0' 08.0"E]
- [ -36.119] is [036.0° 07.0' 08.0"W]
- [ 136.119] is [136.0° 07.0' 08.0"E]
- [-136.119] is [136.0° 07.0' 08.0"W]
- [ 436.119] is [076.0° 07.0' 08.0"E]
- [-436.119] is [076.0° 07.0' 08.0"W]
Since:

1.9

Author:

Frederik Heick

See Also:

GeoUtils

Field Summary

Fields
Modifier and Type Field and Description

static double DEFAULT_EARTH_RADIUS_IN_KM
The default use earth radius in KM.

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_EARTH_RADIUS_IN_KM` The default use earth radius in KM.

Constructor Summary

Constructors
Constructor and Description
`LatLng(double latitude, double longitude)` Constructing a LatLng value object, and normalizing the degrees for latitude and longitude using default earth radius of 6371 Km and height of 0 Km.
`LatLng(double latitude, double longitude, double height)` Constructing a LatLng value object, and normalizing the degrees for latitude and longitude using default earth radius of 6371 Km.
`LatLng(double latitude, double longitude, double height, double radius)` Constructing a LatLng value object, and normalizing the degrees for latitude and longitude.
`LatLng(LatLng other)` Constructs a LatLng value on the basis of another LatLng instance.
`LatLng(Point other)` Constructs an LatLng instance on the basis of `java.awt.Point`.
`LatLng(Point2D.Double other)` Constructs an LatLng instance on the basis of `java.awt.geom.Point2D.Double`.
`LatLng(Point2D other)` Constructs an LatLng instance on the basis of `dk.heick.properties.types.customPoint2D`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Determines if this LatLng is equals with either another LatLng.
`boolean`	`equals(Object obj, double precision)` Compares an other object with this.
`Point2D`	`getAsPoint2D()` Returns a instance of `dk.heick.properties.types.customPoint2D` where X is latitude and Y is longitude
`double`	`getBearingTo(LatLng toPoint)`
`LatLng`	`getDestinationPoint(double bearing, double distance)`
`double`	`getDistanceBetweenPoints(LatLng pointTo)`
`double`	`getFinalBearingTo(LatLng toPoint)`
`Double`	`getHeight()` The height over the earths surface in Km
`LatLng`	`getIntersection(double firstIntialBearing, LatLng toPoint, double secondIntialBearing)`
`Double`	`getLatitude()` Gets the latitude in degrees
`Double`	`getLatitudeRadians()` Gets the latitude in radians.
`Double`	`getLongitude()` Gets the longitude in degrees
`Double`	`getLongitudeRadians()` Gets the longitude in radians.
`LatLng`	`getMidPointTo(LatLng toPoint)`
`Double`	`getRadius()` The earth radius in Km
`double`	`getRHumbBearingTo(LatLng toPoint)`
`LatLng`	`getRHumbDestinationPoint(double bearing, double distance)`
`double`	`getRHumbDistanceTo(LatLng toPoint)`
`LatLng`	`getRHumbMidpointTo(LatLng toPoint)`
`int`	`hashCode()`
`static LatLng`	`parse(String value)` Parse a strnig value to a LatLng object, this can parse pretty must any format.
`static String`	`toBearing(Double degrees, LatLngFormat format, Integer dp)`
`String`	`toDMSString()`
`String`	`toDMSString(LatLngFormat format)`
`String`	`toDMSString(LatLngFormat format, Integer dp)` Returns a string representation of 'this' point, formatted as degrees, degrees+minutes, or degrees+minutes+seconds.
`String`	`toString()`

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

- Field Detail
  - DEFAULT_EARTH_RADIUS_IN_KM
```
public static double DEFAULT_EARTH_RADIUS_IN_KM
```
    The default use earth radius in KM. (6371 Km)
- Constructor Detail
  - LatLng
```
public LatLng(double latitude,
              double longitude,
              double height,
              double radius)
```
    Constructing a LatLng value object, and normalizing the degrees for latitude and longitude.
    
    Parameters:
    
    latitude - the latitude degrees, which will be normalized.
    
    longitude - the longitude degrees, which will be normalized.
    
    height - the height over the earth surface in Km.
    
    radius - the radius of the earth in "Km", must between 6353 nd 6384.
    
    See Also:
    
    GeoUtils, GeoUtils.normalizeLatitudeDegrees(double), GeoUtils.normalizeLongitudeDegrees(double)
  - LatLng
```
public LatLng(double latitude,
              double longitude,
              double height)
```
    Constructing a LatLng value object, and normalizing the degrees for latitude and longitude using default earth radius of 6371 Km.
    
    Parameters:
    
    latitude - the latitude degrees, which will be normalized.
    
    longitude - the longitude degrees, which will be normalized.
    
    height - the height over the earth surface in Km.
    
    See Also:
    
    DEFAULT_EARTH_RADIUS_IN_KM, GeoUtils, GeoUtils.normalizeLatitudeDegrees(double), GeoUtils.normalizeLongitudeDegrees(double)
  - LatLng
```
public LatLng(double latitude,
              double longitude)
```
    Constructing a LatLng value object, and normalizing the degrees for latitude and longitude using default earth radius of 6371 Km and height of 0 Km.
    
    Parameters:
    
    latitude - the latitude degrees, which will be normalized.
    
    longitude - the longitude degrees, which will be normalized.
    
    See Also:
    
    DEFAULT_EARTH_RADIUS_IN_KM, GeoUtils, GeoUtils.normalizeLatitudeDegrees(double), GeoUtils.normalizeLongitudeDegrees(double)
  - LatLng
```
public LatLng(LatLng other)
       throws NullPointerException
```
    Constructs a LatLng value on the basis of another LatLng instance.
    
    Parameters:
    
    other - another LatLng instance.
    
    Throws:
    
    NullPointerException - if other is null.
  - LatLng
```
public LatLng(Point2D other)
       throws NullPointerException
```
    Constructs an LatLng instance on the basis of dk.heick.properties.types.customPoint2D.
    
    Parameters:
    
    other - a instance of dk.heick.properties.types.customPoint2D.
    
    Throws:
    
    NullPointerException - if other is null.
  - LatLng
```
public LatLng(Point other)
       throws NullPointerException
```
    Constructs an LatLng instance on the basis of java.awt.Point.
    
    Parameters:
    
    other - a instance of java.awt.Point.
    
    Throws:
    
    NullPointerException - if other is null.
  - LatLng
```
public LatLng(Point2D.Double other)
       throws NullPointerException
```
    Constructs an LatLng instance on the basis of java.awt.geom.Point2D.Double.
    
    Parameters:
    
    other - a instance of java.awt.geom.Point2D.Double.
    
    Throws:
    
    NullPointerException - if other is null.
- Method Detail
  - parse
```
public static LatLng parse(String value)
                    throws ParseException
```
    Parse a strnig value to a LatLng object, this can parse pretty must any format. See documentation in (GeoUtils.parseLatLng(String)).
    
    Parameters:
    
    value - the string value of LatLng.
    
    Returns:
    
    the instance of LatLng if it parsed, otherwise an exception is thrown.
    
    Throws:
    
    ParseException - if the value could not be parsed.
    
    See Also:
    
    GeoUtils.parseLatLng(String)
  - getHeight
```
public Double getHeight()
```
    The height over the earths surface in Km
    
    Returns:
    
    the height
  - getLatitude
```
public Double getLatitude()
```
    Gets the latitude in degrees
    
    Returns:
    
    the latitude
  - getLongitude
```
public Double getLongitude()
```
    Gets the longitude in degrees
    
    Returns:
    
    the longitude
  - getRadius
```
public Double getRadius()
```
    The earth radius in Km
    
    Returns:
    
    the radius
  - getLatitudeRadians
```
public Double getLatitudeRadians()
```
    Gets the latitude in radians.
    
    Returns:
    
    the latitude in degrees
    
    See Also:
    
    Math.toRadians(double)
  - getLongitudeRadians
```
public Double getLongitudeRadians()
```
    Gets the longitude in radians.
    
    Returns:
    
    the longitude in radians.
    
    See Also:
    
    Math.toRadians(double)
  - toDMSString
```
public String toDMSString(LatLngFormat format,
                          Integer dp)
```
    Returns a string representation of 'this' point, formatted as degrees, degrees+minutes, or degrees+minutes+seconds.
    
    Parameters:
    
    format - [format=dms] - Format point as 'd', 'dm', 'dms'.
    
    dp - [dp=0|2|4] - Number of decimal places to use - default 0 for dms, 2 for dm, 4 for d.
    
    Returns:
    
    Comma-separated latitude/longitude.
  - toDMSString
```
public String toDMSString(LatLngFormat format)
```
  - toDMSString
```
public String toDMSString()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getAsPoint2D
```
public Point2D getAsPoint2D()
```
    Returns a instance of dk.heick.properties.types.customPoint2D where X is latitude and Y is longitude
    
    Returns:
    
    a Point2D instance.
  - equals
```
public boolean equals(Object obj)
```
    Determines if this LatLng is equals with either another LatLng.
    Using the PropertyFrameworkGlobals.getDoublePrecision() Double comparator delta.
    
    Overrides:
    
    equals in class Object
    
    See Also:
    
    equals(Object, double), {@inheritDoc}
  - equals
```
public boolean equals(Object obj,
                      double precision)
```
    Compares an other object with this.
    
    Parameters:
    
    obj - the other object
    
    precision - the precesion at shall compare the doubles values with.
    
    Returns:
    
    false if obj is null or not of type LatLng. Otherwise it compare the values from LatLng and returns if delta of both values are below precision.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getDistanceBetweenPoints
```
public double getDistanceBetweenPoints(LatLng pointTo)
```
    See Also:
    
    GeoUtils.getDistanceBetweenPoints(LatLng, LatLng)
  - getBearingTo
```
public double getBearingTo(LatLng toPoint)
```
    See Also:
    
    GeoUtils.getBearingTo(LatLng, LatLng)
  - getFinalBearingTo
```
public double getFinalBearingTo(LatLng toPoint)
```
    See Also:
    
    GeoUtils.getFinalBearingTo(LatLng, LatLng)
  - getMidPointTo
```
public LatLng getMidPointTo(LatLng toPoint)
```
    See Also:
    
    GeoUtils.getMidPointTo(LatLng, LatLng)
  - getDestinationPoint
```
public LatLng getDestinationPoint(double bearing,
                                  double distance)
```
    See Also:
    
    GeoUtils.getDestinationPoint(LatLng, double, double)
  - getIntersection
```
public LatLng getIntersection(double firstIntialBearing,
                              LatLng toPoint,
                              double secondIntialBearing)
```
    See Also:
    
    GeoUtils.getIntersection(LatLng, double, LatLng, double)
  - getRHumbDistanceTo
```
public double getRHumbDistanceTo(LatLng toPoint)
```
    See Also:
    
    GeoUtils.getRHumbDistanceTo(LatLng, LatLng)
  - getRHumbBearingTo
```
public double getRHumbBearingTo(LatLng toPoint)
```
    See Also:
    
    GeoUtils.getRHumbBearingTo(LatLng, LatLng)
  - getRHumbDestinationPoint
```
public LatLng getRHumbDestinationPoint(double bearing,
                                       double distance)
```
    See Also:
    
    GeoUtils.getRHumbDestinationPoint(LatLng, double, double)
  - getRHumbMidpointTo
```
public LatLng getRHumbMidpointTo(LatLng toPoint)
```
    See Also:
    
    GeoUtils.getRHumbMidpointTo(LatLng, LatLng)
  - toBearing
```
public static String toBearing(Double degrees,
                               LatLngFormat format,
                               Integer dp)
```
    See Also:
    
    GeoUtils.toBearing(Double, LatLngFormat)

Class LatLng

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_EARTH_RADIUS_IN_KM

Constructor Detail

LatLng

LatLng

LatLng

LatLng

LatLng

LatLng

LatLng

Method Detail

parse

getHeight

getLatitude

getLongitude

getRadius

getLatitudeRadians

getLongitudeRadians

toDMSString

toDMSString

toDMSString

toString

getAsPoint2D

equals

equals

hashCode

getDistanceBetweenPoints

getBearingTo

getFinalBearingTo

getMidPointTo

getDestinationPoint

getIntersection

getRHumbDistanceTo

getRHumbBearingTo

getRHumbDestinationPoint

getRHumbMidpointTo

toBearing