com.tomtom.sdk.routing:routing-common/com.tomtom.sdk.routing.options/RoutePlanningOptions

RoutePlanningOptions

class RoutePlanningOptions

Options for planning routes, which are passed to one of the various route planners.

Constructors

RoutePlanningOptions

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

constructor(itinerary: Itinerary, costModel: CostModel? = CostModel(), departAt: Date? = null, arriveAt: Date? = null, alternativeRoutesOptions: AlternativeRoutesOptions? = null, guidanceOptions: GuidanceOptions? = null, routeLegOptions: List<RouteLegOptions> = emptyList(), vehicle: Vehicle = Vehicle.Car(), chargingOptions: ChargingOptions? = null, queryOptions: QueryOptions? = null, waypointOptimization: WaypointOptimization? = null, mode: RouteInformationMode = RouteInformationMode.Complete, arrivalSidePreference: ArrivalSidePreference = ArrivalSidePreference.AnySide)

Options for planning routes, which are passed to one of the various route planners.

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

constructor(itinerary: Itinerary, routeType: RouteType? = null, considerTraffic: ConsiderTraffic? = ConsiderTraffic.Yes, avoidOptions: AvoidOptions? = null, departAt: Date? = null, arriveAt: Date? = null, alternativeRoutesOptions: AlternativeRoutesOptions? = null, guidanceOptions: GuidanceOptions? = null, routeLegOptions: List<RouteLegOptions> = emptyList(), vehicle: Vehicle = Vehicle.Car(), chargingOptions: ChargingOptions? = null, queryOptions: QueryOptions? = null, waypointOptimization: WaypointOptimization? = null, mode: RouteInformationMode = RouteInformationMode.Complete, arrivalSidePreference: ArrivalSidePreference = ArrivalSidePreference.AnySide, reconstructionMode: ReconstructionMode? = null)

Options for planning routes, which are passed to one of the various route planners.

Types

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

object Companion

Properties

alternativeRoutesOptions

val alternativeRoutesOptions: AlternativeRoutesOptions?

Options for calculating more than one route.

arrivalSidePreference

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val arrivalSidePreference: ArrivalSidePreference

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

@get:RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val arriveAt: Date?

An arrival time for the route. Cannot be used together with arriveAt.

val avoidOptions: AvoidOptions?

Avoidance criteria.

chargingOptions

val chargingOptions: ChargingOptions?

Additional options for electric vehicles to take charging into account.

considerTraffic

@get:RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val considerTraffic: ConsiderTraffic?

Use live traffic in the route calculation.

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val costModel: CostModel?

Options governing which streets to prefer.

@get:RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val departAt: Date?

A departure time for the route. Cannot be used together with arriveAt.

guidanceOptions

val guidanceOptions: GuidanceOptions?

Properties for the generated instructions. Specify null for no instructions generation.

val itinerary: Itinerary

The list of route locations.

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val mode: RouteInformationMode

Specifies how much guidance information (instructions and lane guidance) is returned with the route. Defaults to RouteInformationMode.Complete.

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val queryOptions: QueryOptions?

Options regarding the way the request is sent to the server.

reconstructionMode

@get:RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val reconstructionMode: ReconstructionMode?

Defines the mode used for the route reconstruction.

routeLegOptions

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val routeLegOptions: List<RouteLegOptions>

Options for each route leg, such as a polyline to follow.

val routeType: RouteType?

General strategy for selecting roads during route calculation.

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val vehicle: Vehicle

The vehicle dimensions, restrictions, and engine parameters. When guidanceOptions are given, the vehicle has to be of type VehicleType.Car, VehicleType.Motorcycle or VehicleType.Truck. Please use VehicleType.Car for VehicleType.Taxi.

waypointOptimization

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

val waypointOptimization: WaypointOptimization?

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

Functions

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String