com.codename1.location

Class Location

java.lang.Object

com.codename1.location.Location

public class Location
extends Object

Represents a position and possible velocity returned from positioning API's. This class is used both by foreground and background location for the purposes of both conveying the users location and conveying a desired location e.g. in the case of geofencing where we can define a location that would trigger the callback.

Trivial one time usage of location data can look like this sample:

You can also track location in the foreground using API calls like this:

The sample below demonstrates the usage of the background geofencing API:

Constructor Summary

Constructors

Constructor and Description
Location()
Location(double latitude, double longitude)
Location(double latitude, double longitude, double altitude, float direction)

Method Summary

Modifier and Type	Method and Description
Comparator<Location>	createDistanceCompartor() Creates a comparator for sorting locations in order of increasing distance from the current location.
float	getAccuracy() Returns the horizontal accuracy of the location in meters
double	getAltitude() Returns the altitude of this Location
float	getDirection() Returns the direction of this Location in degress 0-360
double	getDistanceTo(Location l2) Gets the distance in metres from the current location to another location.
double	getLatitude() Returns the latitude of this Location
double	getLongitude() Returns the longitude of this Location
double	getLongtitude() Deprecated. use getLongitude
int	getStatus() The status of the location one of: LocationManager.AVAILABLE, LocationManager.OUT_OF_SERVICE or LocationManager.TEMPORARILY_UNAVAILABLE:
long	getTimeStamp() Returns the timestamp of this Location
float	getVelocity() Returns the velocity of this Location in meters per second (m/s)
void	setAccuracy(float accuracy)
void	setAltitude(double altitude) Sets the altitude of this Location
void	setDirection(float direction) Sets the direction of this Location
void	setLatitude(double latitude) Sets the latitude of this Location
void	setLongitude(double longtitude) Sets the longitude of this Location
void	setLongtitude(double longtitude) Deprecated. use setLongitude
void	setStatus(int status) The status of the location one of: LocationProvider.AVAILABLE, LocationProvider.OUT_OF_SERVICE or LocationProvider.TEMPORARILY_UNAVAILABLE:
void	setTimeStamp(long timeStamp) Sets the timeStamp of this Location
void	setVelocity(float velocity) Sets the velocity of this Location
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Location

public Location()

Location

public Location(double latitude,
                double longitude,
                double altitude,
                float direction)

Location

public Location(double latitude,
                double longitude)

Method Detail

getAccuracy

public float getAccuracy()

Returns the horizontal accuracy of the location in meters

Returns:

the accuracy if exists or 0.0 if not.

getAltitude

public double getAltitude()

Returns the altitude of this Location

Returns:

altitude

getDirection

public float getDirection()

Returns the direction of this Location in degress 0-360

Returns:

direction in degrees

getLatitude

public double getLatitude()

Returns the latitude of this Location

Returns:

latitude

getLongitude

public double getLongitude()

Returns the longitude of this Location

Returns:

longitude

getLongtitude

public double getLongtitude()

Deprecated. use getLongitude

Returns the longitude of this Location

Returns:

longitude

getStatus

public int getStatus()

The status of the location one of: LocationManager.AVAILABLE, LocationManager.OUT_OF_SERVICE or LocationManager.TEMPORARILY_UNAVAILABLE:

getTimeStamp

public long getTimeStamp()

Returns the timestamp of this Location

Returns:

timestamp

getVelocity

public float getVelocity()

Returns the velocity of this Location in meters per second (m/s)

Returns:

velocity

setAccuracy

public void setAccuracy(float accuracy)

setAltitude

public void setAltitude(double altitude)

Sets the altitude of this Location

Parameters:

altitude -

setDirection

public void setDirection(float direction)

Sets the direction of this Location

Parameters:

direction -

setLatitude

public void setLatitude(double latitude)

Sets the latitude of this Location

Parameters:

latitude -

setLongitude

public void setLongitude(double longtitude)

Sets the longitude of this Location

Parameters:

longitude -

setLongtitude

public void setLongtitude(double longtitude)

Deprecated. use setLongitude

Sets the longitude of this Location

Parameters:

longitude -

setStatus

public void setStatus(int status)

The status of the location one of: LocationProvider.AVAILABLE, LocationProvider.OUT_OF_SERVICE or LocationProvider.TEMPORARILY_UNAVAILABLE:

setTimeStamp

public void setTimeStamp(long timeStamp)

Sets the timeStamp of this Location

Parameters:

timeStamp -

setVelocity

public void setVelocity(float velocity)

Sets the velocity of this Location

Parameters:

velocity -

getDistanceTo

public double getDistanceTo(Location l2)

Gets the distance in metres from the current location to another location.

Parameters:

l2 - The location to measure distance to.

Returns:

The number of metres between the current location and l2.

toString

public String toString()

Overrides:

toString in class Object

createDistanceCompartor

public Comparator<Location> createDistanceCompartor()

Creates a comparator for sorting locations in order of increasing distance from the current location.

Returns: