WayPoint (JPX 1.2.0)

java.lang.Object
- io.jenetics.jpx.WayPoint

All Implemented Interfaces:

Point, Serializable
```
public final class WayPoint
extends Object
implements Point, Serializable
```
A WayPoint represents a way-point, point of interest, or named feature on a map.
Creating a WayPoint:
```
 final WayPoint point = WayPoint.builder()
     .lat(48.2081743).lon(16.3738189).ele(160)
     .build();
 
```
Since:

1.0

Version:

1.1

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WayPoint.Builder
Builder for creating a way-point with different parameters.

Nested Classes
Modifier and Type	Class and Description
`static class`	`WayPoint.Builder` Builder for creating a way-point with different parameters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static WayPoint.Builder`	`builder()` Return a new `WayPoint` builder.
`boolean`	`equals(Object obj)`
`Optional<Duration>`	`getAgeOfGPSData()` Return the number of seconds since last DGPS update.
`Optional<String>`	`getComment()` The GPS way-point comment.
`Optional<String>`	`getDescription()` Return a text description of the element.
`Optional<DGPSStation>`	`getDGPSID()` Return the ID of DGPS station used in differential correction.
`Optional<Length>`	`getElevation()` The elevation (in meters) of the point.
`Optional<Fix>`	`getFix()` Return the type of GPX fix.
`Optional<Length>`	`getGeoidHeight()` The height (in meters) of geoid (mean sea level) above WGS84 earth ellipsoid.
`Optional<Double>`	`getHdop()` Return the horizontal dilution of precision.
`Latitude`	`getLatitude()` The latitude of the point, WGS84 datum.
`List<Link>`	`getLinks()` Return the links to additional information about the way-point.
`Longitude`	`getLongitude()` The longitude of the point, WGS84 datum.
`Optional<Degrees>`	`getMagneticVariation()` The magnetic variation at the point.
`Optional<String>`	`getName()` The GPS name of the way-point.
`Optional<Double>`	`getPdop()` Return the position dilution of precision.
`Optional<UInt>`	`getSat()` Return the number of satellites used to calculate the GPX fix.
`Optional<String>`	`getSource()` Return the source of data.
`Optional<Speed>`	`getSpeed()` The current GPS speed.
`Optional<String>`	`getSymbol()` Return the text of GPS symbol name.
`Optional<ZonedDateTime>`	`getTime()` Creation/modification timestamp for the point.
`Optional<String>`	`getType()` Return the type (classification) of the way-point.
`Optional<Double>`	`getVdop()` Return the vertical dilution of precision.
`int`	`hashCode()`
`static WayPoint`	`of(double latitudeDegree, double longitudeDegree)` Create a new `WayPoint` with the given `latitude` and `longitude` value.
`static WayPoint`	`of(double latitudeDegree, double longitudeDegree, double elevationMeter, long timeEpochMilli)` Create a new `WayPoint` with the given parameters.
`static WayPoint`	`of(double latitudeDegree, double longitudeDegree, long timeEpochMilli)` Create a new `WayPoint` with the given parameters.
`static WayPoint`	`of(Latitude latitude, Longitude longitude)` Create a new `WayPoint` with the given `latitude` and `longitude` value.
`static WayPoint`	`of(Latitude latitude, Longitude longitude, Length elevation, Speed speed, ZonedDateTime time, Degrees magneticVariation, Length geoidHeight, String name, String comment, String description, String source, List<Link> links, String symbol, String type, Fix fix, UInt sat, Double hdop, Double vdop, Double pdop, Duration ageOfGPSData, DGPSStation dgpsID)` Create a new way-point with the given parameter.
`static WayPoint`	`of(Latitude latitude, Longitude longitude, Length elevation, ZonedDateTime time)` Create a new `WayPoint` with the given parameters.
`static WayPoint`	`of(Latitude latitude, Longitude longitude, ZonedDateTime time)` Create a new `WayPoint` with the given parameters.
`WayPoint.Builder`	`toBuilder()` Convert the immutable way-point object into a mutable builder initialized with the current way-point values.
`String`	`toString()`

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

Methods inherited from interface io.jenetics.jpx.Point
distance

- Method Detail
  - getLatitude
```
public Latitude getLatitude()
```
    Description copied from interface: Point
    
    The latitude of the point, WGS84 datum.
    
    Specified by:
    
    getLatitude in interface Point
    
    Returns:
    
    the latitude of the point
  - getLongitude
```
public Longitude getLongitude()
```
    Description copied from interface: Point
    
    The longitude of the point, WGS84 datum.
    
    Specified by:
    
    getLongitude in interface Point
    
    Returns:
    
    the longitude of the point
  - getElevation
```
public Optional<Length> getElevation()
```
    Description copied from interface: Point
    
    The elevation (in meters) of the point.
    
    Specified by:
    
    getElevation in interface Point
    
    Returns:
    
    the elevation (in meters) of the point
  - getSpeed
```
public Optional<Speed> getSpeed()
```
    The current GPS speed.
    
    Returns:
    
    the current GPS speed
  - getTime
```
public Optional<ZonedDateTime> getTime()
```
    Description copied from interface: Point
    
    Creation/modification timestamp for the point.
    
    Specified by:
    
    getTime in interface Point
    
    Returns:
    
    creation/modification timestamp for the point
  - getMagneticVariation
```
public Optional<Degrees> getMagneticVariation()
```
    The magnetic variation at the point.
    
    Returns:
    
    the magnetic variation at the point
  - getGeoidHeight
```
public Optional<Length> getGeoidHeight()
```
    The height (in meters) of geoid (mean sea level) above WGS84 earth ellipsoid. As defined in NMEA GGA message.
    
    Returns:
    
    the height (in meters) of geoid (mean sea level) above WGS84 earth ellipsoid
  - getName
```
public Optional<String> getName()
```
    The GPS name of the way-point. This field will be transferred to and from the GPS. GPX does not place restrictions on the length of this field or the characters contained in it. It is up to the receiving application to validate the field before sending it to the GPS.
    
    Returns:
    
    the GPS name of the way-point
  - getComment
```
public Optional<String> getComment()
```
    The GPS way-point comment.
    
    Returns:
    
    the GPS way-point comment
  - getDescription
```
public Optional<String> getDescription()
```
    Return a text description of the element. Holds additional information about the element intended for the user, not the GPS.
    
    Returns:
    
    a text description of the element
  - getSource
```
public Optional<String> getSource()
```
    Return the source of data. Included to give user some idea of reliability and accuracy of data. "Garmin eTrex", "USGS quad Boston North", e.g.
    
    Returns:
    
    the source of the data
  - getLinks
```
public List<Link> getLinks()
```
    Return the links to additional information about the way-point.
    
    Returns:
    
    the links to additional information about the way-point
  - getSymbol
```
public Optional<String> getSymbol()
```
    Return the text of GPS symbol name. For interchange with other programs, use the exact spelling of the symbol as displayed on the GPS. If the GPS abbreviates words, spell them out.
    
    Returns:
    
    the text of GPS symbol name
  - getType
```
public Optional<String> getType()
```
    Return the type (classification) of the way-point.
    
    Returns:
    
    the type (classification) of the way-point
  - getFix
```
public Optional<Fix> getFix()
```
    Return the type of GPX fix.
    
    Returns:
    
    the type of GPX fix
  - getSat
```
public Optional<UInt> getSat()
```
    Return the number of satellites used to calculate the GPX fix.
    
    Returns:
    
    the number of satellites used to calculate the GPX fix
  - getHdop
```
public Optional<Double> getHdop()
```
    Return the horizontal dilution of precision.
    
    Returns:
    
    the horizontal dilution of precision
  - getVdop
```
public Optional<Double> getVdop()
```
    Return the vertical dilution of precision.
    
    Returns:
    
    the vertical dilution of precision
  - getPdop
```
public Optional<Double> getPdop()
```
    Return the position dilution of precision.
    
    Returns:
    
    the position dilution of precision
  - getAgeOfGPSData
```
public Optional<Duration> getAgeOfGPSData()
```
    Return the number of seconds since last DGPS update.
    
    Returns:
    
    number of seconds since last DGPS update
  - getDGPSID
```
public Optional<DGPSStation> getDGPSID()
```
    Return the ID of DGPS station used in differential correction.
    
    Returns:
    
    the ID of DGPS station used in differential correction
  - toBuilder
```
public WayPoint.Builder toBuilder()
```
    Convert the immutable way-point object into a mutable builder initialized with the current way-point values.
    
    Returns:
    
    a new way-point builder initialized with the values of this way-point
    
    Since:
    
    1.1
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - builder
```
public static WayPoint.Builder builder()
```
    Return a new WayPoint builder.
    
    Returns:
    
    a new WayPoint builder
  - of
```
public static WayPoint of(Latitude latitude,
                          Longitude longitude)
```
    Create a new WayPoint with the given latitude and longitude value.
    
    Parameters:
    
    latitude - the latitude of the point
    
    longitude - the longitude of the point
    
    Returns:
    
    a new WayPoint
    
    Throws:
    
    NullPointerException - if one of the given arguments is null
  - of
```
public static WayPoint of(double latitudeDegree,
                          double longitudeDegree)
```
    Create a new WayPoint with the given latitude and longitude value.
    
    Parameters:
    
    latitudeDegree - the latitude of the point
    
    longitudeDegree - the longitude of the point
    
    Returns:
    
    a new WayPoint
    
    Throws:
    
    IllegalArgumentException - if the given latitude or longitude is not in the valid range.
  - of
```
public static WayPoint of(Latitude latitude,
                          Longitude longitude,
                          ZonedDateTime time)
```
    Create a new WayPoint with the given parameters.
    
    Parameters:
    
    latitude - the latitude of the point
    
    longitude - the longitude of the point
    
    time - the timestamp of the way-point
    
    Returns:
    
    a new WayPoint
    
    Throws:
    
    NullPointerException - if one of the given arguments is null
  - of
```
public static WayPoint of(double latitudeDegree,
                          double longitudeDegree,
                          long timeEpochMilli)
```
    Create a new WayPoint with the given parameters.
    
    Parameters:
    
    latitudeDegree - the latitude of the point
    
    longitudeDegree - the longitude of the point
    
    timeEpochMilli - the timestamp of the way-point
    
    Returns:
    
    a new WayPoint
    
    Throws:
    
    NullPointerException - if one of the given arguments is null
  - of
```
public static WayPoint of(Latitude latitude,
                          Longitude longitude,
                          Length elevation,
                          ZonedDateTime time)
```
    Create a new WayPoint with the given parameters.
    
    Parameters:
    
    latitude - the latitude of the point
    
    longitude - the longitude of the point
    
    elevation - the elevation of the point
    
    time - the timestamp of the way-point
    
    Returns:
    
    a new WayPoint
    
    Throws:
    
    NullPointerException - if one of the given arguments is null
  - of
```
public static WayPoint of(double latitudeDegree,
                          double longitudeDegree,
                          double elevationMeter,
                          long timeEpochMilli)
```
    Create a new WayPoint with the given parameters.
    
    Parameters:
    
    latitudeDegree - the latitude of the point
    
    longitudeDegree - the longitude of the point
    
    elevationMeter - the elevation of the point
    
    timeEpochMilli - the timestamp of the way-point
    
    Returns:
    
    a new WayPoint
    
    Throws:
    
    NullPointerException - if one of the given arguments is null
  - of
```
public static WayPoint of(Latitude latitude,
                          Longitude longitude,
                          Length elevation,
                          Speed speed,
                          ZonedDateTime time,
                          Degrees magneticVariation,
                          Length geoidHeight,
                          String name,
                          String comment,
                          String description,
                          String source,
                          List<Link> links,
                          String symbol,
                          String type,
                          Fix fix,
                          UInt sat,
                          Double hdop,
                          Double vdop,
                          Double pdop,
                          Duration ageOfGPSData,
                          DGPSStation dgpsID)
```
    Create a new way-point with the given parameter.
    
    Parameters:
    
    latitude - the latitude of the point, WGS84 datum (mandatory)
    
    longitude - the longitude of the point, WGS84 datum (mandatory)
    
    elevation - the elevation (in meters) of the point (optional)
    
    speed - the current GPS speed (optional)
    
    time - creation/modification timestamp for element. Conforms to ISO 8601 specification for date/time representation. Fractional seconds are allowed for millisecond timing in tracklogs. (optional)
    
    magneticVariation - the magnetic variation at the point (optional)
    
    geoidHeight - height (in meters) of geoid (mean sea level) above WGS84 earth ellipsoid. As defined in NMEA GGA message. (optional)
    
    name - the GPS name of the way-point. This field will be transferred to and from the GPS. GPX does not place restrictions on the length of this field or the characters contained in it. It is up to the receiving application to validate the field before sending it to the GPS. (optional)
    
    comment - GPS way-point comment. Sent to GPS as comment (optional)
    
    description - a text description of the element. Holds additional information about the element intended for the user, not the GPS. (optional)
    
    source - source of data. Included to give user some idea of reliability and accuracy of data. "Garmin eTrex", "USGS quad Boston North", e.g. (optional)
    
    links - links to additional information about the way-point. May be empty, but not null.
    
    symbol - text of GPS symbol name. For interchange with other programs, use the exact spelling of the symbol as displayed on the GPS. If the GPS abbreviates words, spell them out. (optional)
    
    type - type (classification) of the way-point (optional)
    
    fix - type of GPX fix (optional)
    
    sat - number of satellites used to calculate the GPX fix (optional)
    
    hdop - horizontal dilution of precision (optional)
    
    vdop - vertical dilution of precision (optional)
    
    pdop - position dilution of precision. (optional)
    
    ageOfGPSData - number of seconds since last DGPS update (optional)
    
    dgpsID - ID of DGPS station used in differential correction (optional)
    
    Returns:
    
    a new WayPoint
    
    Throws:
    
    NullPointerException - if the latitude or longitude is null

Class WayPoint

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.jenetics.jpx.Point

Method Detail

getLatitude

getLongitude

getElevation

getSpeed

getTime

getMagneticVariation

getGeoidHeight

getName

getComment

getDescription

getSource

getLinks

getSymbol

getType

getFix

getSat

getHdop

getVdop

getPdop

getAgeOfGPSData

getDGPSID

toBuilder

hashCode

equals

toString

builder

of

of

of

of

of

of

of