com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.options/ItineraryPoint

ItineraryPoint

class ItineraryPoint(val place: Place, val heading: Angle? = null)

Encapsulates Place with the additional information relevant for the route itinerary.

Parameters

place

heading

Angle at which this itinerary point should be approached or departed. Counted from north in clockwise direction and in range [0, 360).

Constructors

ItineraryPoint

constructor(place: Place, heading: Angle? = null, pauseTime: Duration = Duration.ZERO)

Encapsulates Place with the additional information relevant for the route itinerary.

constructor(place: Place, heading: Angle? = null, pauseTime: Duration = Duration.ZERO, chargingStationId: ItineraryPointId? = null, waypointType: WaypointType? = null)

Encapsulates Place with the additional information relevant for the route itinerary.

constructor(id: ItineraryPointId, place: Place, heading: Angle? = null, pauseTime: Duration = Duration.ZERO, chargingStationId: ItineraryPointId? = null, waypointType: WaypointType? = null)

Encapsulates Place with the additional information relevant for the route itinerary.

constructor(place: Place, heading: Angle? = null)

Properties

chargingStationId

val chargingStationId: ItineraryPointId?

ID of the charging station at this itinerary point. It is a unique ID of the charging station in the source data. If specified, it will be used to look up the corresponding charging station and plan charging at it. Note: This parameter is not supported on Orbis.

heading

val heading: Angle? = null

val id: ItineraryPointId

A unique identifier of the itinerary point.

pauseTime

val pauseTime: Duration

Pause time at this itinerary point (including charging time).

place

val place: Place

waypointType

val waypointType: WaypointType?

Type of the waypoint represented by this itinerary point. In case this itinerary point represents a waypoint, it returns the value indicating whether the waypoint is user-defined or auto-generated. Returns null if this itinerary point represents origin or destination.

Functions

component1

operator fun ~~component1~~(): Place

component2

operator fun ~~component2~~(): Angle?

copy

fun ~~copy~~(place: Place = this.place, heading: Angle? = this.heading): ItineraryPoint

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String