com.tomtom.online.sdk.common.location

Class LatLng

java.lang.Object

com.tomtom.online.sdk.common.location.LatLng

All Implemented Interfaces:

java.io.Serializable

public class LatLng
extends java.lang.Object
implements java.io.Serializable

Represents the information about the coordinates (latitude, longitude). It has additional data: bearing and radius.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LatLng(double latitude, double longitude) Instantiates a new LatLng object with provided latitude and longitude.
LatLng(double latitude, double longitude, double altitude) Instantiates a new LatLng object with provided latitude, longitude and altitude.
LatLng(double latitude, double longitude, float bearing) Instantiates a new LatLng object with provided latitude, longitude and bearing.
LatLng(double latitude, double longitude, int radius) Instantiates a new LatLng object with provided latitude, longitude and radius.
LatLng(double latitude, double longitude, int radius, float bearing) Instantiates a new LatLng object with provided latitude, longitude, radius and bearing.
LatLng(android.location.Location location) Instantiates a new LatLng object based on data from Location object.

Method Summary

Modifier and Type	Method and Description
Optional<java.lang.Double>	getAltitude() Get the altitude.
double	getBearing()
double	getLatitude()
java.lang.String	getLatitudeAsString()
double	getLongitude()
java.lang.String	getLongitudeAsString()
float	getRadius()
double	greatCircleDistanceTo(LatLng other) Calculate the great-circle distance between two points.
boolean	hasRadius()
boolean	isNear(LatLng that) Check if two locations are near each other (almost equal).
boolean	isNear(LatLng that, double tolerance) Check if two locations are near each other (almost equal within given tolerance).
static double[]	toArrayCoordinateSystem(java.util.List<LatLng> locations) Transforms a list of LatLng locations into an array of double values, ignoring altitude, radius and bearing.
java.lang.String	toSimplerString() Formatted string representation of the LatLng object in simpler way.
java.lang.String	toSimpleString() Formatted string representation of the LatLng object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LatLng

public LatLng(double latitude,
              double longitude)

Instantiates a new LatLng object with provided latitude and longitude. Bearing and radius are set to 0. Altitude is undefined.

Parameters:

latitude - latitude value

longitude - longitude value

LatLng

public LatLng(double latitude,
              double longitude,
              double altitude)

Instantiates a new LatLng object with provided latitude, longitude and altitude. Bearing and radius are set to 0.

Parameters:

latitude - latitude value

longitude - longitude value

altitude - altitude value

LatLng

public LatLng(@NonNull
              android.location.Location location)

Instantiates a new LatLng object based on data from Location object.

Parameters:

location - a Location object

LatLng

public LatLng(double latitude,
              double longitude,
              int radius)

Instantiates a new LatLng object with provided latitude, longitude and radius. Bearing is set to 0. Altitude is undefined.

Parameters:

latitude - latitude value

longitude - longitude value

radius - radius value

LatLng

public LatLng(double latitude,
              double longitude,
              float bearing)

Instantiates a new LatLng object with provided latitude, longitude and bearing. Radius is set to 0. Altitude is undefined.

Parameters:

latitude - latitude value

longitude - longitude value

bearing - bearing value

LatLng

public LatLng(double latitude,
              double longitude,
              int radius,
              float bearing)

Instantiates a new LatLng object with provided latitude, longitude, radius and bearing. Altitude is undefined.

Parameters:

latitude - the latitude part of the coordinates

longitude - the longitude part of the coordinates

radius - the radius

bearing - the bearing

Method Detail

getLongitude

public double getLongitude()

getLatitude

public double getLatitude()

getBearing

public double getBearing()

getRadius

public float getRadius()

hasRadius

public boolean hasRadius()

getAltitude

public Optional<java.lang.Double> getAltitude()

Get the altitude.

Returns:

the altitude

isNear

public boolean isNear(LatLng that)

Check if two locations are near each other (almost equal).

Parameters:

that - the other location

Returns:

near or not near

isNear

public boolean isNear(LatLng that,
                      double tolerance)

Check if two locations are near each other (almost equal within given tolerance).

Parameters:

that - the other location

tolerance - criteria for coordinate equality

Returns:

near or not near

toSimpleString

public java.lang.String toSimpleString()

Formatted string representation of the LatLng object.

Returns:

the textual representation of the coordinates

toSimplerString

public java.lang.String toSimplerString()

Formatted string representation of the LatLng object in simpler way.

Returns:

the textual representation of the coordinates

greatCircleDistanceTo

public double greatCircleDistanceTo(LatLng other)

Calculate the great-circle distance between two points. See: http://www.movable-type.co.uk/scripts/latlong.html

Parameters:

other - location

Returns:

distance in meters.

toArrayCoordinateSystem

public static double[] toArrayCoordinateSystem(java.util.List<LatLng> locations)

Transforms a list of LatLng locations into an array of double values, ignoring altitude, radius and bearing. Latitude of location at index n is located at index n*2 in the resulting array. Longitude of location at index n is located at index n*2+1 in the resulting array.

Parameters:

locations - list of LatLng locations

Returns:

flattened coordinates array

getLongitudeAsString

public java.lang.String getLongitudeAsString()

getLatitudeAsString

public java.lang.String getLatitudeAsString()