Package com.here.sdk.routing

Class AvoidBoundingBoxAreaOptions

java.lang.Object
com.here.sdk.routing.AvoidBoundingBoxAreaOptions
public final class AvoidBoundingBoxAreaOptions extends Object

The options to specify rectangular shape which routes must not cross.

  • Field Details

    • avoidBoundingBoxArea

      @NonNull public GeoBox avoidBoundingBoxArea

      Area of rectangular shape which routes must not cross. Strictly enforced. Note: Violations are reported as [sdk.routing.SectionNoticeCode.VIOLATED_BLOCKED_ROAD]. This avoidance option is not supported for IsolineOptions. If it is defined for isoline calculation then an [sdk.routing.RoutingError.INVALID_PARAMETER] error is generated.

    • boundingBoxExceptionAreas

      @NonNull public List<GeoBox> boundingBoxExceptionAreas

      Areas of rectangular shape to exclude from avoidance.

    • polygonExceptionAreas

      @NonNull public List<GeoPolygon> polygonExceptionAreas

      Areas of polygon shape to exclude from avoidance.

    • corridorExceptionAreas

      @NonNull public List<GeoCorridor> corridorExceptionAreas

      Areas of corridor shape to exclude from avoidance. Note: Even though GeoCorridor.half_width_in_meters is an optional property in case of exception areas it is mandatory. Otherwise route calculation will fail with an [sdk.routing.RoutingError.INVALID_PARAMETER] error.

  • Constructor Details

    • AvoidBoundingBoxAreaOptions

      public AvoidBoundingBoxAreaOptions(@NonNull GeoBox avoidBoundingBoxArea)

      Creates a new instance.

      Parameters:
      avoidBoundingBoxArea -

      Area of rectangular shape which routes must not cross. Strictly enforced. Note: Violations are reported as [sdk.routing.SectionNoticeCode.VIOLATED_BLOCKED_ROAD]. This avoidance option is not supported for IsolineOptions. If it is defined for isoline calculation then an [sdk.routing.RoutingError.INVALID_PARAMETER] error is generated.

  • Method Details