RoutingOptions

open class RoutingOptions : RoutingOptionsWithItinerary

Represents the parameters used for route planning.

Important

This is a Public Preview API. It may be changed or removed at any time.

Public

  • Requested sequence of points that a route should visit

    Declaration

    Swift

    public let itinerary: Itinerary

  • Departure date/time

    Declaration

    Swift

    public let departAt: Date?

  • What data should be reported for diagnosis

    Declaration

    Swift

    public let reportType: ReportType?

  • Auxiliary power in kW

    Declaration

    Swift

    public let auxiliaryPowerInkW: Float?

  • Something that the route calculation should try to avoid: borders, motorways, tunnels etc.

    Declaration

    Swift

    public let avoidTypes: [AvoidType]?

  • Extended parameters values for the route: travel time, distance

    Declaration

    Swift

    public let extendedRouteRepresentation: [ExtendedRouteRepresentation]?

  • How much detail should be included about the set of routes in the response

    Declaration

    Swift

    public let routeRepresentation: RouteRepresentation?

  • Types of cargo that may be classified as hazardous materials and restricted from some roads

    Declaration

    Swift

    public let vehicleLoadType: VehicleLoadType?

  • Length of the vehicle

    Declaration

    Swift

    public let vehicleLength: Measurement<UnitLength>?

  • Width of the vehicle

    Declaration

    Swift

    public let vehicleWidth: Float?

  • Height of the vehicle

    Declaration

    Swift

    public let vehicleHeight: Float?

  • Axle weight of the vehicle

    Declaration

    Swift

    public let vehicleAxleWeight: Measurement<UnitMass>?

  • Max speed of the vehicle

    Declaration

    Swift

    public let vehicleMaxSpeed: Measurement<UnitSpeed>?

  • Whether the vehicle is commercial or not

    Declaration

    Swift

    public let vehicleCommercial: Bool?

  • Optional code specifying the ADR tunnel restrictions that the vehicle is subject to, if any.

    Declaration

    Swift

    public let vehicleAdrTunnelRestrictionCode: ADRTunnelRestrictionCode?

  • Precision of the coordinates to be returned

    Declaration

    Swift

    public let coordinatePrecision: CoordinatePrecision?

  • Number of kWh consumption per hundred km with specific constant speed

    Declaration

    Swift

    public let constantSpeedConsumptionInkWhPerHundredkm: [Float : Float]?

  • Weight of the vehicle

    Declaration

    Swift

    public let vehicleWeight: Measurement<UnitMass>?

  • Acceleration efficiency

    Declaration

    Swift

    public let accelerationEfficiency: Float?

  • Deceleration efficiency

    Declaration

    Swift

    public let decelerationEfficiency: Float?

  • Uphill efficiency

    Declaration

    Swift

    public let uphillEfficiency: Float?

  • Downhill efficiency

    Declaration

    Swift

    public let downhillEfficiency: Float?

  • Current charge in kWh

    Declaration

    Swift

    public let currentChargeInkWh: Float?

  • Maximum charge in kWh

    Declaration

    Swift

    public let maxChargeInkWh: Float?

  • Type of the vehicle engine (e.g., electric)

    Declaration

    Swift

    public let vehicleEngineType: EngineType?

  • How guidance instructions will be returned: plain text, verbal message etc.

    Declaration

    Swift

    public let instructionsType: InstructionsType

  • Language

    Declaration

    Swift

    public let language: String?

  • Current heading of the vehicle

    Declaration

    Swift

    public let vehicleHeading: Int?

  • Type of route to plan: fast, short, efficient etc.

    Declaration

    Swift

    public let routeType: RouteType?

  • How the route will be traveled: car, truck, bicycle, pedestrian etc.

    Declaration

    Swift

    public let travelMode: TravelMode?

  • Arrival date/time

    Declaration

    Swift

    public let arriveAt: Date?

  • The number of alternative routes to propose

    Declaration

    Swift

    public let maxAlternatives: Int?

  • Number of liters consumption per hundred km at a specific constant speed

    Declaration

    Swift

    public let constantSpeedConsumptionInLitersPerHundredkm: [Float : Float]?

  • Current fuel level in liters

    Declaration

    Swift

    public let currentFuelInLiters: Float?

  • Amount of fuel used by auxiliary systems such as air conditioning, in liters per hour

    Declaration

    Swift

    public let auxiliaryPowerInLitersPerHour: Float?

  • Fuel energy density in MegaJoules per liter

    Declaration

    Swift

    public let fuelEnergyDensityInMJoulesPerLiter: Float?

  • What types of alternative routes can be searched for: all, better etc.

    Declaration

    Swift

    public let alternativeType: AlternativeType?

  • Minimum deviation distance

    Declaration

    Swift

    public let minDeviationDistance: Int?

  • Minimum deviation time

    Declaration

    Swift

    public let minDeviationTime: Int?

  • Which section types should be reported for the planned routes: tunnel, motorway, toll road, etc.

    Declaration

    Swift

    public let sectionTypes: [SectionType]?

  • Whether current traffic should be considered when planning the route

    Declaration

    Swift

    public let considerTraffic: Bool?

  • Degree of hilliness for a thrilling route

    Declaration

    Swift

    public let hilliness: Hilliness?

  • Degree that the route winds in a thrilling route

    Declaration

    Swift

    public let windingness: Windingness?

  • Number of kWh consumption per one kilometer of altitude gain

    Declaration

    Swift

    public let consumptionInkWhPerkmAltitudeGain: Float?

  • Number of kWh consumption per one kilometer of altitude loss

    Declaration

    Swift

    public let recuperationInkWhPerkmAltitudeLoss: Float?

  • Whether current traffic should be included in the travel time computation

    Declaration

    Swift

    public let computeTravelTimeFor: ComputeTravelTimeFor?

  • Avoid vignettes

    Declaration

    Swift

    public let avoidVignettes: [String]?

  • Allow vignettes

    Declaration

    Swift

    public let allowVignettes: [String]?

  • Avoid specific areas

    Declaration

    Swift

    public let avoidAreas: [LatLngBounds]?

  • Optional list of supporting points to be used for the reconstruction of an existing route

    Declaration

    Swift

    public let supportingPoints: SupportingPoints?

  • Whether road shield references (to the external road shield atlas) should be returned

    Declaration

    Swift

    public let instructionRoadShieldReferences: RequestedRoadShieldReferences?

  • Whether announcement points should be included in the returned instructions

    Declaration

    Swift

    public let instructionAnnouncementPoints: AnnouncementPoints?

  • What kind of (if any) phonetic transcriptions of street names, signpost text, and road numbers should be included in the returned instructions

    Declaration

    Swift

    public let instructionPhonetics: InstructionPhoneticsType?

  • extras

    Declaration

    Swift

    public let extras: [String : String?]?

  • Custom endpoint to use for routing

    Declaration

    Swift

    public let customEndpoint: String?

  • Tracking ID

    Declaration

    Swift

    public let trackingId: String?