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

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)

Properties

Link copied to clipboard
val arrivalTimeWithZone: Calendar

Arrival time including the time zone.

Link copied to clipboard
val consumptionForWholeLength: Consumption? = null

Consumption for the whole route or leg.

Link copied to clipboard
val consumptionUpToReachableOffset: Consumption? = null

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

Link copied to clipboard
val departureTimeWithZone: Calendar

Departure time including the time zone.

Link copied to clipboard
val length: Distance

Route length.

Link copied to clipboard
val reachableOffset: Distance? = null

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

Link copied to clipboard
val remainingBudget: Consumption? = null

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

Link copied to clipboard
val trafficDelay: Duration

Traffic delay.

Link copied to clipboard
val trafficLength: Distance

Traffic length.

Link copied to clipboard
val travelTime: Duration

Estimated travel time.

Functions

Link copied to clipboard
operator fun component1(): Distance
Link copied to clipboard
operator fun component10(): Distance?
Link copied to clipboard
operator fun component2(): Duration
Link copied to clipboard
operator fun component3(): Duration
Link copied to clipboard
operator fun component4(): Distance
Link copied to clipboard
operator fun component5(): Calendar
Link copied to clipboard
operator fun component6(): Calendar
Link copied to clipboard
operator fun component7(): Consumption?
Link copied to clipboard
operator fun component8(): Consumption?
Link copied to clipboard
operator fun component9(): Consumption?
Link copied to clipboard
fun copy(length: Distance = this.length, travelTime: Duration = this.travelTime, trafficDelay: Duration = this.trafficDelay, trafficLength: Distance = this.trafficLength, departureTimeWithZone: Calendar = this.departureTimeWithZone, arrivalTimeWithZone: Calendar = this.arrivalTimeWithZone, consumptionForWholeLength: Consumption? = this.consumptionForWholeLength, consumptionUpToReachableOffset: Consumption? = this.consumptionUpToReachableOffset, remainingBudget: Consumption? = this.remainingBudget, reachableOffset: Distance? = this.reachableOffset): Summary

Creates a copy of this Summary object with optional parameter overrides.

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.