B C D E F G H I L M N O P Q R S T V Z

B

bearing(GeoCoordinates, GeoCoordinates) - Static method in class openlr.map.utils.GeometryUtils

Return the bearing (degrees clockwise from North) of p2 from p1 (the direction that must be traveled from p1 in order to arrive at p2).

bearing(double, double, double, double) - Static method in class openlr.map.utils.GeometryUtils

Return the bearing (degrees clockwise from North) of p2 from p1 (the direction that must be traveled from p1 in order to arrive at p2).

C

calculateLineBearing(Line, GeometryUtils.BearingDirection, int, int) - Static method in class openlr.map.utils.GeometryUtils

Calculates and returns the line bearing.

checkCoordinateBounds(double, double) - Static method in class openlr.map.utils.GeometryUtils

Check coordinate bounds.

checkPathConnection(List<Line>) - Static method in class openlr.map.utils.PathUtils

Checks if the path is connected properly.

compare(FunctionalRoadClass, FunctionalRoadClass) - Method in class openlr.map.FunctionalRoadClass.FrcComparator

compare(PQElem, PQElem) - Method in class openlr.map.utils.PQElem.PQElemComparator

constructPath(LineLinkedListElement) - Static method in class openlr.map.utils.PathUtils

Constructs a path from information in the LineLinkedListElement.

contains(Iterator<? extends E>, E) - Static method in class openlr.map.utils.IteratorHelper

Checks if an element item is contained in the iterator sequence.

D

determineCoordinateInDistance(GeoCoordinates, int, double) - Static method in class openlr.map.utils.GeometryUtils

Determine coordinate in distance.

determineCoordinateInDistance(double, double, int, double) - Static method in class openlr.map.utils.GeometryUtils

Determine coordinate in distance.

distance(GeoCoordinates, GeoCoordinates) - Static method in class openlr.map.utils.GeometryUtils

Returns the distance in meters between two points specified in degrees longitude (x) and latitude (y).

distance(double, double, double, double) - Static method in class openlr.map.utils.GeometryUtils

Returns the distance in meters between two points specified in degrees longitude (x) and latitude (y).

distanceToPoint(double, double) - Method in interface openlr.map.Line

Calculates the (smallest) distance in meters between the line and the point given by its longitude and latitude coordinates.

E

equals(Object) - Method in interface openlr.map.GeoCoordinates

equals(Object) - Method in class openlr.map.GeoCoordinatesImpl

equals(Object) - Method in interface openlr.map.Line

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in interface openlr.map.Node

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class openlr.map.RectangleCorners

equals(Object) - Method in class openlr.map.utils.PQElem

F

findCommonLineInPaths(List<? extends Line>, LineLinkedListElement) - Static method in class openlr.map.utils.PathUtils

Compares the path of the location and the path indicated by the LineLinkedListElement el and returns the first line element which is part of both paths, starting from the end of the linked list path.

findElementInQueue(Queue<? extends LineLinkedListElement>, Line) - Static method in class openlr.map.utils.PathUtils

Returns the first LineLinkedListElement from the queue pq which contains the line l.

findLinesCloseByCoordinate(double, double, int) - Method in interface openlr.map.MapDatabase

Returns a set of lines in the road network which are within a distance of distance meter away from the position arguments (latitude, longitude).

findNodesCloseByCoordinate(double, double, int) - Method in interface openlr.map.MapDatabase

Returns a set of nodes in the road network which are within a distance of distance meter away from the position arguments (latitude, longitude).

FormOfWay - Enum in openlr.map

The Enum FormOfWay (FOW) describes certain aspects of the physical form that a line in a road network takes.

FULL_CIRCLE_DEGREE - Static variable in class openlr.map.utils.GeometryUtils

degree in a full circle

FunctionalRoadClass - Enum in openlr.map

The Enum FunctionalRoadClass is a classification based on the importance of the role that a line performs in the connectivity of the total road network.

FunctionalRoadClass.FrcComparator - Class in openlr.map

The class FrcComparator can be used to order functional road classes according to its importance in the road network.

FunctionalRoadClass.FrcComparator() - Constructor for class openlr.map.FunctionalRoadClass.FrcComparator

G

GeoCoordinates - Interface in openlr.map

The interface GeoCoordinates defines a coordinate pair of a longitude and a latitude value.

GeoCoordinatesImpl - Class in openlr.map

This class is an implementation of interface GeoCoordinates.

GeoCoordinatesImpl(double, double) - Constructor for class openlr.map.GeoCoordinatesImpl

Instantiates a new geo-coordinate.

GeometryUtils - Class in openlr.map.utils

The GeometryUtils offer methods for the calculation of distances of points and bearings of lines.

GeometryUtils.BearingDirection - Enum in openlr.map.utils

The Enum BearingDirection defines the direction off a line being used for the bearing calculation.

getAllLines() - Method in interface openlr.map.MapDatabase

Returns all lines.

getAllNodes() - Method in interface openlr.map.MapDatabase

Returns all nodes.

getConnectedLines() - Method in interface openlr.map.Node

Returns a set of connected lines.

getCornerPoints() - Method in class openlr.map.RectangleCorners

Gets the corner points (anti-clockwise starting from lower left coordinate).

getDescription() - Method in interface openlr.map.loader.MapLoadParameter

Return the description of the parameter.

getDescription() - Method in interface openlr.map.loader.OpenLRMapLoader

Gets the description of the map loader.

getEndNode() - Method in interface openlr.map.Line

Gets the end node of the line.

getFirstVal() - Method in class openlr.map.utils.PQElem

Gets the first value.

getFOW() - Method in interface openlr.map.Line

Gets the FormOfWay of the line.

getFOWs() - Static method in enum openlr.map.FormOfWay

Gets the FOW values.

getFRC() - Method in interface openlr.map.Line

Gets the FunctionalRoadClass of the line.

getFRCs() - Static method in enum openlr.map.FunctionalRoadClass

Gets the FRC values.

getGeoCoordinateAlongLine(int) - Method in interface openlr.map.Line

Gets a point along the line geometry which is distanceAlong meter away from the start node of the line.

getGeoCoordinates() - Method in interface openlr.map.Node

Gets the geo coordinates of the node position.

getHighestFrc() - Static method in enum openlr.map.FunctionalRoadClass

Gets the highest frc.

getID() - Method in enum openlr.map.FormOfWay

Gets an unique ID identifying that specific FormOfWay.

getID() - Method in enum openlr.map.FunctionalRoadClass

Gets an unique ID identifying that specific FunctionalRoadClass.

getID() - Method in interface openlr.map.Line

Gets the unique ID.

getID() - Method in interface openlr.map.Node

Return the unique ID of the node

getIdentifier() - Method in interface openlr.map.loader.MapLoadParameter

Gets the identifier which uniquely identifies this parameter for a specific map loader.

getIncomingLines() - Method in interface openlr.map.Node

Returns a set of incoming lines.

getLatitudeDeg() - Method in interface openlr.map.GeoCoordinates

Delivers the degrees of latitude.

getLatitudeDeg() - Method in class openlr.map.GeoCoordinatesImpl

Gets the latitude deg.

getLatitudeDeg() - Method in interface openlr.map.Node

Gets the latitude of the node position in degree.

getLength(List<Line>, Line, Line) - Static method in class openlr.map.utils.PathUtils

Gets the length of the subpath of path between start and end.

getLength(List<Line>) - Static method in class openlr.map.utils.PathUtils

Gets the total length of the path [in meter, rounded].

getLine(long) - Method in interface openlr.map.MapDatabase

Returns the line of the road network with the ID id.

getLine() - Method in interface openlr.map.utils.LineLinkedListElement

Gets the line.

getLine() - Method in class openlr.map.utils.PQElem

Gets the line.

getLineLength() - Method in interface openlr.map.Line

Gets the length of the line indicating its real dimension along the geometry of the line.

getLongitudeDeg() - Method in interface openlr.map.GeoCoordinates

Delivers the degrees of longitude.

getLongitudeDeg() - Method in class openlr.map.GeoCoordinatesImpl

Gets the longitude deg.

getLongitudeDeg() - Method in interface openlr.map.Node

Gets the longitude of the node position in degree.

getLowerLeft() - Method in class openlr.map.RectangleCorners

Gets the lower left.

getLowerRight() - Method in class openlr.map.RectangleCorners

Gets the lower right.

getLowestFrc() - Static method in enum openlr.map.FunctionalRoadClass

Gets the lowest frc.

getMapBoundingBox() - Method in interface openlr.map.MapDatabase

Gets the bounding box of the map.

getMapDescriptor() - Method in interface openlr.map.loader.OpenLRMapLoader

Gets the map descriptor.

getName() - Method in interface openlr.map.loader.MapLoadParameter

Gets the name of the parameter.

getName() - Method in interface openlr.map.loader.OpenLRMapLoader

Gets the name of the map loader.

getNames() - Method in interface openlr.map.Line

Gets the names of the line.

getNextLines() - Method in interface openlr.map.Line

Returns a set of lines which follows this line in the same direction.

getNode(long) - Method in interface openlr.map.MapDatabase

Returns the node of the road network with the ID id.

getNumberConnectedLines() - Method in interface openlr.map.Node

Gets the number of connected lines.

getNumberOfLines() - Method in interface openlr.map.MapDatabase

Returns the number of lines.

getNumberOfNodes() - Method in interface openlr.map.MapDatabase

Returns the number of nodes.

getNumberOfParams() - Method in interface openlr.map.loader.OpenLRMapLoader

Gets the number of parameter (required and optional) used by this map loader.

getOutgoingLines() - Method in interface openlr.map.Node

Returns a set of outgoing lines.

getParameter() - Method in interface openlr.map.loader.OpenLRMapLoader

Gets the parameter (required and optional) used by this map loader .

getPointAlongLine(int) - Method in interface openlr.map.Line

Deprecated. This method still exists to keep backwards compatibility and will be removed in future releases, use Line.getGeoCoordinateAlongLine(int) instead.

getPrevious() - Method in interface openlr.map.utils.LineLinkedListElement

Gets the predecessor.

getPrevious() - Method in class openlr.map.utils.PQElem

Gets the predecessor.

getPrevLines() - Method in interface openlr.map.Line

Returns a set of lines which precedes this line in the same direction.

getSecondVal() - Method in class openlr.map.utils.PQElem

Gets the second value.

getShape() - Method in interface openlr.map.Line

Deprecated. This method still exists to keep backwards compatibility and will be removed in future releases, use Line.getShapeCoordinates() instead.

getShapeCoordinates() - Method in interface openlr.map.Line

Gets the shape of the line.

getStartNode() - Method in interface openlr.map.Line

Gets the start node of the line.

getType() - Method in interface openlr.map.loader.MapLoadParameter

Gets the type of the parameter.

getUpperLeft() - Method in class openlr.map.RectangleCorners

Gets the upper left.

getUpperRight() - Method in class openlr.map.RectangleCorners

Gets the upper right.

getValue() - Method in interface openlr.map.loader.MapLoadParameter

Gets the value of the parameter.

H

HALF_CIRCLE - Static variable in class openlr.map.utils.GeometryUtils

The Constant HALF_CIRCLE.

hashCode() - Method in interface openlr.map.GeoCoordinates

hashCode() - Method in class openlr.map.GeoCoordinatesImpl

hashCode() - Method in interface openlr.map.Line

Returns a hash code value for the line.

hashCode() - Method in interface openlr.map.Node

Returns a hash code value for the line.

hashCode() - Method in class openlr.map.RectangleCorners

hashCode() - Method in class openlr.map.utils.PQElem

hasTurnRestrictionOnPath(List<? extends Line>) - Method in interface openlr.map.MapDatabase

Checks for turn restrictions on a path.

hasTurnRestrictions() - Method in interface openlr.map.MapDatabase

Checks if the map database also holds information on turn restrictions.

higher() - Method in enum openlr.map.FunctionalRoadClass

Higher.

I

intersectStraights(GeoCoordinates, double, GeoCoordinates, double) - Static method in class openlr.map.utils.GeometryUtils

Intersects two straights given by rsp.

intersectStraights(double, double, double, double, double, double) - Static method in class openlr.map.utils.GeometryUtils

Intersects two straights given by rsp.

InvalidMapDataException - Exception in openlr.map

This exception will be thrown if the map data is invalid, e.g.

InvalidMapDataException(String) - Constructor for exception openlr.map.InvalidMapDataException

Instantiates a new invalid map data exception.

isPair(Line, Line) - Static method in class openlr.map.utils.NodeCheck

Checks if line1 and line2 connect only two nodes and point into two different directions.

isRequired() - Method in interface openlr.map.loader.MapLoadParameter

Checks if this parameter is required.

isValidNode(Node) - Static method in class openlr.map.utils.NodeCheck

Checks if node n is valid.

IteratorHelper - Class in openlr.map.utils

The IteratorHelper provides helper methods for iterators.

L

Line - Interface in openlr.map

The Interface Line is a one-dimensional representation of a road or part of road in a road network.

lineIntersection(GeoCoordinates, GeoCoordinates, GeoCoordinates, GeoCoordinates) - Static method in class openlr.map.utils.GeometryUtils

Line intersection.

LineLinkedListElement - Interface in openlr.map.utils

The Interface LineLinkListElement defines an element which holds a line and also a pointer to a predecessor LineLinkedListElement.

load(Collection<MapLoadParameter>) - Method in interface openlr.map.loader.OpenLRMapLoader

Load the map database and return it using parameters.

lower() - Method in enum openlr.map.FunctionalRoadClass

Lower.

M

MapDatabase - Interface in openlr.map

The Interface MapDatabase is the geospatial representation of an area on the earth surface.

MapLoadParameter - Interface in openlr.map.loader

The interface MapLoadParameter defines methods for the identification and the type of a parameter.

MapLoadParameter.ParameterType - Enum in openlr.map.loader

The enum ParameterType defines the type of a parameter.

MAX_LAT - Static variable in class openlr.map.utils.GeometryUtils

The Constant MAX_LAT.

MAX_LON - Static variable in class openlr.map.utils.GeometryUtils

The Constant MAX_LON.

measureAlongLine(double, double) - Method in interface openlr.map.Line

Calculates a projection point on the line for the given coordinates and returns the distance between the start node of the line and the projection point along the line shape.

MIN_LAT - Static variable in class openlr.map.utils.GeometryUtils

The Constant MIN_LAT.

MIN_LON - Static variable in class openlr.map.utils.GeometryUtils

The Constant MIN_LON.

N

newGeoCoordinatesUnchecked(double, double) - Static method in class openlr.map.GeoCoordinatesImpl

Instantiates a new geo-coordinate without declaration of a checked exception.

Node - Interface in openlr.map

The Interface Node defines a zero-dimensional object in the road network.

NodeCheck - Class in openlr.map.utils

The Class NodeCheck checks the validity of a node.

O

openlr.map - package openlr.map

The map package consists of the map interface being used by the OpenLR encoder and decoder.

openlr.map.loader - package openlr.map.loader

This package defines interfaces for map data loader.

openlr.map.utils - package openlr.map.utils

This package provides utility classes which deals with paths in the network, distance and bearing calculation, validity check of nodes.

OpenLRMapLoader - Interface in openlr.map.loader

The interface OpenLRMapLoader defines methods which needs to be implemented in order to provide a new map to be shown in an application.

OpenLRMapLoaderException - Exception in openlr.map.loader

The class OpenLRMapLoaderException will be thrown if the map loader cannot load the map.

OpenLRMapLoaderException(Throwable) - Constructor for exception openlr.map.loader.OpenLRMapLoaderException

Instantiates a new openlr data loader exception due to a previously thrown exception.

OpenLRMapLoaderException(String) - Constructor for exception openlr.map.loader.OpenLRMapLoaderException

Instantiates a new openlr data loader exception with a message.

OpenLRMapLoaderException() - Constructor for exception openlr.map.loader.OpenLRMapLoaderException

Instantiates a new openlr data loader exception.

OpenLRMapLoaderException(String, Throwable) - Constructor for exception openlr.map.loader.OpenLRMapLoaderException

Instantiates a new openlr data loader exception due to a previously thrown exception and with a message.

P

PathUtils - Class in openlr.map.utils

The Class RouteUtils.

pointAlongLine(GeoCoordinates, GeoCoordinates, double) - Static method in class openlr.map.utils.GeometryUtils

Calculates a point on the straight line defined by point a and b.

pointAlongLine(double, double, double, double, double) - Static method in class openlr.map.utils.GeometryUtils

Calculates a point on the straight line defined by point a and b.

PQElem - Class in openlr.map.utils

The Class PQElem represents an entry of a priority queue.

PQElem(Line, int, int, PQElem) - Constructor for class openlr.map.utils.PQElem

Instantiates a new Priority Queue element.

PQElem.PQElemComparator - Class in openlr.map.utils

The Class PQElemComparator.

PQElem.PQElemComparator() - Constructor for class openlr.map.utils.PQElem.PQElemComparator

Q

QUARTER_CIRCLE - Static variable in class openlr.map.utils.GeometryUtils

The Constant QUARTER_CIRCLE.

R

RectangleCorners - Class in openlr.map

The Class RectangleCorners.

RectangleCorners(GeoCoordinates, GeoCoordinates) - Constructor for class openlr.map.RectangleCorners

Instantiates a new rectangle corners.

RectangleCorners(GeoCoordinates, GeoCoordinates, GeoCoordinates, GeoCoordinates) - Constructor for class openlr.map.RectangleCorners

Instantiates a new rectangle corners.

round(double) - Static method in class openlr.map.utils.GeometryUtils

Round.

round(double, int) - Static method in class openlr.map.utils.GeometryUtils

Rounds a coordinate value (longitude or latitude) to a specific precision.

S

scaleUpperRightCoordinate(GeoCoordinates, GeoCoordinates, double, double) - Static method in class openlr.map.utils.GeometryUtils

Scale the upperright point of a rectangle given by lowerleft and upperright wrt to given factors in x- and y-direction.

scaleUpperRightCoordinate(double, double, double, double, double, double) - Static method in class openlr.map.utils.GeometryUtils

Scale the upperright point of a rectangle given by lowerleft and upperright wrt to given factors in x- and y-direction.

setValue(String) - Method in interface openlr.map.loader.MapLoadParameter

Sets the value of the parameter.

size(Iterator<E>) - Static method in class openlr.map.utils.IteratorHelper

Returns the number of elements in the iterator sequence.

T

THREE_QUARTER_CIRCLE - Static variable in class openlr.map.utils.GeometryUtils

The Constant QUARTER_CIRCLE.

toString() - Method in class openlr.map.GeoCoordinatesImpl

toString() - Method in class openlr.map.RectangleCorners

toString() - Method in class openlr.map.utils.PQElem

V

valueOf(String) - Static method in enum openlr.map.FormOfWay

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum openlr.map.FunctionalRoadClass

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum openlr.map.loader.MapLoadParameter.ParameterType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum openlr.map.utils.GeometryUtils.BearingDirection

Returns the enum constant of this type with the specified name.

values() - Static method in enum openlr.map.FormOfWay

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum openlr.map.FunctionalRoadClass

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum openlr.map.loader.MapLoadParameter.ParameterType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum openlr.map.utils.GeometryUtils.BearingDirection

Returns an array containing the constants of this enum type, in the order they are declared.

Z

ZERO_CIRCLE - Static variable in class openlr.map.utils.GeometryUtils

The Constant ZERO_CIRCLE.

B C D E F G H I L M N O P Q R S T V Z