Itinerary

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

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

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

having origin.pauseTime or destination.pauseTime set to something other than Duration.ZERO
having origin.waypointType or destination.waypointType set
having ItineraryPoint.personalChargingCapability set to PersonalChargingCapability.HomeCharger for any itinerary points other than destination
having the same ItineraryPoint.chargingStationId for two consecutive waypoints
having the same ItineraryPoint.chargingStationId for the last waypoint and the destination

Constructors

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(), planningTime: PlanningTime = PlanningTime.DepartNow)

The ItineraryPoint of the destination.

The ItineraryPoint of the origin.

A route planning time. Represents either a departure or arrival time. When creating RoutePlanningOptions, RoutePlanningOptions.departAt/RoutePlanningOptions.arriveAt will overwrite Itinerary.planningTime in case they are set.

Ordered collection of intermediate ItineraryPoints.

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])

fun ~~copy~~(origin: ItineraryPoint = this.origin, destination: ItineraryPoint = this.destination, waypoints: List<ItineraryPoint> = this.waypoints): Itinerary

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

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

open override fun hashCode(): Int

open override fun toString(): String