routing library

Classes

Agency: Holds all the agency information.
AllowOptions: The options explicitly allowed by user for route calculations.
Attribution: Holds all the data on a URL address to an external resource.
AvoidanceOptions: The options to specify restrictions for route calculations.
AvoidBoundingBoxAreaOptions: The options to specify rectangular shape which routes must not cross.
AvoidCorridorAreaOptions: Area of corridor shape which routes must not cross and exceptions for this area.
AvoidPolygonAreaOptions: The options to specify polygon shape which routes must not cross.
BatterySpecifications: Parameters related to the electric vehicle's battery.
BicycleOptions: All the options to specify how a bicycle route should be calculated.
BusOptions: All the options to specify how a bus route should be calculated.
CarOptions: All the options to specify how a car route should be calculated.
ChargingActionDetails: Parameters related to the electric vehicle's charging action.
ChargingConnectorAttributes: Details of the connector that is suggested to be used in the section's PostAction's for charging.
ChargingStation: Data for an electric vehicle charging station.
ChargingStop: The options to specify a user-planned charging stop.
DynamicSpeedInfo: Provides estimated speed information.
ElectricVehicleOptions: These options define the parameters of the electric vehicle.
EmpiricalConsumptionModel: This model defines a data-driven energy consumption model for electric vehicles.
EVCarOptions: All the options to specify how a route for an electric car should be calculated.
EVConsumptionModel: Parameters specific for the electric vehicle, which are then used to calculate energy consumption on a given route.
EVMobilityServiceProviderPreferences: Defines preference level per known E-Mobility Service Provider.
EVTruckOptions: All the options to specify how a route for an electric truck should be calculated.
Fare: Holds all the fare data.
FarePassValidityPeriod: Specifies a temporal validity period for a pass
FarePrice: Price of a fare.
Isoline: Represents an isoline polygon around a center point.
IsolineOptions: Specifies options for isolines calculation.
IsolineOptionsCalculation: Specifies isoline parameters.
IsolineRoutingEngine: Use the IsolineRoutingEngine to calculate a reachable area from a center point.
LocalizedRoadNumber: Used to represent road number localized to specific language with optional direction and route type information.
LocalizedRoadNumbers: The list of multiple names or titles for the same entity, possibly in different languages.
Maneuver: This class provides all the information for a maneuver.
MapMatchedCoordinates: Information about the user defined coordinates and where they match to the map.
MaxAxleGroupWeight: MaxAxleGroupWeight contains all the restriction details violated by an axle group weight.
MaxSpeedOnSegment: New base speed for a segment.
PassThroughWaypoint: This structure provides all the information for a passthrough waypoint.
PedestrianOptions: All the options to specify how a pedestrian route should be calculated.
PhysicalConsumptionModel: Defines the physical consumption model for electric vehicles, using vehicle-specific parameters to calculate energy consumption along a route.
PostAction: An action that must be done after arrival, i.e.
PreAction: An action that must be done prior to the section, i.e.
PrivateBusOptions: All the options to specify how a private bus route should be calculated.
RefreshRouteOptions: The options to specify how to refresh an already calculated route identified by a RouteHandle.
RoadTexts: Textual attributes of road.
Route: A route is a path through a road network over which someone travels.
RouteHandle: Provides an opaque handle to the calculated Route.
RouteLabel: The main street name or road number for a route.
RouteOffset: Represents a specific location along the route.
RouteOptions: The options to specify how the route will be calculated.
RoutePlace: The location information.
RouteRailwayCrossing: Contains information about railway crossing.
RouteStop: Route stop that should be used together with import route functionality.
RouteTextOptions: Specify how textual output should be provided.
RoutingConnectionSettings: Defines the settings for the retry logic when connecting to the HERE routing backend.
RoutingEngine: Use the RoutingEngine to calculate a route from A to B with a number of waypoints in between.
RoutingInterface: Provides the abstract class for the online and offline routing engines.
RoutingOptions: The options defines how a route should be calculated.
ScooterOptions: All the options to specify how a scooter route should be calculated.
Section: A section is a part of the route between two stopovers.
SectionNotice: Explains an issue encountered in a Section.
SegmentReference: Reference to a segment id with a travel direction.
Signpost: Signpost information.
SignpostLabel: Details of a signpost representing a particular direction or destination.
Span: A span is a part of the Section which is traversable or navigable.
TaxiOptions: All the options to specify how a taxi route should be calculated.
TextUsageOptions: Specify whether the text should be used when generating notification.
Toll: This struct presents all the data for a toll.
TollFare: This struct presents all the fare data for a toll.
TollFarePass: TollFare multi-travel pass characteristics.
TollOptions: The option to specify how the tolls should be calculated.
TrafficIncidentOnRoute: Traffic incidents on a route.
TrafficOnRoute: Traffic information on a route.
TrafficOnSection: Traffic information on a section.
TrafficOnSpan: Traffic information of a span along a route.
TransitDeparture: This struct holds the transit departure or arrival information.
TransitIncident: A transit incident describes disruptions on the transit network.
TransitRouteOptions: All the options to specify how a public transit route should be calculated.
TransitRoutingEngine: Use the TransitRoutingEngine to calculate a public transit route from A to B with a number of waypoints in between.
TransitSectionDetails: Gives the details of a transit section.
TransitStop: A transit stop between the departure and destination of a transit section.
TransitTransport: Holds all the transit transport information.
TransitWaypoint: Represents a transit waypoint, used as input for transit route calculation.
TruckOptions: All the options to specify how a truck route should be calculated.
VehicleRestrictionMaxWeight: VehicleRestrictionMaxWeight contains max permitted weight during the trip, in kilograms, along with the specific type of maximum permitted weight restriction.
ViolatedRestriction: ViolatedRestriction contains all the violated restriction details for the planned trip.
ViolatedRestrictionDetails: Optional restriction details, contains additional information depending on the specific violation, zero or more member might be set.
Waypoint: Represents a waypoint, used as input for route calculation.

Enums

AccessAttributes: Types of access attributes.
AttributionType: Attribution link type.
ChargingConnectorType: Available charging connector types.
ChargingSupplyType: Available charging supply types.
FarePassValidityPeriodType: Specifies validity periods.
FarePriceType: Type of price represented by a FarePrice object.
FareReason: Reason for the cost.
FunctionalRoadClass: Types of function road class.
IsolineCalculationMode: Specifies how isoline calculation is optimized.
IsolineRangeType: Specifies the type of one or more range values to be included in the isoline.
LocalizedTextPreference: Indicates the option of localized text usage.
ManeuverAction: Maneuver action type.
MatchSideOfStreet: Specifies how the location set by Waypoint.sideOfStreetHint should be handled.
NoticeSeverity: Describes the impact a notice has on the resource to which the notice is attached.
OptimizationMode: Identifiers for different optimizations that can be used during the route calculation while trying to keep the quality of the route being calculated high.
PaymentMethod: Available payment methods.
PostActionType: Identifies the action type.
PreActionType: Identifies the action type.
RoadFeatures: Road features or states.
RouteLabelType: Identifies the type of the route label.
RoutePlaceDirection: Specifies the direction to make distinction between departure and arrival cases.
RoutePlaceType: Identifies the route place type.
RouteRailwayCrossingType: Identify possible type of route railway crossing.
RoutingError: Specifies possible errors that may result from the calculation of a route.
SectionNoticeCode: Notice codes which point the issues encountered during processing of a Section.
SectionTransportMode: Specifies the Section mode of transport.
SideOfDestination: Specifies the side of street on which the destination is located.
StreetAttributes: Types of street attributes.
TollOptionsEmissionType: Supported options of emission type
TollOptionsVehicleCategory: Supported options of vehicle category for toll calculation.
TrafficOptimizationMode: Traffic optimization mode that defines whether and what kind of traffic information should be considered during route calculation.
TransitDepartureStatus: Status of a departure.
TransitIncidentEffect: Transit incident effect.
TransitIncidentType: Transit incident type.
TransitMode: Public transit mode
TransitModeFilter: Filtering mode for public transit.
TravelDirection: Travel direction.
VehicleRestrictionMaxWeightType: This enum represents the specific type of the maximum permitted weight restriction.
WalkAttributes: Types of walk attributes.
WaypointType: Defines if the waypoint is a stop over, or a hint for a desired polyline of a route.
ZoneCategory: Identifies categories of zones which routes avoid going through when used in AvoidanceOptions.

Typedefs

CalculateIsolineCallback = void Function(RoutingError? routingError, List<Isoline>? isolines): A function which is called by the RoutingEngine after isoline calculation has completed.
CalculateRouteCallback = void Function(RoutingError? routingError, List<Route>? routeList): A function which is called by the RoutingEngine after route calculation has completed.
CalculateTrafficOnRouteCallback = void Function(RoutingError? routingError, TrafficOnRoute? trafficOnRoute): A function which is called by the RoutingEngine after route traffic calculation has completed.

Classes

Enums

Typedefs

here_sdk package

routing library