com.etherios.connector.core.system

Class Location

java.lang.Object

com.etherios.connector.core.system.Location

public class Location
extends java.lang.Object

This class represents a GPS location with longitude, latitude and altitude values.

Constructor Summary

Constructors

Constructor and Description
Location(java.lang.String latitude, java.lang.String longitude) Class constructor.
Location(java.lang.String latitude, java.lang.String longitude, java.lang.String elevation) Class constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getElevation() Retrieves the location elevation.
java.lang.String	getLatitude() Retrieves the location latitude.
java.lang.String	getLongitude() Retrieves the location longitude.
boolean	isCurrent() Retrieves whether this location is the current one or not.
void	setCurrent(boolean isCurrent) Sets whether this location is the current or not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Location

public Location(java.lang.String latitude,
                java.lang.String longitude)

Class constructor. Instances a new Location object with the given latitude and longitude (the elevation is considered 0).

Parameters:

latitude - Location latitude.

longitude - Location longitude.

Throws:

java.lang.IllegalArgumentException - if latitude == null or if longitude == null or if any of the provided values is an invalid value.

Location

public Location(java.lang.String latitude,
                java.lang.String longitude,
                java.lang.String elevation)

Class constructor. Instances a new Location object with the given latitude, longitude and altitude.

Parameters:

latitude - Location latitude.

longitude - Location longitude.

elevation - Location elevation.

Throws:

java.lang.IllegalArgumentException - if latitude == null or if longitude == null or if elevation == null or if any of the provided values is an invalid value.

Method Detail

getElevation

public java.lang.String getElevation()

Retrieves the location elevation.

Returns:

The location elevation.

getLatitude

public java.lang.String getLatitude()

Retrieves the location latitude.

Returns:

The location latitude.

getLongitude

public java.lang.String getLongitude()

Retrieves the location longitude.

Returns:

The location longitude.

isCurrent

public boolean isCurrent()

Retrieves whether this location is the current one or not.

Returns:

True if the location is the current one, false otherwise.

setCurrent

public void setCurrent(boolean isCurrent)

Sets whether this location is the current or not.

Parameters:

isCurrent - True if the location is the current one, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object