planner.geography

Class GeoAreaSet

java.lang.Object

planner.geography.GeoAreaSet

public class GeoAreaSet
extends Object

Class for containing a set of area objects (e.g. a set of avoid areas)

Author:

dtdavis

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addArea(GeoArea newArea) Adds a new area to the area set
AreaIncursion	firstIncursion(Route route) Returns an AreaIncursion for the first point at which a route enters an area of the area set
void	getAllTangents(double[] start, List<double[]> result) Determines the points on the area's edge that are tangentially reachable from a specified point
GeoArea	getArea(int index) Returns a reference to the area specified by an index
List<AreaIncursion>	getIncursions(Route route)
protected Iterator<GeoArea>	getIterator() Returns an iterator for the waypoint list
boolean	isClearPath(double x1, double y1, double x2, double y2) Utility function that determines whether a straight path (i.e., a line segment) encroaches into any of the contained GeoAreas
boolean	isContainedInArea(double x, double y) Utility function that determines whether a point is contained in any of the contained GeoAreas
int	numAreas() Returns the number of areas in the set
String	toMATLABString(String colorCode) Generates a string representation of the Path object that can be used to plot the path in MATLAB
String	toString() Utility function for printing all items in a GeoAreaSet

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoAreaSet

public GeoAreaSet()

Creates a new instance of GeoAreaSet

Method Detail

addArea

public void addArea(GeoArea newArea)

Adds a new area to the area set

Parameters:

newArea -

getArea

public GeoArea getArea(int index)

Returns a reference to the area specified by an index

Parameters:

index -

Returns:

getIterator

protected Iterator<GeoArea> getIterator()

Returns an iterator for the waypoint list

Returns:

numAreas

public int numAreas()

Returns the number of areas in the set

Returns:

firstIncursion

public AreaIncursion firstIncursion(Route route)

Returns an AreaIncursion for the first point at which a route enters an area of the area set

Parameters:

route -

Returns:

getIncursions

public List<AreaIncursion> getIncursions(Route route)

Parameters:

route -

Returns:

Returns an ArrayList containing all of the incursions of a route into areas contained in the area set

isContainedInArea

public boolean isContainedInArea(double x,
                        double y)

Utility function that determines whether a point is contained in any of the contained GeoAreas

Parameters:

x - north/south coordinate of the point being tested

y - east/west coordinate of the point being tested

Returns:

true if the point is inside one of the areas

isClearPath

public boolean isClearPath(double x1,
                  double y1,
                  double x2,
                  double y2)

Utility function that determines whether a straight path (i.e., a line segment) encroaches into any of the contained GeoAreas

Parameters:

x1 - north/south coordinate of the first end point of the line segment being tested

y1 - east/west coordinate of the first end point of the line segment being tested

x2 - north/south coordinate of the second end point of the line segment being tested

y2 - east/west coordinate of the second end point of the line segment being tested

Returns:

true if the path misses all contained GeoArea objects

getAllTangents

public void getAllTangents(double[] start,
                  List<double[]> result)

Determines the points on the area's edge that are tangentially reachable from a specified point

Parameters:

start - the point from which tangents are to be determined start[0] = x, start[1] = y

result - an ArrayList with double[2] objects representing the tangent points to all of the contained areas

toString

public String toString()

Utility function for printing all items in a GeoAreaSet

Overrides:

toString in class Object

toMATLABString

public String toMATLABString(String colorCode)

Generates a string representation of the Path object that can be used to plot the path in MATLAB

Parameters:

colorCode - MATLAB code for the color that is to be used in plotting the areas

Returns:

MATLAB compatible string that will plot the areas in the set