routing:routing-client-api/com.tomtom.sdk.routing.api.calculation

Package com.tomtom.sdk.routing.api.calculation

Types

data class AlternativeRoutesOptions( val maxAlternatives: Int = 1, val alternativeType: AlternativeType = AlternativeType.ANY_ROUTE, val minDeviationDistance: Distance = Distance.ZERO, val minDeviationTime: Duration = Duration.ZERO)

Specifies options related to alternative routes.

AlternativeType

enum AlternativeType : Enum<AlternativeType>

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

ArriveAt

data class ArriveAt(val date: Date) : RoutingTime

An arrival time.

AvoidOptions

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

Specifies avoidance criteria.

AvoidType

enum AvoidType : Enum<AvoidType>

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

ComputeTravelTimeFor

enum ComputeTravelTimeFor : Enum<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

enum ConsiderTraffic : Enum<ConsiderTraffic>

Specifies whether to ignore traffic.

CostModel

data class CostModel( val routeType: RouteType = RouteType.FAST, val considerTraffic: ConsiderTraffic = ConsiderTraffic.YES, val avoidOptions: AvoidOptions? = null, val supportingPoints: List<List<GeoCoordinate>> = emptyList())

Criteria that specify what paths to prefer during routing.

DepartAt