GetTravelBoundaryRequest (GRA 3.0.1 API)

java.lang.Object
- com.pb.routing.gra.boundary.GetTravelBoundaryRequest

All Implemented Interfaces:

Serializable
```
public final class GetTravelBoundaryRequest
extends Object
implements Serializable
```
Request object to be used while generating an IsoChrone or IsoDistance geometry. Request can either be IsoChrone or IsoDistance but can't be both. So one of TimeUnit and LinearUnit should always be null.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GetTravelBoundaryRequest.Builder
Builder class to create GetTravelBoundaryRequest object.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<RoadType,Double>`	`getAmbientSpeeds()` Returns the Ambient speeds for each road type.
`VelocityUnit`	`getAmbientSpeedUnit()` Returns the Ambient Speed Unit which is being used for this request.
`BandingStyle`	`getBandingStyle()` Returns the `BandingStyle` associated with this request.
`double[]`	`getCosts()` Returns costs associated with this request.
`String`	`getDBResource()` Returns the name of Database resource which is being used to run this request.
`double`	`getDefaultAmbientSpeed()` Returns default Ambient Speed being used for this request.
`double`	`getDefaultPropagationFactor()` Returns the propagation factor used in the calculation of the iso.
`CoordSys`	`getDestinationSrs()` Returns the Destination Coordinate System associated with this request.
`HistoricSpeedBucket`	`getHistoricSpeedBucket()` Returns the Historic Traffic time bucket used with this request.
`LinearUnit`	`getLinearUnit()` Returns the Linear Unit for IsoDistance request.
`double`	`getMaxOffRoadDistance()` Returns the maximum Off-Road Distance associated with this request.
`LinearUnit`	`getMaxOffRoadDistanceUnit()` Returns the maximum Off-Road Distance Unit associated with this request.
`IPoint`	`getPoint()` Returns the point for which this request was created.
`Map<RoadType,Double>`	`getPropagationFactorOverride()` Returns the map of `RoadType` that have overridden propagation factors and the corresponding propagationFactor value.
`double`	`getSimplificationFactor()` Returns the Simplification Factor associated with this request.
`TimeUnit`	`getTimeUnit()` Returns the Time Unit for IsoChrone request.
`boolean`	`isAvoidTollRd()` This method returns whether avoid toll road option is set or not.
`boolean`	`isMajorRoads()` Returns whether boundary is calculated using only major roads only or not.
`boolean`	`isReturnHoles()` Returns whether holes are returned while processing this request.
`boolean`	`isReturnIslands()` Returns whether islands are returned while processing this request.

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

- Method Detail
  - getPoint
```
public IPoint getPoint()
```
    Returns the point for which this request was created.
    
    Returns:
    
    IPoint, the point for which this request was created.
  - getTimeUnit
```
public TimeUnit getTimeUnit()
```
    Returns the Time Unit for IsoChrone request.
    
    Returns:
    
    Null if request is IsoDistance otherwise associated TimeUnit
  - getLinearUnit
```
public LinearUnit getLinearUnit()
```
    Returns the Linear Unit for IsoDistance request.
    
    Returns:
    
    Null if request is IsoChrone otherwise associated LinearUnit
  - getCosts
```
public double[] getCosts()
```
    Returns costs associated with this request.
    
    Returns:
    
    double array containing the costs associated with this request.
  - getMaxOffRoadDistance
```
public double getMaxOffRoadDistance()
```
    Returns the maximum Off-Road Distance associated with this request.
    
    Returns:
    
    double value of maxOffRoadDistance.
  - getMaxOffRoadDistanceUnit
```
public LinearUnit getMaxOffRoadDistanceUnit()
```
    Returns the maximum Off-Road Distance Unit associated with this request.
    
    Returns:
    
    LinearUnit used as maxOffRoadDistanceUnit.
  - isReturnHoles
```
public boolean isReturnHoles()
```
    Returns whether holes are returned while processing this request.
    
    Returns:
    
    A boolean, true if holes are returned in response, false otherwise.
  - isReturnIslands
```
public boolean isReturnIslands()
```
    Returns whether islands are returned while processing this request.
    
    Returns:
    
    A boolean, true if islands are returned in response, false otherwise.
  - getSimplificationFactor
```
public double getSimplificationFactor()
```
    Returns the Simplification Factor associated with this request.
    
    Returns:
    
    double value of Simplification Factor.
  - isMajorRoads
```
public boolean isMajorRoads()
```
    Returns whether boundary is calculated using only major roads only or not.
    
    Returns:
    
    A boolean, true value means boundary is calculated using major roads only, false means minor roads are also considered.
  - getDestinationSrs
```
public CoordSys getDestinationSrs()
```
    Returns the Destination Coordinate System associated with this 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.
  - getBandingStyle
```
public BandingStyle getBandingStyle()
```
    Returns the BandingStyle associated with this request.
    
    Returns:
    
    BandingStyle associated with this request.
  - getAmbientSpeeds
```
public Map<RoadType,Double> getAmbientSpeeds()
```
    Returns the Ambient speeds for each road type.
    
    Returns:
    
    Map of Ambient speed road types.
  - getDefaultAmbientSpeed
```
public double getDefaultAmbientSpeed()
```
    Returns default Ambient Speed being used for this request.
    
    Returns:
    
    double value of default Ambient Speed.
  - getAmbientSpeedUnit
```
public VelocityUnit getAmbientSpeedUnit()
```
    Returns the Ambient Speed Unit which is being used for this request.
    
    Returns:
    
    Velocity being used for this request.
  - getDBResource
```
public String getDBResource()
```
    Returns the name of Database resource which is being used to run this request.
    
    Returns:
    
    Name of the Database resource.
  - getDefaultPropagationFactor
```
public double getDefaultPropagationFactor()
```
    Returns the propagation factor used in the calculation of the iso. This property only applies to isodistances, i.e. an iso with a distance unit.
    
    Returns:
    
    The propagation factor.
  - getPropagationFactorOverride
```
public Map<RoadType,Double> getPropagationFactorOverride()
```
    Returns the map of RoadType that have overridden propagation factors and the corresponding propagationFactor value. Propagation factor applies only to isodistances, i.e. an iso with a distance unit.
    
    Returns:
    
    The road types that are overridden.
  - isAvoidTollRd
```
public boolean isAvoidTollRd()
```
    This method returns whether avoid toll road option is set or not.
    
    Returns:

Class GetTravelBoundaryRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getPoint

getTimeUnit

getLinearUnit

getCosts

getMaxOffRoadDistance

getMaxOffRoadDistanceUnit

isReturnHoles

isReturnIslands

getSimplificationFactor

isMajorRoads

getDestinationSrs

getHistoricSpeedBucket

getBandingStyle

getAmbientSpeeds

getDefaultAmbientSpeed

getAmbientSpeedUnit

getDBResource

getDefaultPropagationFactor

getPropagationFactorOverride

isAvoidTollRd