AvoidanceOptions (API Reference)
Class AvoidanceOptions
The options to specify restrictions for route calculations.
-
Field Summary
FieldsModifier and TypeFieldDescriptionList of rectangular shapes which routes must not cross and additional options for this area.List of corridor shapes which routes must not cross and additional options for this area.Specifies a list of avoided truck road types for vehicle.List of polygon shapes which routes must not cross and additional options for this area.Countries that the route must avoid.Exception toAvoidanceOptions.zone_categories, which can be specified by list of zone identifiers.Features which routes should avoid.Segments that routes will avoid going through.Zone categories which routes must not cross.List containing identifiers of zones that routes should avoid going through. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
roadFeatures
Features which routes should avoid. Best effort only (not enforced).
-
countries
Countries that the route must avoid. Strictly enforced. Violations are reported as
SectionNoticeCode.VIOLATED_BLOCKED_ROAD. Note: This avoidance option is not supported inIsolineOptionsfor isoline calculation. -
avoidBoundingBoxAreasOptions
List of rectangular shapes which routes must not cross and additional options for this area.
-
avoidPolygonAreasOptions
List of polygon shapes which routes must not cross and additional options for this area. Note: Currently, the maximum count of polygons is limited to 20.
-
avoidCorridorAreasOptions
List of corridor shapes which routes must not cross and additional options for this area. Note: Currently, the maximum count of corridors is limited to 20.
-
zoneCategories
Zone categories which routes must not cross. Strictly enforced. Violations are reported as
SectionNoticeCode.VIOLATED_ZONE_RESTRICTION. -
segments
Segments that routes will avoid going through. Violations are reported as
SectionNoticeCode.VIOLATED_BLOCKED_ROAD.Notes:
- This avoidance option is not supported in
IsolineOptionsfor isoline calculation. - The engine does not support an unlimited number of segments to avoid. The limit is defined by the HERE backend services and may change. For now, the maximum number of segments to avoid should be below 250. This value may change on the backend and it is therefore not guaranteed to be stable.
- This avoidance option is not supported in
-
exceptZoneIds
Exception to
AvoidanceOptions.zone_categories, which can be specified by list of zone identifiers. e.g. the format of ID is likehere:cm:envzone:2. Information about the various routing zones originates from the respective catalogs of platform.here.com. For example, more information on zone IDs for Environmental Zones is available under "https://platform.here.com/data/hrn:here:data::olp-here:rib-2/environmental-zones/overview". -
zoneIds
List containing identifiers of zones that routes should avoid going through. e.g. the format of ID is like
here:cm:envzone:2. Information about the various routing zones originates from the respective catalogs of platform.here.com. For example, more information on zone IDs for Environmental Zones is available under "https://platform.here.com/data/hrn:here:data::olp-here:rib-2/environmental-zones/overview". -
avoidedTruckRoadTypes
Specifies a list of avoided truck road types for vehicle. Refer to
TruckRoadTypefor the available options.
-
-
Constructor Details
-
AvoidanceOptions
public AvoidanceOptions()Creates a new instance.
-
-
Method Details