AvoidCorridorAreaOptions Structure Reference
- Last UpdatedJun 10, 2025
- 1 minute read
public struct AvoidCorridorAreaOptions : Hashable
Area of corridor shape which routes must not cross and exceptions for this area.
-
Area of corridor shape which routes must not cross. Strictly enforced. Violations are reported as
SectionNoticeCode.violatedBlockedRoad
. Note: This avoidance option is not supported forIsolineOptions
. If it is defined for isoline calculation then an [sdk.routing.RoutingError.INVALID_PARAMETER] error is generated. Even thoughGeoCorridor.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.Declaration
Swift
public var avoidCorridorArea: GeoCorridor
-
Areas of rectangular shape to exclude from avoidance.
Declaration
Swift
public var boundingBoxExceptionAreas: [GeoBox]
-
Areas of polygon shape to exclude from avoidance.
Declaration
Swift
public var polygonExceptionAreas: [GeoPolygon]
-
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.Declaration
Swift
public var corridorExceptionAreas: [GeoCorridor]
-
Creates a new instance.
Declaration
Swift
public init(avoidCorridorArea: GeoCorridor, boundingBoxExceptionAreas: [GeoBox] = [], polygonExceptionAreas: [GeoPolygon] = [], corridorExceptionAreas: [GeoCorridor] = [])