com.gpxcreator.gpxpanel

Class WaypointGroup

java.lang.Object

com.gpxcreator.gpxpanel.GPXObject

com.gpxcreator.gpxpanel.WaypointGroup

public class WaypointGroup
extends GPXObject

An ad-hoc element representing a group of waypoint elements.
In a group of top-level "wpt" elements, these points will be represented discretely.
In a "rte" or "trk" element, these points will be represented as paths.

Author:

Matt Hoover

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WaypointGroup.EleCleansedStatus Status messages returned to the calling class after an elevation cleanse request. A "cleanse" is an attempt to fill in any data that was missing from the server's response (SRTM voids).
static class	WaypointGroup.EleCorrectedStatus Status messages returned to the calling class after an elevation correction request. A "correction" is an attempt to replace all elevation data with SRTM data from the server.
static class	WaypointGroup.WptGrpType The different types of WaypointGroup.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<Waypoint>	waypoints
private WaypointGroup.WptGrpType	wptGrpType

Fields inherited from class com.gpxcreator.gpxpanel.GPXObject

color, desc, duration, eleEndFeet, eleEndMeters, eleMaxFeet, eleMaxMeters, eleMinFeet, eleMinMeters, eleStartFeet, eleStartMeters, fallTime, grossFallFeet, grossFallMeters, grossRiseFeet, grossRiseMeters, lengthMeters, lengthMiles, maxLat, maxLon, maxSpeedKmph, maxSpeedMph, minLat, minLon, name, riseTime, visible, wptsVisible

Constructor Summary

Constructors

Constructor and Description
WaypointGroup(java.awt.Color color, WaypointGroup.WptGrpType type) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addWaypoint(Waypoint wpt) Adds a waypoint to the group.
void	addWaypoint(Waypoint wpt, boolean correctElevation) Adds a waypoint to the group and optionally corrects the elevation. Warning: using this method for repetitive adding of points will generate a large number of HTTP requests.
WaypointGroup.EleCleansedStatus	cleanseEleData() Cleanese the elevation data.
WaypointGroup.EleCorrectedStatus	correctElevation(boolean doCleanse) Corrects the elevation of each Waypoint in the group and updates the aggregate group properties. Optionally can do a "cleanse," attempting to fill missing data (SRTM voids) in the response. Note: The MapQuest Open Elevation API has a bug with POST XML, and the useFilter parameter.
static java.util.List<java.lang.Double>	getEleArrayFromXMLResponse(java.lang.String xmlResponse) Parses an XML response string.
Waypoint	getEnd()
int	getNumPts()
Waypoint	getStart()
java.util.List<Waypoint>	getWaypoints()
WaypointGroup.WptGrpType	getWptGrpType()
void	removeWaypoint(Waypoint wpt) Removes a waypoint from the group.
void	setWaypoints(java.util.List<Waypoint> waypoints)
void	updateAllProperties() Updates the relevant properties of the subclass.
void	updateBounds()
void	updateDuration()
void	updateEleProps()
void	updateLength()
void	updateMaxSpeed()

Methods inherited from class com.gpxcreator.gpxpanel.GPXObject

getColor, getDesc, getDuration, getEleEndFeet, getEleEndMeters, getEleMaxFeet, getEleMaxMeters, getEleMinFeet, getEleMinMeters, getEleStartFeet, getEleStartMeters, getFallTime, getGrossFallFeet, getGrossFallMeters, getGrossRiseFeet, getGrossRiseMeters, getLengthMeters, getLengthMiles, getMaxLat, getMaxLon, getMaxSpeedKmph, getMaxSpeedMph, getMinLat, getMinLon, getName, getRiseTime, isGPXFile, isGPXFileWithNoRoutes, isGPXFileWithOneRoute, isGPXFileWithOneRouteOnly, isGPXFileWithOneTrackseg, isGPXFileWithOneTracksegOnly, isRoute, isTrack, isTrackseg, isTrackWithOneSeg, isVisible, isWaypointGroup, isWaypoints, isWptsVisible, setColor, setDesc, setName, setVisible, setWptsVisible, toString

Methods inherited from class java.lang.Object

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

Field Detail

wptGrpType

private WaypointGroup.WptGrpType wptGrpType

waypoints

private java.util.List<Waypoint> waypoints

Constructor Detail

WaypointGroup

public WaypointGroup(java.awt.Color color,
             WaypointGroup.WptGrpType type)

Default constructor.

Parameters:

color - The color.

type - The type of WaypointGroup.

Method Detail

getWptGrpType

public WaypointGroup.WptGrpType getWptGrpType()

getWaypoints

public java.util.List<Waypoint> getWaypoints()

setWaypoints

public void setWaypoints(java.util.List<Waypoint> waypoints)

addWaypoint

public void addWaypoint(Waypoint wpt)

Adds a waypoint to the group.

addWaypoint

public void addWaypoint(Waypoint wpt,
               boolean correctElevation)

Adds a waypoint to the group and optionally corrects the elevation.
Warning: using this method for repetitive adding of points will generate a large number of HTTP requests.

removeWaypoint

public void removeWaypoint(Waypoint wpt)

Removes a waypoint from the group.

getNumPts

public int getNumPts()

getStart

public Waypoint getStart()

getEnd

public Waypoint getEnd()

correctElevation

public WaypointGroup.EleCorrectedStatus correctElevation(boolean doCleanse)

Corrects the elevation of each Waypoint in the group and updates the aggregate group properties.
Optionally can do a "cleanse," attempting to fill missing data (SRTM voids) in the response.
Note: The MapQuest Open Elevation API has a bug with POST XML, and the useFilter parameter. Because of this, the request must be a POST KVP (key/value pair). The useFilter parameter returns data of much higher quality.

Returns:

The status of the response.

cleanseEleData

public WaypointGroup.EleCleansedStatus cleanseEleData()

Cleanese the elevation data. Any Waypoint with an elevation of -32768 needs to be interpolated.

Returns:

The status of the cleanse.

getEleArrayFromXMLResponse

public static java.util.List<java.lang.Double> getEleArrayFromXMLResponse(java.lang.String xmlResponse)

Parses an XML response string.

Returns:

A list of numerical elevation values.

updateAllProperties

public void updateAllProperties()

Description copied from class: GPXObject

Updates the relevant properties of the subclass.

Specified by:

updateAllProperties in class GPXObject

updateDuration

public void updateDuration()

updateLength

public void updateLength()

updateMaxSpeed

public void updateMaxSpeed()

updateEleProps

public void updateEleProps()

updateBounds

public void updateBounds()