com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.route/Summary

Summary

class Summary(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)

The route summary contains the high-level route data.

Constructors

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)

Properties

arrivalTimeWithZone

val arrivalTimeWithZone: Calendar

Arrival time including the time zone.

consumptionForWholeLength

val consumptionForWholeLength: Consumption? = null

Consumption for the whole route or leg.

consumptionUpToReachableOffset

val consumptionUpToReachableOffset: Consumption? = null

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

departureTimeWithZone

val departureTimeWithZone: Calendar

Departure time including the time zone.

val length: Distance

Route length.

reachableOffset

val reachableOffset: Distance? = null

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

remainingBudget

val remainingBudget: Consumption? = null

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

val trafficDelay: Duration

Traffic delay.

val trafficLength: Distance

Traffic length.

val travelTime: Duration

Estimated travel time.

Functions

open operator override fun equals(other: Any?): Boolean

Checks if this Summary object is equal to another object.

open override fun hashCode(): Int

Generates a hash code for this Summary object.

open override fun toString(): String

Returns a string representation of this Summary object.