openlr

Interface LocationReferencePoint

public interface LocationReferencePoint

The interface LocationReferencePoint defines the access to a location reference point (LRP). Such a LRP is a basic structure for an OpenLR location reference. It represents a line in the network and two successive LRPs represent a shortest- path being part of the location. The location reference point consists of coordinates and attributes like form of way, functional road class and a bearing. It also holds information on the path to the next LRP like the lowest functional road class on that path and the distance to the next LRP.

OpenLR is a trade mark of TomTom International B.V.

email: software@openlr.org

Author:

TomTom International B.V.

Method Summary

Modifier and Type	Method and Description
double	getBearing() Gets the bearing of the referenced line.
int	getDistanceToNext() Gets the real distance between this LRP and the next one along the shortest-path in between.
FormOfWay	getFOW() Gets the form of way for this LRP.
FunctionalRoadClass	getFRC() Gets the functional road class of this LRP.
double	getLatitudeDeg() Gets the latitude coordinate in degree.
FunctionalRoadClass	getLfrc() Gets the lowest functional road class value along the shortest-path to the next LRP.
double	getLongitudeDeg() Gets the longitude coordinate in degree.
int	getSequenceNumber() Gets the position of the location reference point in the list of location reference points starting with 1.
boolean	isLastLRP() Checks if this LRP is the last one in the sequence.

Method Detail

getLongitudeDeg

double getLongitudeDeg()

Gets the longitude coordinate in degree.

Returns:

the longitude coordinate

getLatitudeDeg

double getLatitudeDeg()

Gets the latitude coordinate in degree.

Returns:

the latitude coordinate

getDistanceToNext

int getDistanceToNext()

Gets the real distance between this LRP and the next one along the shortest-path in between.

Returns:

the distance to the next LRP

getLfrc

FunctionalRoadClass getLfrc()

Gets the lowest functional road class value along the shortest-path to the next LRP. The lowest frc value means in this context the highest frc value ID since a higher ID indicates a less important road.

Returns:

the lowest functional road class along the shortest-path to the next LRP, returns null if no route is available

getBearing

double getBearing()

Gets the bearing of the referenced line. The bearing is represented by the angle between the line and the true North.

Returns:

the bearing of the referenced line

getFOW

FormOfWay getFOW()

Gets the form of way for this LRP.

Returns:

the FOW

getFRC

FunctionalRoadClass getFRC()

Gets the functional road class of this LRP.

Returns:

the FRC

isLastLRP

boolean isLastLRP()

Checks if this LRP is the last one in the sequence.

Returns:

true, if this is the last LRP

getSequenceNumber

int getSequenceNumber()

Gets the position of the location reference point in the list of location reference points starting with 1.

Returns:

the sequence number