Summary

class Summary constructor(val length: Distance, val travelTime: Duration, val trafficDelay: Duration = Duration.ZERO, val trafficLength: Distance = Distance.ZERO, val departureTimeWithZone: Calendar, val arrivalTimeWithZone: Calendar, val consumptionForWholeLength: Consumption? = null, val consumptionUpToReachableOffset: Consumption? = null, val remainingBudget: Consumption? = null, val reachableOffset: Distance? = null, tollPrices: List<TollPrice>? = null)

The route summary contains the high-level route data.

Parameters

length

Route length.

travelTime

Estimated travel time.

trafficDelay

Traffic delay.

trafficLength

Traffic length.

departureTimeWithZone

Departure time including the time zone.

arrivalTimeWithZone

Arrival time including the time zone.

consumptionForWholeLength

Consumption for the whole route or leg.

consumptionUpToReachableOffset

Consumption for the route or leg up to the reachable offset.

remainingBudget

Remaining fuel or energy when reaching the end of the route or leg.

reachableOffset

Portion of the route or leg that can be driven with the current energy or fuel supply.

tollPrices

List of toll prices of the route. Each price represents the same price in different currencies, e.g., it might be TollPrice(2.35, "EUR"), TollPrice(3.00, "GBP"). Note: If there is no toll information available, tollPrices will be null. If the calculated toll price is zero, it will be an empty list.

Constructors

Link copied to clipboard
constructor(length: Distance, travelTime: Duration, trafficDelay: Duration = Duration.ZERO, trafficLength: Distance = Distance.ZERO, departureTimeWithZone: Calendar, arrivalTimeWithZone: Calendar, consumptionForWholeLength: Consumption? = null, consumptionUpToReachableOffset: Consumption? = null, remainingBudget: Consumption? = null, reachableOffset: Distance? = null)
constructor(length: Distance, travelTime: Duration, trafficDelay: Duration = Duration.ZERO, trafficLength: Distance = Distance.ZERO, departureTimeWithZone: Calendar, arrivalTimeWithZone: Calendar, consumptionForWholeLength: Consumption? = null, consumptionUpToReachableOffset: Consumption? = null, remainingBudget: Consumption? = null, reachableOffset: Distance? = null, tollPrices: List<TollPrice>? = null)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Checks if this Summary object is equal to another object.

Link copied to clipboard
open override fun hashCode(): Int

Generates a hash code for this Summary object.

Link copied to clipboard
open override fun toString(): String

Returns a string representation of this Summary object.