com.graphhopper

Class GHRequest

java.lang.Object

com.graphhopper.GHRequest

public class GHRequest
extends Object

Request object to perform routing with GraphHopper.

Author:

Peter Karich, ratrun

Constructor Summary

Constructors

Constructor and Description
GHRequest()
GHRequest(double fromLat, double fromLon, double toLat, double toLon) Set routing request from specified startPlace (fromLat, fromLon) to endPlace (toLat, toLon)
GHRequest(double fromLat, double fromLon, double toLat, double toLon, double startHeading, double endHeading) Set routing request from specified startPlace (fromLat, fromLon) to endPlace (toLat, toLon) with a preferred start and end heading.
GHRequest(GHPoint startPlace, GHPoint endPlace)
GHRequest(GHPoint startPlace, GHPoint endPlace, double startHeading, double endHeading) Set routing request from specified startPlace to endPlace with a preferred start and end heading.
GHRequest(int size)
GHRequest(List<GHPoint> points) Set routing request
GHRequest(List<GHPoint> points, List<Double> headings) Set routing request

Method Summary

Modifier and Type	Method and Description
GHRequest	addPoint(GHPoint point) Add stopover point to routing request.
String	getAlgorithm()
List<String>	getCurbsides()
List<Double>	getHeadings()
PMap	getHints()
Locale	getLocale()
List<String>	getPathDetails()
List<String>	getPointHints()
List<GHPoint>	getPoints()
String	getProfile()
List<String>	getSnapPreventions()
static boolean	isAzimuthValue(double heading)
GHRequest	putHint(String fieldName, Object value) This method sets a key value pair in the hints and is unrelated to the setPointHints method.
GHRequest	setAlgorithm(String algo) For possible values see AlgorithmOptions.*
GHRequest	setCurbsides(List<String> curbsides)
GHRequest	setHeadings(List<Double> headings) The starting directions at the various points as north based azimuth (clockwise) in [0, 360) or NaN for equal preference
GHRequest	setLocale(Locale locale)
GHRequest	setLocale(String localeStr)
GHRequest	setPathDetails(List<String> pathDetails)
GHRequest	setPointHints(List<String> pointHints)
GHRequest	setPoints(List<GHPoint> points)
GHRequest	setProfile(String profile)
GHRequest	setSnapPreventions(List<String> snapPreventions)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GHRequest

public GHRequest()

GHRequest

public GHRequest(int size)

GHRequest

public GHRequest(double fromLat,
                 double fromLon,
                 double toLat,
                 double toLon,
                 double startHeading,
                 double endHeading)

Set routing request from specified startPlace (fromLat, fromLon) to endPlace (toLat, toLon) with a preferred start and end heading. Headings are north based azimuth (clockwise) in (0, 360) or NaN for equal preference.

GHRequest

public GHRequest(double fromLat,
                 double fromLon,
                 double toLat,
                 double toLon)

Set routing request from specified startPlace (fromLat, fromLon) to endPlace (toLat, toLon)

GHRequest

public GHRequest(GHPoint startPlace,
                 GHPoint endPlace,
                 double startHeading,
                 double endHeading)

Set routing request from specified startPlace to endPlace with a preferred start and end heading. Headings are north based azimuth (clockwise) in (0, 360) or NaN for equal preference

GHRequest

public GHRequest(GHPoint startPlace,
                 GHPoint endPlace)

GHRequest

public GHRequest(List<GHPoint> points,
                 List<Double> headings)

Set routing request

Parameters:

points - List of stopover points in order: start, 1st stop, 2nd stop, ..., end

headings - List of favored headings for starting (start point) and arrival (via and end points) Headings are north based azimuth (clockwise) in (0, 360) or NaN for equal preference

GHRequest

public GHRequest(List<GHPoint> points)

Set routing request

Parameters:

points - List of stopover points in order: start, 1st stop, 2nd stop, ..., end

Method Detail

setPoints

public GHRequest setPoints(List<GHPoint> points)

getPoints

public List<GHPoint> getPoints()

addPoint

public GHRequest addPoint(GHPoint point)

Add stopover point to routing request.

Parameters:

point - geographical position (see GHPoint)

setHeadings

public GHRequest setHeadings(List<Double> headings)

The starting directions at the various points as north based azimuth (clockwise) in [0, 360) or NaN for equal preference

getHeadings

public List<Double> getHeadings()

isAzimuthValue

public static boolean isAzimuthValue(double heading)

getAlgorithm

public String getAlgorithm()

setAlgorithm

public GHRequest setAlgorithm(String algo)

For possible values see AlgorithmOptions.*

getLocale

public Locale getLocale()

setLocale

public GHRequest setLocale(Locale locale)

setLocale

public GHRequest setLocale(String localeStr)

getProfile

public String getProfile()

setProfile

public GHRequest setProfile(String profile)

getHints

public PMap getHints()

putHint

public GHRequest putHint(String fieldName,
                         Object value)

This method sets a key value pair in the hints and is unrelated to the setPointHints method. It is mainly used for deserialization with Jackson.

See Also:

setPointHints(List)

setPointHints

public GHRequest setPointHints(List<String> pointHints)

getPointHints

public List<String> getPointHints()

setCurbsides

public GHRequest setCurbsides(List<String> curbsides)

getCurbsides

public List<String> getCurbsides()

setSnapPreventions

public GHRequest setSnapPreventions(List<String> snapPreventions)

getSnapPreventions

public List<String> getSnapPreventions()

setPathDetails

public GHRequest setPathDetails(List<String> pathDetails)

getPathDetails

public List<String> getPathDetails()

toString

public String toString()

Overrides:

toString in class Object