com.pb.routing.gra

Class Options

java.lang.Object

com.pb.routing.gra.Options

public final class Options
extends Object

Creates an instance of Options which can used to instantiate IGRAInstance to run routing operations. Options class is an alternative for various parameters which are present as part of the .properties file, required by the routing engine.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Options.Builder Builder class to create Options object.

Method Summary

Modifier and Type	Method and Description
CoordSys	getDefaultCoordSys() Returns the default value of Coordinate System if no value is specified in the request.
long	getIsoTimeout() Returns the amount of processing time (in milliseconds) before stopping an ISO routing request if processing is not complete.
int	getLongProcessThreads() Returns the number of threads to be used for isochrone, matrix route and multipoint route requests.
long	getMatrixRouteTimeout() Returns the amount of processing time (in milliseconds) before stopping a matrix routing request if processing is not complete.
long	getMultiPointTimeout() Returns the amount of processing time (in milliseconds) before stopping a multipoint routing request if processing is not complete.
long	getRouteTimeout() Returns the amount of processing time (in milliseconds) before stopping a point to point routing request if processing is not complete.
int	getShortProcessThreads() Returns the number of threads to be used for point to point route requests.
File	getUpdateFilePath() Returns a File object containing the path where are system updates are saved.
boolean	isAllowFallback() Returns whether to use or not, the major roads when other roads cannot be used.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDefaultCoordSys

public CoordSys getDefaultCoordSys()

Returns the default value of Coordinate System if no value is specified in the request.

Returns:

CoordSys, default value of Coordinate System.

getRouteTimeout

public long getRouteTimeout()

Returns the amount of processing time (in milliseconds) before stopping a point to point routing request if processing is not complete.

Returns:

A long, timeout value (in milliseconds) for a point to point routing request.

getMultiPointTimeout

public long getMultiPointTimeout()

Returns the amount of processing time (in milliseconds) before stopping a multipoint routing request if processing is not complete.

Returns:

A long, timeout value (in milliseconds) for a multipoint routing request.

getIsoTimeout

public long getIsoTimeout()

Returns the amount of processing time (in milliseconds) before stopping an ISO routing request if processing is not complete.

Returns:

A long, timeout value (in milliseconds) for an ISO routing request.

getMatrixRouteTimeout

public long getMatrixRouteTimeout()

Returns the amount of processing time (in milliseconds) before stopping a matrix routing request if processing is not complete.

Returns:

A long, timeout value (in milliseconds) for a matrix routing request.

isAllowFallback

public boolean isAllowFallback()

Returns whether to use or not, the major roads when other roads cannot be used.

Returns:

A boolean, true value means major roads will be used when other roads cannot be used, false otherwise.

getShortProcessThreads

public int getShortProcessThreads()

Returns the number of threads to be used for point to point route requests.

Returns:

An int, number of threads to be used for point to point route requests.

getLongProcessThreads

public int getLongProcessThreads()

Returns the number of threads to be used for isochrone, matrix route and multipoint route requests.

Returns:

An int, number of threads to be used for isochrone, matrix route and multipoint route requests.

getUpdateFilePath

public File getUpdateFilePath()

Returns a File object containing the path where are system updates are saved.

Returns:

File, containing the path where the updates are saved.