sdk-routing / com.tomtom.online.sdk.routing.data.longDistanceEV / LongDistanceEVRoutingQueryBuilder

LongDistanceEVRoutingQueryBuilder

class LongDistanceEVRoutingQueryBuilder : ILongDistanceEVRoutingQuery

The default builder for LongDistanceEVRoutingQuery objects.

Constructors

<init>

LongDistanceEVRoutingQueryBuilder(origin: LatLng, destination: LatLng, speedConsumptionInKWhPerHundredKm: Map<Double, Double>, currentChargeInKWh: Double, maxChargeInkWh: Double, minChargeAtDestinationInkWh: Double, minChargeAtChargingStopsInkWh: Double, chargingModes: List<NativeChargingMode>)

The default builder for LongDistanceEVRoutingQuery objects.

Functions

build

fun build(): LongDistanceEVRoutingQuery

Creates new instance of LongDistanceEVRoutingQuery.

withAccelerationEfficiency

fun withAccelerationEfficiency(accelerationEfficiency: Double): LongDistanceEVRoutingQueryBuilder

Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates.

withAllowVignette

fun withAllowVignette(allowVignette: String): LongDistanceEVRoutingQueryBuilder

Specifies country in which all toll roads and vignettes will be allowed.

withAllowVignettes

fun withAllowVignettes(allowVignettes: MutableList<String>): LongDistanceEVRoutingQueryBuilder

Specifies countries in which all toll roads and vignettes will be allowed.

withAuxiliaryPowerInKW

fun withAuxiliaryPowerInKW(auxiliaryPowerInKW: Double): LongDistanceEVRoutingQueryBuilder

Specifies the amount of power consumed for sustaining auxiliary systems, in kWh.

withAvoidArea

fun withAvoidArea(avoidArea: BoundingBox): LongDistanceEVRoutingQueryBuilder

Specifies area which will be avoided.

withAvoidAreas

fun withAvoidAreas(avoidAreas: MutableList<BoundingBox>): LongDistanceEVRoutingQueryBuilder

Specifies areas which will be avoided.

withAvoidType

fun withAvoidType(avoidType: NativeAvoidType): LongDistanceEVRoutingQueryBuilder

Specifies something that the route calculation should try to avoid when determining the route.

withAvoidTypes

fun withAvoidTypes(avoidTypes: MutableList<NativeAvoidType>): LongDistanceEVRoutingQueryBuilder

Specifies something that the route calculation should try to avoid when determining the route.

withAvoidVignette

fun withAvoidVignette(avoidVignette: String): LongDistanceEVRoutingQueryBuilder

Specifies country in which all toll roads and vignettes will be avoided.

withAvoidVignettes

fun withAvoidVignettes(avoidVignettes: MutableList<String>): LongDistanceEVRoutingQueryBuilder

Specifies countries in which all toll roads and vignettes will be avoided.

withDecelerationEfficiency

fun withDecelerationEfficiency(decelerationEfficiency: Double): LongDistanceEVRoutingQueryBuilder

Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates.

withDepartAt

fun withDepartAt(departAt: String): LongDistanceEVRoutingQueryBuilder

The date and time of departure from the origin point.

withDownhillEfficiency

fun withDownhillEfficiency(downhillEfficiency: Double): LongDistanceEVRoutingQueryBuilder

Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation.

withIsVehicleCommercial

fun withIsVehicleCommercial(isVehicleCommercial: Boolean): LongDistanceEVRoutingQueryBuilder

Specifies whether the vehicle is used for commercial purposes and thus may not be allowed to drive on some roads.

withReport

fun withReport(reportType: NativeReportType): LongDistanceEVRoutingQueryBuilder

Specifies which data should be reported for diagnosis purposes.

withRouteRepresentation

fun withRouteRepresentation(routeRepresentation: NativeRouteRepresentation): LongDistanceEVRoutingQueryBuilder

The representation of the set of routes provided as a Response.

withRouteType

fun withRouteType(routeType: NativeRouteType): LongDistanceEVRoutingQueryBuilder

The type of route requested.

withSectionType

fun withSectionType(sectionType: NativeSectionType): LongDistanceEVRoutingQueryBuilder

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

withTraffic

fun withTraffic(traffic: Boolean): LongDistanceEVRoutingQueryBuilder

Specifies whether the traffic information will be considered.

withTravelMode

fun withTravelMode(travelMode: NativeTravelMode): LongDistanceEVRoutingQueryBuilder

The mode of travel for the requested route.

withUphillEfficiency

fun withUphillEfficiency(uphillEfficiency: Double): LongDistanceEVRoutingQueryBuilder

Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation.

withVehicleAdrTunnelRestrictionCode

fun withVehicleAdrTunnelRestrictionCode(vehicleAdrTunnelRestrictionCode: NativeVehicleAdrTunnelRestrictionCode): LongDistanceEVRoutingQueryBuilder

If vehicleAdrTunnelRestrictionCode is specified, the vehicle is subject to ADR tunnel restrictions.

withVehicleAxleWeightInKg

fun withVehicleAxleWeightInKg(vehicleAxleWeightInKg: Int): LongDistanceEVRoutingQueryBuilder

Weight per axle of the vehicle in kilograms.

withVehicleHeading

fun withVehicleHeading(vehicleHeading: Int): LongDistanceEVRoutingQueryBuilder

The directional heading of the vehicle in degrees starting at true North and continuing in a clockwise direction.

withVehicleHeightInMeters

fun withVehicleHeightInMeters(vehicleHeightInMeters: Double): LongDistanceEVRoutingQueryBuilder

Height of the vehicle in meters.

withVehicleLengthInMeters

fun withVehicleLengthInMeters(vehicleLengthInMeters: Double): LongDistanceEVRoutingQueryBuilder

Length of the vehicle in meters.

withVehicleLoadType

fun withVehicleLoadType(vehicleLoadType: NativeVehicleLoadType): LongDistanceEVRoutingQueryBuilder

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

withVehicleMaxSpeedInKph

fun withVehicleMaxSpeedInKph(vehicleMaxSpeedInKph: Int): LongDistanceEVRoutingQueryBuilder

Maximum speed of the vehicle in km/hour.

withVehicleWeightInKg

fun withVehicleWeightInKg(vehicleWeightInKg: Int): LongDistanceEVRoutingQueryBuilder

Weight of the vehicle in kilograms.

withVehicleWidthInMeters

fun withVehicleWidthInMeters(vehicleWidthInMeters: Double): LongDistanceEVRoutingQueryBuilder

Width of the vehicle in meters.

Companion Object Functions

create

fun create(origin: LatLng, destination: LatLng, speedConsumptionInKWhPerHundredKm: Map<Double, Double>, currentChargeInKWh: Double, maxChargeInkWh: Double, minChargeAtDestinationInkWh: Double, minChargeAtChargingStopsInkWh: Double, chargingModes: List<NativeChargingMode>): LongDistanceEVRoutingQueryBuilder

Builder used to create an instance of LongDistanceEVRoutingQuery, once constructed, the user cannot change the field values.