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

Summary

open class Summary : Serializable

The route summary. It contains basic information about the route, e.g., length, travel time, etc.

Constructors

<init>

Summary()

Empty constructor for the Summary.

Summary(lengthInMeters: Int, travelTimeInSeconds: Int, trafficDelayInSeconds: Int, departureTime: String!, arrivalTime: String!, noTrafficTravelTimeInSeconds: Int, historicTrafficTravelTimeInSeconds: Int, liveTrafficIncidentsTravelTimeInSeconds: Int, fuelConsumptionInLiters: Float, batteryConsumptionInkWh: Float, deviationDistance: Int, deviationTime: Int, deviationPoint: LatLng!)

Default constructor for the Summary.

Properties

arrivalTime

var arrivalTime: String!

Raw string representation of arrival time with timezone.

batteryConsumptionInkWh

var batteryConsumptionInkWh: Float

The Estimated electric energy consumption in kilowatt hours (kWh). Valid for the electric engine type.

departureTime

var departureTime: String!

deviationDistance

var deviationDistance: Int

The distance (in meters) from the origin point to the first point where this route forks off from the reference route.

deviationPoint

var deviationPoint: LatLng!

The coordinates of the first point following the origin point of the calculateRoute request where this route forks off from the reference route.

deviationTime

var deviationTime: Int

The travel time (in seconds) from the origin point to the first point where this route forks off from the reference route.

fuelConsumptionInLiters

var fuelConsumptionInLiters: Float

The Estimated fuel consumption in liters. Valid for the combustion engine type.

historicTrafficTravelTimeInSeconds

var historicTrafficTravelTimeInSeconds: Int

The estimated travel time in seconds calculated using time-dependent historic traffic data. Included if requested using the computeTravelTimeFor parameter.

lengthInMeters

var lengthInMeters: Int

The route or leg length in meters.

liveTrafficIncidentsTravelTimeInSeconds

var liveTrafficIncidentsTravelTimeInSeconds: Int

The estimated travel time in seconds calculated using real-time speed data. Included if requested using the computeTravelTimeFor parameter.

noTrafficTravelTimeInSeconds

var noTrafficTravelTimeInSeconds: Int

The estimated travel time in seconds calculated as if there are no delays on the route due to traffic conditions (e.g., congestion). Included if requested using the computeTravelTimeFor parameter.

trafficDelayInSeconds

var trafficDelayInSeconds: Int

Traffic delay is the difference between the travel time calculated using all available traffic information and travel time calculated without the influence of current and historic traffic data.

travelTimeInSeconds

var travelTimeInSeconds: Int

The estimated travel time in seconds. Note that even when traffic=false, travelTimeInSeconds still includes the delay due to traffic.

Functions

getArrivalTimeWithZone

open fun getArrivalTimeWithZone(): DateTime?

The estimated arrival time for the route or leg. Specified as a dateTime. Returns null if not available. Information with timezone.

getBatteryConsumptionInkWh

open fun getBatteryConsumptionInkWh(): Float

Returns the Estimated electric energy consumption in kilowatt hours (kWh). Valid for the electric engine type.

getDepartureTimeWithZone

open fun getDepartureTimeWithZone(): DateTime?

The estimated departure time for the route or leg. Specified as a dateTime. Returns null if not available. Information with timezone.

getDeviationDistance

open fun getDeviationDistance(): Int

Returns the distance (in meters) from the origin point to the first point where this route forks off from the reference route.

getDeviationPoint

open fun getDeviationPoint(): LatLng!

Returns the coordinates of the first point following the origin point of the calculateRoute request where this route forks off from the reference route.

getDeviationTime

open fun getDeviationTime(): Int

Returns the travel time (in seconds) from the origin point to the first point where this route forks off from the reference route.

getFuelConsumptionInLiters

open fun getFuelConsumptionInLiters(): Float

Returns the Estimated fuel consumption in liters. Valid for the combustion engine type.

getHistoricTrafficTravelTimeInSeconds

open fun getHistoricTrafficTravelTimeInSeconds(): Int

Returns the estimated travel time in seconds calculated using time-dependent historic traffic data. Included if requested using the computeTravelTimeFor parameter.

getLengthInMeters

open fun getLengthInMeters(): Int

Returns the route or leg length in meters.

getLiveTrafficIncidentsTravelTimeInSeconds

open fun getLiveTrafficIncidentsTravelTimeInSeconds(): Int

Returns the estimated travel time in seconds calculated using real-time speed data. Included if requested using the computeTravelTimeFor parameter.

getNoTrafficTravelTimeInSeconds

open fun getNoTrafficTravelTimeInSeconds(): Int

Returns the estimated travel time in seconds calculated as if there are no delays on the route due to traffic conditions (e.g., congestion). Included if requested using the computeTravelTimeFor parameter.

getRawArrivalTime

open fun getRawArrivalTime(): String!

getRawDepartureTime

open fun getRawDepartureTime(): String!

getTrafficDelayInSeconds

open fun getTrafficDelayInSeconds(): Int

Returns the traffic delay between the travel time calculated using all available traffic information and travel time calculated without the influence of current and historic traffic data.

getTravelTimeInSeconds

open fun getTravelTimeInSeconds(): Int

Returns the estimated travel time in seconds. Note that even when traffic=false, travelTimeInSeconds still includes the delay due to traffic.

toString

open fun toString(): String