GetRouteRequest (GRA 3.0.1 API)

java.lang.Object
- com.pb.routing.gra.route.GetRouteRequest

All Implemented Interfaces:

Serializable
```
public final class GetRouteRequest
extends Object
implements Serializable
```
Request object to be used for generating route between a given start and end point or multiple intermediate points. Start Point and End Point are required parameters to calculate a route.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GetRouteRequest.Builder
Builder class to create GetRouteRequest object.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GetRouteRequest.Builder` Builder class to create `GetRouteRequest` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDBResource()` Returns the name of Database resource used with this request.
`CoordSys`	`getDestinationSrs()` Returns the Destination Coordinate System associated with request.
`LinearUnit`	`getDistanceUnit()` Returns the `LinearUnit` for route request.
`IPoint`	`getEndPoint()` Returns the End Point for which this request was created.
`HistoricSpeedBucket`	`getHistoricSpeedBucket()` Returns the Historic traffic time bucket used with this request.
`List<IPoint>`	`getIntermediatePoints()` Returns the list of Intermediate Points via which route is to be calculated.
`Language`	`getLanguage()` Returns the language in which turn by turn directions for route are to be returned.
`int`	`getLocalRoadsLoadFactor()` Returns the localRoadLoadFactor used for this request.
`OptimizeBy`	`getOptimizeBy()` Returns whether the fastest or shortest route is to be calculated.
`Map<RoadType,RoadTypePriority>`	`getRoadTypePreferences()` Returns `Map` of `RoadType` and their `RoadTypePriority`.
`IPoint`	`getStartPoint()` Returns the Start Point for which this request was created.
`TimeUnit`	`getTimeUnit()` Returns the `TimeUnit` for route request.
`List<Update>`	`getUpdates()` Returns the `List` of `Update` used for this request.
`VehicleAttributes`	`getVehicleAttr()` Returns the Commercial Vehicle Restriction value used with this request.
`boolean`	`isAvoidTollRoad()` Returns whether the route is calculated using avoid toll roads only or not.
`boolean`	`isMajorRoads()` Returns whether the route is calculated using major roads only or not.
`boolean`	`isOptimizeIntermediatePoints()` Returns whether to optimize the sequence of intermediate points for route calculation if multiple intermediate points are specified.
`boolean`	`isReturnDirectionGeometry()` Returns whether to return direction geometry with `RouteInstruction` or not in route response.
`boolean`	`isReturnDirections()` Returns whether to return turn by turn directions or not in route response.
`boolean`	`isReturnSegmentGeometry()` Returns whether to return route geometry or not in route response.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getDistanceUnit
```
public LinearUnit getDistanceUnit()
```
    Returns the LinearUnit for route request.
    
    Returns:
    
    LinearUnit
  - getTimeUnit
```
public TimeUnit getTimeUnit()
```
    Returns the TimeUnit for route request.
    
    Returns:
    
    TimeUnit
  - getStartPoint
```
public IPoint getStartPoint()
```
    Returns the Start Point for which this request was created.
    
    Returns:
    
    IPoint, the origin for which this request was created.
  - getEndPoint
```
public IPoint getEndPoint()
```
    Returns the End Point for which this request was created.
    
    Returns:
    
    IPoint, the destination for which this request was created.
  - getIntermediatePoints
```
public List<IPoint> getIntermediatePoints()
```
    Returns the list of Intermediate Points via which route is to be calculated.
    
    Returns:
    
    List of IPoint via which route is to be calculated.
  - getOptimizeBy
```
public OptimizeBy getOptimizeBy()
```
    Returns whether the fastest or shortest route is to be calculated. OptimizeBy.TIME means fastest and OptimizeBy.DISTANCE means shortest.
    
    Returns:
    
    OptimizeBy value.
  - getLanguage
```
public Language getLanguage()
```
    Returns the language in which turn by turn directions for route are to be returned.
    
    Returns:
    
    Language in which turn by turn directions for route are to be returned.
  - isReturnDirections
```
public boolean isReturnDirections()
```
    Returns whether to return turn by turn directions or not in route response.
    
    Returns:
    
    A boolean, true if turn by turn directions are to be returned for route, false otherwise.
  - isReturnSegmentGeometry
```
public boolean isReturnSegmentGeometry()
```
    Returns whether to return route geometry or not in route response.
    
    Returns:
    
    A boolean, true if route geometry is to be returned for route, false otherwise.
  - isOptimizeIntermediatePoints
```
public boolean isOptimizeIntermediatePoints()
```
    Returns whether to optimize the sequence of intermediate points for route calculation if multiple intermediate points are specified.
    
    Returns:
    
    A boolean, true if the sequence of intermediate points for route calculation is to be optimized, false otherwise.
  - getRoadTypePreferences
```
public Map<RoadType,RoadTypePriority> getRoadTypePreferences()
```
    Returns Map of RoadType and their RoadTypePriority. Used to force usage or avoid certain type of roads while route calculation.
    
    Returns:
    
    A Map of RoadType and their RoadTypePriority.
  - isMajorRoads
```
public boolean isMajorRoads()
```
    Returns whether the route is calculated using major roads only or not.
    
    Returns:
    
    A boolean, true value means the route is calculated using major roads only, false means complete road network is considered.
  - isAvoidTollRoad
```
public boolean isAvoidTollRoad()
```
    Returns whether the route is calculated using avoid toll roads only or not.
    
    Returns:
    
    A boolean, true = the request should avoid toll roads; false = the request should include toll roads
  - getDestinationSrs
```
public CoordSys getDestinationSrs()
```
    Returns the Destination Coordinate System associated with request.
    
    Returns:
    
    CoordSys, Destination Coordinate System for response.
  - getHistoricSpeedBucket
```
public HistoricSpeedBucket getHistoricSpeedBucket()
```
    Returns the Historic traffic time bucket used with this request.
    
    Returns:
    
    HistoricSpeedBucket to be used while processing the request.
  - getDBResource
```
public String getDBResource()
```
    Returns the name of Database resource used with this request.
    
    Returns:
    
    Database resource (a String) used for processing the request.
  - isReturnDirectionGeometry
```
public boolean isReturnDirectionGeometry()
```
    Returns whether to return direction geometry with RouteInstruction or not in route response.
    
    Returns:
    
    A boolean, true if direction geometry is to be returned with RouteInstruction for route, false otherwise.
  - getVehicleAttr
```
public VehicleAttributes getVehicleAttr()
```
    Returns the Commercial Vehicle Restriction value used with this request.
    
    Returns:
    
    VehicleAttributes to be used while processing the request.
  - getUpdates
```
public List<Update> getUpdates()
```
    Returns the List of Update used for this request.
    
    Returns:
    
    List of Update.
  - getLocalRoadsLoadFactor
```
public int getLocalRoadsLoadFactor()
```
    Returns the localRoadLoadFactor used for this request.
    
    Returns:
    
    localRoadLoadFactor

Class GetRouteRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDistanceUnit

getTimeUnit

getStartPoint

getEndPoint

getIntermediatePoints

getOptimizeBy

getLanguage

isReturnDirections

isReturnSegmentGeometry

isOptimizeIntermediatePoints

getRoadTypePreferences

isMajorRoads

isAvoidTollRoad

getDestinationSrs

getHistoricSpeedBucket

getDBResource

isReturnDirectionGeometry

getVehicleAttr

getUpdates

getLocalRoadsLoadFactor