GetRouteCostMatrixRequest (GRA 3.0.1 API)

java.lang.Object
- com.pb.routing.gra.matrix.GetRouteCostMatrixRequest

All Implemented Interfaces:

Serializable
```
public final class GetRouteCostMatrixRequest
extends Object
implements Serializable
```
Request object to be used for generating route cost matrix between given list of start and end points. Resultant cost matrix contains route cost from each start point to each end point. Start and end points are required parameters to calculate route cost matrix.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GetRouteCostMatrixRequest.Builder
Builder class to create GetRouteCostMatrixRequest object.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GetRouteCostMatrixRequest.Builder` Builder class to create `GetRouteCostMatrixRequest` 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 Linear Unit for route request.
`List<IPoint>`	`getEndPoints()` Returns the list of end points for which this request was created.
`HistoricSpeedBucket`	`getHistoricSpeedBucket()` Returns the Historic Traffic time bucket used with this request.
`int`	`getLocalRoadsLoadFactor()` Returns the localRoadLoadFactor used for this request.
`OptimizeBy`	`getOptimizeBy()` Returns whether the fastest or shortest routes for route cost matrix are to be calculated.
`Map<RoadType,RoadTypePriority>`	`getRoadTypePreferences()` Returns `Map` of `RoadType` and their `RoadTypePriority`.
`List<IPoint>`	`getStartPoints()` Returns the list of start points for which this request was created.
`TimeUnit`	`getTimeUnit()` Returns the Time Unit 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 matrix is calculated using only major roads or not.
`boolean`	`isReturnOptimalRoutesOnly()` Returns whether to return only optimal route costs or complete route cost matrix.

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

- Method Detail
  - getDistanceUnit
```
public LinearUnit getDistanceUnit()
```
    Returns the Linear Unit for route request.
    
    Returns:
    
    LinearUnit
  - getTimeUnit
```
public TimeUnit getTimeUnit()
```
    Returns the Time Unit for route request.
    
    Returns:
    
    TimeUnit
  - getStartPoints
```
public List<IPoint> getStartPoints()
```
    Returns the list of start points for which this request was created.
    
    Returns:
    
    List of IPoint
  - getEndPoints
```
public List<IPoint> getEndPoints()
```
    Returns the list of end points for which this request was created.
    
    Returns:
    
    List of IPoint.
  - getOptimizeBy
```
public OptimizeBy getOptimizeBy()
```
    Returns whether the fastest or shortest routes for route cost matrix are to be calculated. OptimizeBy.TIME means fastest and OptimizeBy.DISTANCE means shortest.
    
    Returns:
    
    OptimizeBy value.
  - isReturnOptimalRoutesOnly
```
public boolean isReturnOptimalRoutesOnly()
```
    Returns whether to return only optimal route costs or complete route cost matrix.
    
    Returns:
    
    A boolean, true value means only optimal route costs, false means return complete route cost matrix.
  - 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 matrix calculation.
    
    Returns:
    
    Map of RoadType and their RoadTypePriority.
  - isMajorRoads
```
public boolean isMajorRoads()
```
    Returns whether the route matrix is calculated using only major roads or not.
    
    Returns:
    
    A boolean, true value means the route matrix 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, used while processing the request.
  - getVehicleAttr
```
public VehicleAttributes getVehicleAttr()
```
    Returns the Commercial Vehicle Restriction value used with this request.
    
    Returns:
    
    VehicleAttributes 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.
  - 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 GetRouteCostMatrixRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDistanceUnit

getTimeUnit

getStartPoints

getEndPoints

getOptimizeBy

isReturnOptimalRoutesOnly

getRoadTypePreferences

isMajorRoads

isAvoidTollRoad

getDestinationSrs

getHistoricSpeedBucket

getVehicleAttr

getDBResource

getUpdates

getLocalRoadsLoadFactor