com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.options.calculation

Package-level declarations

Types

Link copied to clipboard
data class AlternativeRoutesOptions(val maxAlternatives: Int, val alternativeType: AlternativeType? = null, val minDeviationDistance: Distance? = null, val minDeviationTime: Duration? = null)

Specifies options related to alternative routes.

Link copied to clipboard
@JvmInline
value class AlternativeType

Represents the 'alternativeType' parameter in a Request to the Routing API.

Link copied to clipboard
@JvmInline
value class ArrivalSidePreference

Represents the preference for the road side on arrival for waypoints and destination.

Link copied to clipboard
data class AvoidOptions(val avoidTypes: Set<AvoidType> = emptySet(), val avoidAreas: Set<GeoBoundingBox> = emptySet(), val vignettes: Vignettes? = null)

Specifies avoidance criteria.

Link copied to clipboard
@JvmInline
value class AvoidType

Defines what kind of roads should try to be avoided while calculating a route. There is no guarantee that roads with these attributes will be avoided. Please use the @ref com.tomtom.sdk.routing.route.section.Sections to check for violations.

Link copied to clipboard
@JvmInline
value class ComputeTravelTimeFor

Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.

Link copied to clipboard
@JvmInline
value class ConsiderTraffic

Specifies whether to use live traffic in the route calculation.

Link copied to clipboard
data class CostModel(val routeType: RouteType = RouteType.Fast, val considerTraffic: ConsiderTraffic = ConsiderTraffic.Yes, val avoidOptions: AvoidOptions? = null)

Criteria that specify what paths to prefer during routing.

Link copied to clipboard
@JvmInline
value class Hilliness

Represents the 'hilliness' parameter in a Request to the Routing API.

Link copied to clipboard
abstract class RouteType

This represents the 'routeType' parameter in a Request to the Routing API.

Link copied to clipboard
abstract class Vignettes

Either of Vignettes.Allow or Vignettes.Avoid.

Link copied to clipboard
@JvmInline
value class WaypointOptimization

Specifies whether to optimize the order of waypoints, and if so, how.

Link copied to clipboard
@JvmInline
value class Windingness

Represents the 'windingness' parameter in a Request to the Routing API.