planner.routePlan

Class Route

java.lang.Object

planner.routePlan.Route

All Implemented Interfaces:

Cloneable, Comparable<Route>

public class Route
extends Object
implements Cloneable, Comparable<Route>

Class for containing a route (set of geographic waypoints) for planner use.

Since:

28 April 2005

Version:

$Id: Route.java 8020 2012-07-03 01:37:06Z brutzman $

Author:

dtdavis

Constructor Summary

Constructors

Constructor and Description
Route() Creates a new instance of Route

Method Summary

Methods

Modifier and Type	Method and Description
void	addWaypoint(double[] newPoint) Adds a point to the end of the route
void	addWaypoint(double[] newPoint, int index) Adds a point to the of the route at a specified index.
Object	clone() Returns a deep copy of the route
int	compareTo(Route route2) Imlements Comparable--Compares routes based on their total distance
void	divideLeg(int leg, double[] newWaypoint) Divides a route leg into two by adding a specified waypoint in the middle
double	getDistance() Returns the total straight-line distance covered by the route
protected Iterator	getIterator() Returns an iterator for the waypoint list
double	getLegDistance(int leg) Returns the distance of the specified leg of the route or 0.0 if the specified leg is beyond the end of the route or less than zero
double	getPartialDistance(int waypoint) Returns the distance from the start of the route to the specified waypoint.
double[]	getWaypoint(int index) Returns a reference to the area specified by an index
int	numWaypoints() Returns the number of areas in the set
String	toString() Formats the route for text output

Methods inherited from class java.lang.Object

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

Constructor Detail

Route

public Route()

Creates a new instance of Route

Method Detail

addWaypoint

public void addWaypoint(double[] newPoint)

Adds a point to the end of the route

Parameters:

newPoint - double[2] with the X, Y position of the point to be added

addWaypoint

public void addWaypoint(double[] newPoint,
               int index)

Adds a point to the of the route at a specified index. If the index is beyond the end of the existing route (i.e. greater than the highest waypoint number, the point is added to the end. If the index is less than zero, the waypoint is added at the beginning of the route

Parameters:

newPoint - double[2] with the X, Y position of the point to be added

index - number of the waypoint

divideLeg

public void divideLeg(int leg,
             double[] newWaypoint)

Divides a route leg into two by adding a specified waypoint in the middle

Parameters:

leg - the number of the leg that is to be divided

newWaypoint - double[2] with the X, Y position of the waypoint to be added

getWaypoint

public double[] getWaypoint(int index)

Returns a reference to the area specified by an index

Parameters:

index -

Returns:

getIterator

protected Iterator getIterator()

Returns an iterator for the waypoint list

Returns:

numWaypoints

public int numWaypoints()

Returns the number of areas in the set

Returns:

getLegDistance

public double getLegDistance(int leg)

Returns the distance of the specified leg of the route or 0.0 if the specified leg is beyond the end of the route or less than zero

Parameters:

leg -

Returns:

getPartialDistance

public double getPartialDistance(int waypoint)

Returns the distance from the start of the route to the specified waypoint. If the specified waypoint is beyond the end, the entire route length is returned. If the specified waypoint is less than or equal to zero, 0.0 is returned

Parameters:

waypoint -

Returns:

getDistance

public double getDistance()

Returns the total straight-line distance covered by the route

Returns:

clone

public Object clone()

Returns a deep copy of the route

Overrides:

clone in class Object

compareTo

public int compareTo(Route route2)

Imlements Comparable--Compares routes based on their total distance

Specified by:

compareTo in interface Comparable<Route>

Parameters:

route2 -

toString

public String toString()

Formats the route for text output

Overrides:

toString in class Object