Package com.here.sdk.routing

Class AvoidPolygonAreaOptions

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

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

    • Field Detail

      • avoidPolygonArea

        @NonNull
public GeoPolygon avoidPolygonArea

        Area of polygon 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.

      • boundingBoxExceptionAreas

        @NonNull
public java.util.List<GeoBox> boundingBoxExceptionAreas

        Areas of rectangular shape to exclude from avoidance.

      • polygonExceptionAreas

        @NonNull
public java.util.List<GeoPolygon> polygonExceptionAreas

        Areas of polygon shape to exclude from avoidance.

      • corridorExceptionAreas

        @NonNull
public java.util.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 Detail

      • AvoidPolygonAreaOptions

        public AvoidPolygonAreaOptions​(@NonNull
                               GeoPolygon avoidPolygonArea)

        Creates a new instance.

        Parameters:
        avoidPolygonArea -

        Area of polygon 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.

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object