Itinerary

class Itinerary(val origin: ItineraryPoint, val destination: ItineraryPoint, val waypoints: List<ItineraryPoint> = emptyList())

The Itinerary represents a sequence of points that a route visits.

Throws

if an invalid combination of options is used. Invalid combinations are:

Constructors

Link copied to clipboard
constructor(origin: GeoPoint, destination: GeoPoint, waypoints: List<GeoPoint> = emptyList(), heading: Angle? = null)

The Itinerary represents a sequence of points that a route visits.

constructor(origin: ItineraryPoint, destination: ItineraryPoint, waypoints: List<ItineraryPoint> = emptyList())

Properties

Link copied to clipboard

The ItineraryPoint of the destination.

Link copied to clipboard

The ItineraryPoint of the origin.

Link copied to clipboard

Ordered collection of intermediate ItineraryPoints.

Functions

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun component1(): ItineraryPoint
Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun component2(): ItineraryPoint
Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun component3(): List<ItineraryPoint>
Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun copy(origin: ItineraryPoint = this.origin, destination: ItineraryPoint = this.destination, waypoints: List<ItineraryPoint> = this.waypoints): Itinerary
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Checks whether this Itinerary object is structurally equal to another object.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String