WayPoint (JOSM)

java.lang.Object
- org.openstreetmap.josm.data.gpx.WithAttributes
- - org.openstreetmap.josm.data.gpx.WayPoint

All Implemented Interfaces:

java.lang.Comparable<WayPoint>, ILatLon, GpxConstants, IWithAttributes, TemplateEngineDataProvider
```
public class WayPoint
extends WithAttributes
implements java.lang.Comparable<WayPoint>, TemplateEngineDataProvider, ILatLon
```
A point in the GPX data

Since:

12167 implements ILatLon

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`WayPoint.LegacyMap` Interim to detect legacy code that is not using `WayPoint.setTime(x)` functions, but `attr.put(PT_TIME, (String) x)` logic.

Field Summary

Fields
Modifier and Type	Field and Description
`java.awt.Color`	`customColoring` The color to draw the segment before this point in
`int`	`dir` The direction of the line before this point.
`boolean`	`drawLine` `true` indicates that the line before this point should be drawn
`private double`	`east`
`private java.lang.Object`	`eastNorthCacheKey`
`private double`	`lat`
`private double`	`lon`
`private double`	`north`

Fields inherited from class org.openstreetmap.josm.data.gpx.WithAttributes
attr

Fields inherited from interface org.openstreetmap.josm.data.gpx.GpxConstants
FIX_VALUES, GPX_CMT, GPX_DESC, GPX_NAME, GPX_SRC, JOSM_EXTENSIONS_NAMESPACE_URI, META_AUTHOR_EMAIL, META_AUTHOR_LINK, META_AUTHOR_NAME, META_BOUNDS, META_COPYRIGHT_AUTHOR, META_COPYRIGHT_LICENSE, META_COPYRIGHT_YEAR, META_DESC, META_EXTENSIONS, META_KEYWORDS, META_LINKS, META_NAME, META_PREFIX, META_TIME, PT_AGEOFDGPSDATA, PT_DGPSID, PT_ELE, PT_FIX, PT_GEOIDHEIGHT, PT_HDOP, PT_MAGVAR, PT_PDOP, PT_SAT, PT_SYM, PT_TIME, PT_TYPE, PT_VDOP, RTE_TRK_KEYS, RTKLIB_AGE, RTKLIB_Q, RTKLIB_RATIO, RTKLIB_SDE, RTKLIB_SDEU, RTKLIB_SDN, RTKLIB_SDNE, RTKLIB_SDU, RTKLIB_SDUN, WPT_KEYS

Constructor Summary

Constructors
Constructor and Description

WayPoint(LatLon ll)
Constructs a new WayPoint from lat/lon coordinates.

WayPoint(WayPoint p)
Constructs a new WayPoint from an existing one.

Constructors
Constructor and Description
`WayPoint(LatLon ll)` Constructs a new `WayPoint` from lat/lon coordinates.
`WayPoint(WayPoint p)` Constructs a new `WayPoint` from an existing one.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(WayPoint w)`
`boolean`	`equals(java.lang.Object obj)`
`boolean`	`evaluateCondition(SearchCompiler.Match condition)` Check if a condition holds for the object represented by this `TemplateEngineDataProvider`.
`LatLon`	`getCoor()` Returns the waypoint coordinates.
`java.util.Date`	`getDate()` Returns the waypoint time Date object.
`private java.util.Date`	`getDateImpl()` Returns the waypoint time Date object.
`EastNorth`	`getEastNorth(Projecting projecting)` Replies the projected east/north coordinates.
`java.util.List<java.lang.String>`	`getTemplateKeys()` Get the collection of all keys that can be mapped to values.
`java.lang.Object`	`getTemplateValue(java.lang.String name, boolean special)` Map a key to a value given the properties of the object.
`double`	`getTime()` Returns the waypoint time in seconds since the epoch.
`long`	`getTimeInMillis()` Returns the waypoint time in milliseconds since the epoch.
`boolean`	`hasDate()` Returns true if this waypoint has a time.
`int`	`hashCode()`
`void`	`invalidateEastNorthCache()` Invalidate the internal cache of east/north coordinates.
`double`	`lat()` Returns the latitude, i.e., the north-south position in degrees.
`double`	`lon()` Returns the longitude, i.e., the east-west position in degrees.
`void`	`setTime(java.util.Date time)` Sets the `GpxConstants.PT_TIME` attribute to the specified time.
`void`	`setTime(long ts)` Sets the `GpxConstants.PT_TIME` attribute to the specified time.
`void`	`setTimeInMillis(long ts)` Sets the `GpxConstants.PT_TIME` attribute to the specified time.
`java.lang.String`	`toString()`

Methods inherited from class org.openstreetmap.josm.data.gpx.WithAttributes
addExtension, get, getCollection, getString, put

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

Methods inherited from interface org.openstreetmap.josm.data.coor.ILatLon
isLatLonKnown

- Field Detail
  - customColoring
```
public java.awt.Color customColoring
```
    The color to draw the segment before this point in
    
    See Also:
    
    drawLine
  - drawLine
```
public boolean drawLine
```
    true indicates that the line before this point should be drawn
  - dir
```
public int dir
```
    The direction of the line before this point. Used as cache to speed up drawing. Should not be relied on.
  - lat
```
private final double lat
```
  - lon
```
private final double lon
```
  - east
```
private double east
```
  - north
```
private double north
```
  - eastNorthCacheKey
```
private java.lang.Object eastNorthCacheKey
```
- Constructor Detail
  - WayPoint
```
public WayPoint(WayPoint p)
```
    Constructs a new WayPoint from an existing one. Except for PT_TIME attribute, all attribute objects are shallow copied. This means modification of attr objects will affect original and new WayPoint.
    
    Parameters:
    
    p - existing waypoint
  - WayPoint
```
public WayPoint(LatLon ll)
```
    Constructs a new WayPoint from lat/lon coordinates.
    
    Parameters:
    
    ll - lat/lon coordinates
- Method Detail
  - invalidateEastNorthCache
```
public void invalidateEastNorthCache()
```
    Invalidate the internal cache of east/north coordinates.
  - getCoor
```
public final LatLon getCoor()
```
    Returns the waypoint coordinates.
    
    Returns:
    
    the waypoint coordinates
  - lon
```
public double lon()
```
    Description copied from interface: ILatLon
    
    Returns the longitude, i.e., the east-west position in degrees.
    
    Specified by:
    
    lon in interface ILatLon
    
    Returns:
    
    the longitude or NaN if ILatLon.isLatLonKnown() returns false
  - lat
```
public double lat()
```
    Description copied from interface: ILatLon
    
    Returns the latitude, i.e., the north-south position in degrees.
    
    Specified by:
    
    lat in interface ILatLon
    
    Returns:
    
    the latitude or NaN if ILatLon.isLatLonKnown() returns false
  - getEastNorth
```
public final EastNorth getEastNorth(Projecting projecting)
```
    Description copied from interface: ILatLon
    
    Replies the projected east/north coordinates.
    The result of the last conversion may be cached. Null is returned in case this object is invalid.
    
    Specified by:
    
    getEastNorth in interface ILatLon
    
    Parameters:
    
    projecting - The projection to use.
    
    Returns:
    
    The projected east/north coordinates
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setTime
```
public void setTime(java.util.Date time)
```
    Sets the GpxConstants.PT_TIME attribute to the specified time.
    
    Parameters:
    
    time - the time to set
    
    Since:
    
    9383
  - setTime
```
public void setTime(long ts)
```
    Sets the GpxConstants.PT_TIME attribute to the specified time.
    
    Parameters:
    
    ts - seconds from the epoch
    
    Since:
    
    13210
  - setTimeInMillis
```
public void setTimeInMillis(long ts)
```
    Sets the GpxConstants.PT_TIME attribute to the specified time.
    
    Parameters:
    
    ts - milliseconds from the epoch
    
    Since:
    
    14434
  - compareTo
```
public int compareTo(WayPoint w)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<WayPoint>
  - getTime
```
public double getTime()
```
    Returns the waypoint time in seconds since the epoch.
    
    Returns:
    
    the waypoint time
  - getTimeInMillis
```
public long getTimeInMillis()
```
    Returns the waypoint time in milliseconds since the epoch.
    
    Returns:
    
    the waypoint time
    
    Since:
    
    14456
  - hasDate
```
public boolean hasDate()
```
    Returns true if this waypoint has a time.
    
    Returns:
    
    true if a time is set, false otherwise
    
    Since:
    
    14456
  - getDate
```
public java.util.Date getDate()
```
    Returns the waypoint time Date object.
    
    Returns:
    
    a copy of the Date object associated with this waypoint
    
    Since:
    
    14456
  - getDateImpl
```
private java.util.Date getDateImpl()
```
    Returns the waypoint time Date object.
    
    Returns:
    
    the Date object associated with this waypoint
  - getTemplateValue
```
public java.lang.Object getTemplateValue(java.lang.String name,
                                         boolean special)
```
    Description copied from interface: TemplateEngineDataProvider
    
    Map a key to a value given the properties of the object.
    
    Specified by:
    
    getTemplateValue in interface TemplateEngineDataProvider
    
    Parameters:
    
    name - the key to map
    
    special - if the key is a "special:*" keyword that is used to get certain information or automated behavior
    
    Returns:
    
    a value that the key is mapped to or "special" information in case special is true
  - evaluateCondition
```
public boolean evaluateCondition(SearchCompiler.Match condition)
```
    Description copied from interface: TemplateEngineDataProvider
    
    Check if a condition holds for the object represented by this TemplateEngineDataProvider.
    
    Specified by:
    
    evaluateCondition in interface TemplateEngineDataProvider
    
    Parameters:
    
    condition - the condition to check (which is a search expression)
    
    Returns:
    
    true if the condition holds
  - getTemplateKeys
```
public java.util.List<java.lang.String> getTemplateKeys()
```
    Description copied from interface: TemplateEngineDataProvider
    
    Get the collection of all keys that can be mapped to values.
    
    Specified by:
    
    getTemplateKeys in interface TemplateEngineDataProvider
    
    Returns:
    
    all keys that can be mapped to values
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class WithAttributes
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class WithAttributes

Class WayPoint

Nested Class Summary

Field Summary

Fields inherited from class org.openstreetmap.josm.data.gpx.WithAttributes

Fields inherited from interface org.openstreetmap.josm.data.gpx.GpxConstants

Constructor Summary

Method Summary

Methods inherited from class org.openstreetmap.josm.data.gpx.WithAttributes

Methods inherited from class java.lang.Object

Methods inherited from interface org.openstreetmap.josm.data.coor.ILatLon

Field Detail

customColoring

drawLine

dir

lat

lon

east

north

eastNorthCacheKey

Constructor Detail

WayPoint

WayPoint

Method Detail

invalidateEastNorthCache

getCoor

lon

lat

getEastNorth

toString

setTime

setTime

setTimeInMillis

compareTo

getTime

getTimeInMillis

hasDate

getDate

getDateImpl

getTemplateValue

evaluateCondition

getTemplateKeys

hashCode

equals