sdk-routing / com.tomtom.online.sdk.routing.data / IRouteQuery

IRouteQuery

interface IRouteQuery

The interface Route query which specifies the API to construct the query for the Routing API.

Functions

withAccelerationEfficiency

abstract fun withAccelerationEfficiency(accelerationEfficiency: Double!): IRouteQuery

Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates (i.e., KineticEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter.

withAllowVignettes

abstract fun withAllowVignettes(allowVignettes: MutableList<String!>!): IRouteQuery

A list of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are allowed.

withAlternativeType

abstract fun withAlternativeType(alternativeType: AlternativeType!): IRouteQuery

Controls the optimality with respect to the given planning criteria of the calculated alternatives compared to the reference route.

withArriveAt

abstract fun withArriveAt(arriveAt: Date!): IRouteQuery

Specifies the desired arrival time for the route to calculation.

withAuxiliaryPowerInKW

abstract fun withAuxiliaryPowerInKW(auxiliaryPowerInkW: Double!): IRouteQuery

Specifies the amount of power consumed for sustaining auxiliary systems, in kilowatts (kW). It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.

withAuxiliaryPowerInLitersPerHour

abstract fun withAuxiliaryPowerInLitersPerHour(auxiliaryPowerInLitersPerHour: Double!): IRouteQuery

Specifies the amount of fuel consumed for sustaining auxiliary systems of the vehicle, in liters per hour. It can be used to specify consumption due to devices and systems such as AC systems, radio, heating, etc.

withAvoidAreas

abstract fun withAvoidAreas(avoidAreas: MutableList<BoundingBox!>!): IRouteQuery

A list of rectangles that defines areas that are to be avoided during route calculation.

withAvoidType

abstract fun withAvoidType(avoidType: Avoid!): IRouteQuery

Specifies what the route calculation should try to avoid when determining the route. Can be specified multiple times.

withAvoidVignettes

abstract fun withAvoidVignettes(avoidVignettes: MutableList<String!>!): IRouteQuery

A list of 3-character ISO 3166-1 alpha-3 country codes of countries in which all toll roads with vignettes are to be avoided.

withComputeBestOrder

abstract fun withComputeBestOrder(isComputeBestOrder: Boolean!): IRouteQuery

Specifies if the best order of waypoints should be used to compute route. For example, if the maximum allowed number of waypoints is 50, then it might be reduced to 20 in better order.

withComputeTravelTimeFor

abstract fun withComputeTravelTimeFor(computeTravelTimeFor: TravelTimeType!): IRouteQuery

Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.

withConsiderTraffic

abstract fun withConsiderTraffic(isWithTraffic: Boolean!): IRouteQuery

Specifies if it should consider all available traffic information during routing.

withConstantSpeedConsumptionInKWhPerHundredKm

abstract fun withConstantSpeedConsumptionInKWhPerHundredKm(speedConsumptionInkWhPairs: SpeedToConsumptionMap!): IRouteQuery

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate in kWh pairs.

withConstantSpeedConsumptionInLitersPerHundredKm

abstract fun withConstantSpeedConsumptionInLitersPerHundredKm(speedToConsumptionMap: SpeedToConsumptionMap!): IRouteQuery

Specifies the speed-dependent component of consumption. Provided as an unordered list of speed/consumption-rate in liters and in pairs.

withCurrentChargeInKWh

abstract fun withCurrentChargeInKWh(currentChargeInkWh: Double!): IRouteQuery

Specifies the current electric energy supply in kilowatt hours (kWh).

withCurrentFuelInLiters

abstract fun withCurrentFuelInLiters(currentFuelInLiters: Double!): IRouteQuery

Specifies the current supply of fuel in liters.

withDecelerationEfficiency

abstract fun withDecelerationEfficiency(decelerationEfficiency: Double!): IRouteQuery

Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates (i.e., ChemicalEnergySaved/KineticEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter.

withDepartAt

abstract fun withDepartAt(departAt: Date!): IRouteQuery

Specifies the departure time for the route to calculation.

withDownhillEfficiency

abstract fun withDownhillEfficiency(downhillEfficiency: Double!): IRouteQuery

Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation (i.e., ChemicalEnergySaved/PotentialEnergyLost). ChemicalEnergySaved is obtained by converting saved (not consumed) fuel to energy using fuelEnergyDensityInMJoulesPerLiter.

withFuelEnergyDensityInMJoulesPerLiter

abstract fun withFuelEnergyDensityInMJoulesPerLiter(fuelEnergyDensityInMJoulesPerLiter: Double!): IRouteQuery

Specifies the amount of chemical energy stored in one liter of fuel in megajoules (MJ). It is used in conjunction with the *Efficiency parameters for conversions between saved or consumed energy and fuel. For example, energy density is 34.2 MJ/l for gasoline, and 35.8 MJ/l for Diesel fuel.

withHilliness

abstract fun withHilliness(hilliness: Hilliness!): IRouteQuery

Specifies the hilliness type for route calculation.

withInstructionsType

abstract fun withInstructionsType(instructionsType: InstructionsType!): IRouteQuery

Specifies the instructions type for the route calculation.

withLanguage

abstract fun withLanguage(language: String!): IRouteQuery

Specifies the language used for route calculation.

withMaxAlternatives

abstract fun withMaxAlternatives(maxAlternatives: Int!): IRouteQuery

Specifies the maximal number of route alternatives to be calculated by the service.

withMaxChargeInKWh

abstract fun withMaxChargeInKWh(maxChargeInkWh: Double!): IRouteQuery

Specifies the maximum electric energy supply in kilowatt hours (kWh) that may be stored in the vehicle's battery.

withMinDeviationDistance

abstract fun withMinDeviationDistance(minDeviationDistance: Int!): IRouteQuery

All alternative routes returned will follow the reference route from the origin point of the calculateRoute Request for at least this number of meters. This can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt.

withMinDeviationTime

abstract fun withMinDeviationTime(minDeviationTime: Int!): IRouteQuery

All alternative routes returned will follow the reference route from the origin point of the calculateRoute Request for at least this number of seconds. This can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt.

withReport

abstract fun withReport(report: Report!): IRouteQuery

Specifies if the report should be provided in the route query Response.

withRouteRepresentation

abstract fun withRouteRepresentation(routeRepresentation: RouteRepresentation!): IRouteQuery

Specifies the route representation for the route calculation.

withRouteType

abstract fun withRouteType(routeType: RouteType!): IRouteQuery

Specifies the route type for the route calculation.

withSectionType

abstract fun withSectionType(sectionType: SectionType!): IRouteQuery

Specifies which of the section types is reported in the route Response.

withSupportingPoints

abstract fun withSupportingPoints(supportingPoints: MutableList<LatLng!>!): IRouteQuery

A list of base route points to be used as input for route reconstruction.

withTravelMode

abstract fun withTravelMode(travelMode: TravelMode!): IRouteQuery

Specifies the travel mode for the route calculation.

withUphillEfficiency

abstract fun withUphillEfficiency(uphillEfficiency: Double!): IRouteQuery

Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation (i.e., PotentialEnergyGained/ChemicalEnergyConsumed). ChemicalEnergyConsumed is obtained by converting consumed fuel to chemical energy using fuelEnergyDensityInMJoulesPerLiter.

withVehicleAxleWeightInKg

abstract fun withVehicleAxleWeightInKg(vehicleAxleWeight: Int!): IRouteQuery

Specifies the vehicle axle weight for route calculation.

withVehicleCommercial

abstract fun withVehicleCommercial(isVehicleCommercial: Boolean!): IRouteQuery

Specifies if the vehicle is used for commercial purposes to calculate route.

withVehicleEngineType

abstract fun withVehicleEngineType(vehicleEngineType: VehicleEngineType!): IRouteQuery

Specifies the vehicle engine type for route query. Possible values are: "combustion", "electric".

withVehicleHeading

abstract fun withVehicleHeading(vehicleHeading: Int!): IRouteQuery

Specifies the vehicle heading for route calculation.

withVehicleHeightInMeters

abstract fun withVehicleHeightInMeters(vehicleHeight: Double!): IRouteQuery

Specifies the vehicle height for route calculation.

withVehicleLengthInMeters

abstract fun withVehicleLengthInMeters(vehicleLength: Double!): IRouteQuery

Specifies the vehicle length for route calculation.

withVehicleLoadType

abstract fun withVehicleLoadType(vehicleLoadType: VehicleLoadType!): IRouteQuery

Specifies the vehicle load type for route calculation.

withVehicleMaxSpeedInKph

abstract fun withVehicleMaxSpeedInKph(vehicleMaxSpeedInKph: Int!): IRouteQuery

Specifies the vehicle max speed for route calculation.

withVehicleWeightInKg

abstract fun withVehicleWeightInKg(vehicleWeight: Int!): IRouteQuery

Specifies the vehicle weight in kilograms for route calculation.

withVehicleWidthInMeters

abstract fun withVehicleWidthInMeters(vehicleWidth: Double!): IRouteQuery

Specifies the vehicle width for route calculation.

withWayPoints

abstract fun withWayPoints(wayPoints: Array<LatLng!>!): IRouteQuery

Specifies the array of map coordinates whose geographical information indicates your waypoints for the route calculation.

withWayPointsList

abstract fun withWayPointsList(wayPoints: MutableList<LatLng!>!): IRouteQuery

Specifies the array of map coordinate whose geographical information indicates your waypoints for the route calculation.

withWayPointsWithAcc

abstract fun withWayPointsWithAcc(wayPoints: MutableList<LatLngAcc!>!): IRouteQuery

Specifies the array of map coordinate whose geographical information indicates your waypoints with radius for the route calculation.

withWindingness

abstract fun withWindingness(windingness: Windingness!): IRouteQuery

Specifies the windingness type for route calculation.