Package com.here.sdk.routing

Class AvoidCorridorAreaOptions

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

Area of corridor shape which routes must not cross and exceptions for this area.

  • Field Details

    • avoidCorridorArea

      @NonNull public GeoCorridor avoidCorridorArea

      Area of corridor shape which routes must not cross. Strictly enforced. Violations are reported as SectionNoticeCode.VIOLATED_BLOCKED_ROAD. Note: 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. 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.

    • 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

    • AvoidCorridorAreaOptions

      public AvoidCorridorAreaOptions(@NonNull GeoCorridor avoidCorridorArea)

      Creates a new instance.

      Parameters:
      avoidCorridorArea -

      Area of corridor shape which routes must not cross. Strictly enforced. Violations are reported as SectionNoticeCode.VIOLATED_BLOCKED_ROAD. Note: 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. 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.

  • Method Details