com.tomtom.sdk.navigation:navigation/com.tomtom.sdk.navigation.routecomparison

Package-level declarations

Types

ChargingDifference

class ChargingDifference(val chargingTime: Duration, val numberOfChargingStops: Int)

Represents the difference in charging time between the base route and the forking route.

ConsumptionDifference

class ConsumptionDifference(val consumption: Consumption)

Indicates the variance in consumption between the base route and the forking route.

LengthDifference

class LengthDifference(val length: Distance)

Indicates the variance in length between the base route and the forking route.

RouteComparisonFailure

abstract class RouteComparisonFailure

Represents the various failure reasons encountered during a route comparison.

RouteDifferences

class RouteDifferences(val lengthDifference: LengthDifference, val timeDifference: TimeDifference, val chargingDifference: ChargingDifference, val consumptionDifference: ConsumptionDifference?, val sectionsDifferences: SectionsDifferences = SectionsDifferences())

Represents the result of comparing two routes.

SectionsDifference

class SectionsDifference<T : Section>(val firstOnly: List<T> = listOf(), val secondOnly: List<T> = listOf())

Represents the sections of type T of the base and the forking route, starting from the sections containing the forking point moving up to the destination.

SectionsDifferences

class SectionsDifferences(val carTrains: SectionsDifference<CarTrainSection> = SectionsDifference(), val tolls: SectionsDifference<TollSection> = SectionsDifference(), val traffic: SectionsDifference<TrafficSection> = SectionsDifference(), val tollVignettes: SectionsDifference<TollVignetteSection> = SectionsDifference(), val motorways: SectionsDifference<MotorwaySection> = SectionsDifference(), val ferries: SectionsDifference<FerrySection> = SectionsDifference(), val tunnels: SectionsDifference<TunnelSection> = SectionsDifference(), val carpoolLanes: SectionsDifference<CarpoolSection> = SectionsDifference(), val lowEmissionZones: SectionsDifference<LowEmissionZoneSection> = SectionsDifference(), val unpavedRoads: SectionsDifference<UnpavedSection> = SectionsDifference(), val countries: SectionsDifference<CountrySection> = SectionsDifference(), val vehicleRestrictions: SectionsDifference<VehicleRestrictedSection> = SectionsDifference())

Represents the sections of the base and forking routes, starting from the sections containing the forking point and moving towards the destination.

TimeDifference

class TimeDifference(val travelTime: Duration)

Indicates the variance in travel time between the base route and the forking route.

Functions

compareToForkingRoute

fun Route.compareToForkingRoute(forkingRoute: Route): Result<RouteDifferences, RouteComparisonFailure>

Compares this route to a forking route and returns the differences between the two.