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

Package-level declarations

Types

data class AlternativeRoutesOptions(val maxAlternatives: Int = 1, val alternativeType: AlternativeType? = null, val minDeviationDistance: Distance? = null, val minDeviationTime: Duration? = null)

Specifies options related to alternative routes.

AlternativeType

@JvmInline

value class AlternativeType

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

AvoidOptions

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

Specifies avoidance criteria.

AvoidType

@JvmInline

value class AvoidType

Defines what kind of roads should be avoided while calculating a route.

ComputeTravelTimeFor

@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.

ConsiderTraffic

@JvmInline

value class ConsiderTraffic

Specifies whether to ignore traffic.

CostModel

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.

Hilliness

@JvmInline

value class Hilliness

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

RouteType

abstract class RouteType

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

Vignettes

abstract class Vignettes

Either of Vignettes.Allow or Vignettes.Avoid.

WaypointOptimization

@JvmInline

value class WaypointOptimization

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

Windingness

@JvmInline

value class Windingness

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