sdk-routing / com.tomtom.online.sdk.routing.ev / RouteDescriptor

RouteDescriptor

@PublicPreview("2021.06") data class RouteDescriptor

Represents the route descriptor used during a route plan.

Parameters

reportType - Specifies which data should be reported for diagnosis purposes.

departAt - The date and time of departure from the origin point.

routeType - The type of route requested.

traffic - Specifies whether the traffic information will be considered.

avoidTypes - Specifies something that the route calculation should try to avoid when determining the route.

travelMode - The mode of travel for the requested route.

avoidVignettes - Specifies countries in which all toll roads and vignettes will be avoided.

allowVignettes - Specifies countries in which all toll roads and vignettes will be allowed.

avoidAreas - Specifies areas which will be avoided.

routeRepresentation - The representation of the set of routes provided as a response.

vehicleHeading - The directional heading of the vehicle in degrees starting at true North and continuing in a clockwise direction.

sectionType - Can be specified multiple times.

Types

Builder

class Builder

Builder used to create an instance of RouteDescriptor. Once constructed, the user cannot change the field values.

Properties

allowVignettes

val allowVignettes: List<String>?

Specifies countries in which all toll roads and vignettes will be allowed.

avoidAreas

val avoidAreas: List<BoundingBox>

Specifies areas which will be avoided.

avoidTypes

val avoidTypes: List<AvoidType>

Specifies something that the route calculation should try to avoid when determining the route.

avoidVignettes

val avoidVignettes: List<String>?

Specifies countries in which all toll roads and vignettes will be avoided.

departAt

val departAt: String?

The date and time of departure from the origin point.

reportType

val reportType: ReportType

Specifies which data should be reported for diagnosis purposes.

routeRepresentation

val routeRepresentation: RouteRepresentation

The representation of the set of routes provided as a response.

routeType

val routeType: RouteType

The type of route requested.

sectionType

val sectionType: SectionType

Can be specified multiple times.

traffic

val traffic: Boolean

Specifies whether the traffic information will be considered.

travelMode

val travelMode: TravelMode

The mode of travel for the requested route.

vehicleHeading

val vehicleHeading: Int?

The directional heading of the vehicle in degrees starting at true North and continuing in a clockwise direction.