com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.route/Waypoint

Waypoint

data class Waypoint(val id: RouteStopId, val place: <Error class: unknown class>, val navigableCoordinates: List<<Error class: unknown class>>, val routeOffset: <Error class: unknown class>, val roadSide: RoadSide? = null, val arrivalEnergy: <Error class: unknown class>? = null, val sourceType: RouteStop.SourceType = RouteStop.SourceType.UserDefined, val chargingInformation: <Error class: unknown class>? = null) : RouteStop

Represents a point that the route must visit between departure and destination.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

Link copied to clipboard
constructor(id: RouteStopId, place: <Error class: unknown class>, navigableCoordinates: List<<Error class: unknown class>>, routeOffset: <Error class: unknown class>, roadSide: RoadSide? = null, arrivalEnergy: <Error class: unknown class>? = null, sourceType: RouteStop.SourceType = RouteStop.SourceType.UserDefined, chargingInformation: <Error class: unknown class>? = null)

Properties

Link copied to clipboard
open override val arrivalEnergy: <Error class: unknown class>? = null

The level of energy expected at arrival. Optional, present only for electric vehicles if electric consumption is specified in the routing request.

Link copied to clipboard
open override val chargingInformation: <Error class: unknown class>? = null

Information on how much to charge at a charging station. Optional, will only be present if this route point is a charging stop in an EV route.

Link copied to clipboard
open override val id: RouteStopId

The id that matches a corresponding com.tomtom.sdk.routing.common.options.ItineraryPointId in the routing request if this route stop was requested by the user.

Link copied to clipboard
open override val navigableCoordinates: List<<Error class: unknown class>>

Coordinates which represent the navigable points of this route stop.

Link copied to clipboard
open override val place: <Error class: unknown class>

Place associated with this route stop.

Link copied to clipboard
open override val roadSide: RoadSide? = null

The side of the road at which the route point is located.

Link copied to clipboard
open override val routeOffset: <Error class: unknown class>

The driving distance from the start of the route to this route stop.

Link copied to clipboard
open override val sourceType: RouteStop.SourceType

Specifies the reason why the route point was added to the route.