net.sf.marineapi.nmea.util

Class Waypoint

java.lang.Object

net.sf.marineapi.nmea.util.Position

net.sf.marineapi.nmea.util.Waypoint

public class Waypoint
extends Position

Waypoint represents a named geographic location.

Author:

Kimmo Tuukkanen

See Also:

Position

Constructor Summary

Constructors

Constructor and Description
Waypoint(String id, double lat, double lon) Creates a new instance of Waypoint with default WGS84 datum.
Waypoint(String id, double lat, double lon, Datum datum) Creates a new instance of Waypoint with explicitly specified datum.
Waypoint(String id, double lat, double lon, double alt) Creates a new instance of Waypoint with default WGS84 datum.
Waypoint(String id, double lat, double lon, double alt, Datum datum) Creates a new instance of Waypoint with explicitly specified datum.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the waypoint description/comment.
String	getId() Get id of Waypoint
Date	getTimeStamp() Returns the time stamp when Waypoint was created.
void	setDescription(String description) Sets the waypoint description.
void	setId(String id) Set the id of Waypoint

Methods inherited from class net.sf.marineapi.nmea.util.Position

distanceTo, getAltitude, getDatum, getLatitude, getLatitudeHemisphere, getLongitude, getLongitudeHemisphere, isLatitudeNorth, isLongitudeEast, setAltitude, setLatitude, setLongitude, toString, toWaypoint

Methods inherited from class java.lang.Object

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

Constructor Detail

Waypoint

public Waypoint(String id,
                double lat,
                double lon)

Creates a new instance of Waypoint with default WGS84 datum.

Parameters:

id - Waypoint identifier

lat - Latitude degrees of the waypoint location

lon - Longitude degrees of waypoint location

Waypoint

public Waypoint(String id,
                double lat,
                double lon,
                double alt)

Creates a new instance of Waypoint with default WGS84 datum.

Parameters:

id - Waypoint identifier

lat - Latitude degrees of the waypoint location

lon - Longitude degrees of waypoint location

alt - Altitude value, in meters above/below mean sea level

Waypoint

public Waypoint(String id,
                double lat,
                double lon,
                Datum datum)

Creates a new instance of Waypoint with explicitly specified datum.

Parameters:

id - Waypoint identifier

lat - Latitude degrees of the waypoint location

lon - Longitude degrees of waypoint location

datum - Position datum, i.e. the coordinate system.

Waypoint

public Waypoint(String id,
                double lat,
                double lon,
                double alt,
                Datum datum)

Creates a new instance of Waypoint with explicitly specified datum.

Parameters:

id - Waypoint identifier/name

lat - Latitude degrees of the waypoint location

lon - Longitude degrees of waypoint location

alt - Altitude value, in meters above/below mean sea level

datum - Position datum, i.e. the coordinate system.

Method Detail

getDescription

public String getDescription()

Gets the waypoint description/comment.

Returns:

the description

getId

public String getId()

Get id of Waypoint

Returns:

id

getTimeStamp

public Date getTimeStamp()

Returns the time stamp when Waypoint was created.

Returns:

Date

setDescription

public void setDescription(String description)

Sets the waypoint description.

Parameters:

description - the description to set

setId

public void setId(String id)

Set the id of Waypoint

Parameters:

id - the id to set