Types of access attributes.

Holds all the agency information.

The options explicitly allowed by user for route calculations.

Holds all the data on a URL address to an external resource.

Attribution link type.

The options to specify restrictions for route calculations.

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

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

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

Parameters related to the electric vehicle’s battery.

All the options to specify how a bicycle route should be calculated.

All the options to specify how a bus route should be calculated.

All the options to specify how a car route should be calculated.

A function which is called by the RoutingEngine after isoline calculation has completed. It is always called on the main thread. The first argument is the error in case of a failure. It is nil for an operation that succeeds. The second argument holds a list of calculated isolines. The list is nil in case of an error. The size of the list matches the size of the provided sdk.routing.IsolineOptions.range_values: For each range limit, one isoline is calculated.

A function which is called by the RoutingEngine after route calculation has completed. It is always called on the main thread. The first argument is the error in case of a failure. It is nil for an operation that succeeds. The second argument is the calculated routes. It is nil in case of an error.

A function which is called by the RoutingEngine after route traffic calculation has completed. It is always called on the main thread. The first argument is the error in case of a failure. It is nil for an operation that succeeds. The second argument is the calculated route traffic. It is nil in case of an error.

Parameters related to the electric vehicle’s charging action.

Details of the connector that is suggested to be used in the section’s PostAction‘s for charging.

Available charging connector types.

Data for an electric vehicle charging station.

The options to specify a user-planned charging stop. Note: In order to specify this ChargingStop, it is also required to set [sdk.routing.BatterySpecifications.total_capacity_in_kilowatt_hours], [sdk.routing.BatterySpecifications.initial_charge_in_kilowatt_hours], and [sdk.routing.BatterySpecifications.charging_curve]. Without all of them, the route calculation will fail as an invalid parameter error.

Available charging supply types.

Provides estimated speed information.

These options define the parameters of the electric vehicle. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

This model defines the empirical consumption mode used in electric vehicles.

Parameters specific for the electric vehicle, which are then used to calculate energy consumption on a given route. At minimum, you must provide EmpiricalConsumptionModel.ascentConsumptionInWattHoursPerMeter, EmpiricalConsumptionModel.descentRecoveryInWattHoursPerMeter and a EmpiricalConsumptionModel.freeFlowSpeedTable. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

All the options to specify how a route for an electric car should be calculated. At minimum, a valid EVConsumptionModel must be set or the route calculation will fail.
Note: EVCarOptions.ensureReachability must be true to make sure that all stopovers are reachable. For this, charging stations may be added to the route. If EVCarOptions.ensureReachability is true, you need to specify the required route options and battery specifications that include the current charge level of the battery (BatterySpecifications.initialChargeInKilowattHours). See the parameter description below for more details.

A charging pool for electric vehicles is an area equipped with one or more charging stations.

Use PlaceCategory.businessAndServicesEvChargingStation to find stations. In the Details of a Place result you can find the list of found pools containing stations, if any.

For offline EV rich attributes, also enable LayerConfiguration.Feature.ev in SDKOptions.layerConfiguration.

Group of connectors for electrical vehicles, defined by a common charging connector type and max power level.

Use PlaceCategory.businessAndServicesEvChargingStation to find stations. In the Details of a Place result you can find the list of found pools containing stations, if any.

For offline EV rich attributes, also enable LayerConfiguration.Feature.ev in SDKOptions.layerConfiguration.

Parameters specific for the electric vehicle, which are then used to calculate energy consumption on a given route. At minimum, you must provide EVConsumptionModel.ascentConsumptionInWattHoursPerMeter, EVConsumptionModel.descentRecoveryInWattHoursPerMeter and a EVConsumptionModel.freeFlowSpeedTable.

Defines preference level per known E-Mobility Service Provider. The E-Mobility Service Provider ID partner id as received from https://www.here.com/docs/bundle/ev-charge-points-api-developer-guide/page/topics/resource-roamings.html An alternative way to get partnerId is the eMobilityServiceProviders.partnerId as part of HERE SDK Search. Maximum number of E-Mobility Service Providers is limited to 10 across all preference. Defaults to using all available providers with no prioritization.

All the options to specify how a route for an electric truck should be calculated.

Holds all the fare data.

Price of a fare.

Type of price represented by a FarePrice object.

Reason for the cost.

Types of function road class.

Identifiers for different types of hazardous materials which can be shipped by the truck.

Represents an isoline polygon around a center point. Any possible route between the center and any point on the edges of the polygon can be travelled within the given range restriction. The edges of the polygon are not guaranteed to be on the road as all reachable road endpoints are smoothened to fit into one polygon shape. This process can be influenced by setting IsolineOptions.Calculation.maxPoints.

Specifies how isoline calculation is optimized.

Specifies options for isolines calculation.

Specifies the type of one or more range values to be included in the isoline. This value defines the restriction that is used to calculate the reachable area.

Use the IsolineRoutingEngine to calculate a reachable area from a center point. The calculation is done asynchronously and requires an online connection.

Indicates the option of localized text usage.

This class provides all the information for a maneuver. The directional information (e.g. road names, road numbers and signpost direction) is stored in Maneuver.roadTexts and Maneuver.nextRoadTexts attributes. As for the motorway exit information, it can be obtained from Maneuver.exitSignTexts attribute.

Maneuver action type.

Information about the user defined coordinates and where they match to the map.

Specifies how the location set by Waypoint.sideOfStreetHint should be handled. This setting might affect the geometry of the resulting route.

MaxAxleGroupWeight contains all the restriction details violated by an axle group weight.

New base speed for a segment. Affects route calculation and the ETA. Cannot increase base speed on segment.

Note: This option can only be used with the RoutingEngine. The OfflineRoutingEngine is not supported and the option will be ignored. Note that the OfflineRoutingEngine is only available for editions such as the Navigate Edition.

Describes the impact a notice has on the resource to which the notice is attached.

Identifiers for different optimizations that can be used during the route calculation while trying to keep the quality of the route being calculated high. The route is considered to be of low quality if it gives the traveler an unpleasant experience, such as having difficult turns or having a lot of turns in general. For example, if there are two possible routes from A to B, one with a length of 1000m and 10 turns, and another with a length of 1050m and only one turn, the second one will be returned as the shortest, although it is 50m longer. Yet, it contains only one turn and it is therefore considered to provide a better traveler experience.

This structure provides all the information for a passthrough waypoint. The location information and offset of the waypoint are stored in PassThroughWaypoint.place and PassThroughWaypoint.offset respectively.

Available payment methods.

All the options to specify how a pedestrian route should be calculated.

Defines the physical consumption model for electric vehicles, using vehicle-specific parameters to calculate energy consumption along a route. Note: [sdk.transport.VehicleSpecification.current_weight_in_kilograms] must be set. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

An action that must be done after arrival, i.e. completing a section in the route.

Identifies the action type.

An action that must be done prior to the section, i.e. boarding a ferry.

Identifies the action type.

All the options to specify how a private bus route should be calculated.

The options to specify how to refresh an already calculated route identified by a RouteHandle. All the options that may result in a new route shape are ignored as no new route is calculated. Instead, only the data that accompanies a route, such as traffic information, can be refreshed. Therefore, the following route options are ignored: RouteOptions.alternatives, RouteOptions.arrivalTime, and RouteOptions.optimizationMode. If new AvoidanceOptions are specified, they are ignored as well and instead new SectionNotice‘s are generated that indicate where the requested AvoidanceOptions are violated. Note that when EVCarOptions.ensureReachability is set to true, the route refresh request will fail as this option is incompatible with a fixed route shape. If any of the ignored options are important, consider calculating a new route instead.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Road features or states.

Textual attributes of road.

A route is a path through a road network over which someone travels.

Note: Each Section of a route contains a list of SectionNotice objects that describe potential issues after the route was calculated. If the list is non-empty, it is recommended to evaluate possible violations against the requested route options and reject the route if deemed necessary.

Provides an opaque handle to the calculated Route. A handle encodes the calculated route. The route can be decoded from a handle at a later point in time as long as the service uses the same map data which was used during encoding. Note that the Route.routeHandle is provided only if RouteOptions.enableRouteHandle is set before route calculation. A RouteHandle generated by the online RoutingEngine is not compatible with the OfflineRoutingEngine. Similarly, a RouteHandle from the OfflineRoutingEngine cannot be used with the online RoutingEngine. Using an incompatible RouteHandle results in a RoutingError.

The main street name or road number for a route. A route can contain more than one such street name or route number. To include route labels in the route response, enable it using RouteOptions.enableRouteLabels.

Identifies the type of the route label.

Represents a specific location along the route. A RouteOffset is a location on the route defined by the section index and the distance in meters from the start of that section to the specified location on the route. An offset in meters indicates the distance that needs to be traveled to reach a specific location along the route, such as a railway crossing. For the latter case, the location of a railway crossing can be retrieved from RouteRailwayCrossing.coordinates.

The options to specify how the route will be calculated.

The location information.

Specifies the direction to make distinction between departure and arrival cases.

Identifies the route place type.

Contains information about railway crossing.

Identify possible type of route railway crossing.

Route stop that should be used together with import route functionality. It specifies location index within provided route locations track. Route stop can have additional stop delay, which will be included in expected time to arrival. During navigation the stop will be treated as stopover and will be reported as milestone when passing-by. Only available for the Navigate licence.

Specify how textual output should be provided.

Defines the settings for the retry logic when connecting to the HERE routing backend.

When a timeout is triggered, the next connection attempt starts with a increased timeout. new_timeout = initial_timeout + increment * retry_count

Use the RoutingEngine to calculate a route from A to B with a number of waypoints in between.

Route calculation is done asynchronously and requires an online connection. The resulting route contains various information such as the polyline, route length in meters, estimated time to traverse along the route and maneuver data.

Note: The engine does not support an unlimited number of waypoints. The limit is defined by the HERE backend services and may change. For now, the maximum number of waypoints should be below 200. This value may change and it is not guaranteed to be stable. If you need to support very large lists of waypoints, consider to import a route (see importRoute() method) or use the OfflineRoutingEngine which supports an unlimited number of waypoints. The OfflineRoutingEngine is only available for Navigate licence.

Specifies possible errors that may result from the calculation of a route.

The options defines how a route should be calculated.

The options are used for all transport modes and engines.

** Electric vehicle specific requirements ** Electric vehicle consumption are estimated when at least one consumption model is defined. Currently two models are supported:

• PhysicalConsumptionModel Aside from the values in PhysicalConsumptionModel additionally these values needs to be defined:
  • RoutingOptions.transport_specification.vehicle_specification.current_weight_in_kilograms
  • Additionally Waypoint.currentWeightChangeInKilograms can be defined.
• EmpiricalConsumptionModel

By setting ElectricVehicleOptions.ensureReachability the RoutingEngine inserts additional charging stations to reach the waypoints. This feature requires setting the BatterySpecifications. By default a vehicle might not reach the waypoint, when the initial charge is not enough to reach all waypoints. See the parameter description below for more details.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Provides the protocol for the online and offline routing engines.

All the options to specify how a scooter route should be calculated.

A section is a part of the route between two stopovers. A stopover is a location on the route where a stop is made.

Note: A section contains a list of SectionNotice objects that describe potential issues after the route was calculated. If the list is non-empty, it is recommended to evaluate possible violations against the requested route options and reject the route if deemed necessary.

Explains an issue encountered in a Section.

Notice codes which point the issues encountered during processing of a Section.

Note: The section notice codes are going to be extended for new error situations.

Specifies the Section mode of transport. A Section may have a different transport mode than the one specified for route calculation. For example, a car route may have a section having ferry transport mode.

Reference to a segment id with a travel direction.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Specifies the side of street on which the destination is located.

Signpost information.

Details of a signpost representing a particular direction or destination.

Types of street attributes.

A span is a part of the Section which is traversable or navigable. Each span usually has some geometry associated with it.

All the options to specify how a taxi route should be calculated. See, TransportMode.taxi.

Note: Specify the optional Waypoint.sideOfStreetHint to indicate at which side of the street a passenger wants to leave the taxi.

Specify whether the text should be used when generating notification.

This struct presents all the data for a toll.

Note: If you’re using the OfflineRoutingEngine, be aware that this feature is currently in beta. As a result, there may be some bugs or unexpected behaviors. Additionally, this feature and related APIs may be updated in future releases without going through the deprecation process. Note that the OfflineRoutingEngine is only available in editions like the Navigate Edition. If you’re using the RoutingEngine, this feature is considered to be stable.

This struct presents all the fare data for a toll.

Note: If you’re using the OfflineRoutingEngine, be aware that this feature is currently in beta. As a result, there may be some bugs or unexpected behaviors. Additionally, this feature and related APIs may be updated in future releases without going through the deprecation process. Note that the OfflineRoutingEngine is only available in editions like the Navigate Edition. If you’re using the RoutingEngine, this feature is considered to be stable.

The option to specify how the tolls should be calculated. Note Not used for offline calculations.

Traffic information on a route. Information for the already traveled portion of the route is omitted.

Traffic information of a span along a route.

Traffic information on a section.

This struct holds the transit departure or arrival information.

Status of a departure.

A transit incident describes disruptions on the transit network. Disruptions scale from delays to service cancellations.

Transit incident effect.

Transit incident type.

Public transit mode

Filtering mode for public transit.

Traffic optimization mode that defines whether and what kind of traffic information should be considered during route calculation.

All the options to specify how a public transit route should be calculated.

Use the TransitRoutingEngine to calculate a public transit route from A to B with a number of waypoints in between. Route calculation is done asynchronously and requires an online connection. The resulting route contains various information such as the polyline, route length in meters, estimated time to traverse along the route and maneuver data.

Gives the details of a transit section.

A transit stop between the departure and destination of a transit section.

Holds all the transit transport information.

Represents a transit waypoint, used as input for transit route calculation.

Travel direction.

All the options to specify how a truck route should be calculated.

Truck specifications contain vehicle related attributes. Examples: Dimensions, weight, axle count. Only the fields that are set are considered for restriction handling.

Specifies the type of truck.

Specifies the tunnel categories.

Tunnels are categorized from B (low risk, few restrictions) to E (high risk) based on their safety features and the potential danger posed by the goods transported through them.

VehicleRestrictionMaxWeight contains max permitted weight during the trip, in kilograms, along with the specific type of maximum permitted weight restriction.

VehicleRestrictionMaxWeightType represents the specific type of the maximum permitted weight restriction. NOTES: A restriction of type UNKNOWN may change to GROSS or CURRENT when data becomes available in future. A restriction of type GROSS or CURRENT may also change to a different type if actual regulation changes.

Contains vehicle related attributes. Examples: Dimensions, weight, axle count. Only the fields that are set are considered for restriction handling. Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

ViolatedRestriction contains all the violated restriction details for the planned trip.

Types of walk attributes.

Represents a waypoint, used as input for route calculation.

Defines if the waypoint is a stop over, or a hint for a desired polyline of a route.

Identifies categories of zones which routes avoid going through when used in AvoidanceOptions.