RefreshRouteParameters class

This class provides the necessary information for refreshing a route from a specific location on it.

Constructors

RefreshRouteParameters.withRouteHandleAndSectionPosition(RouteHandle routeHandle, int startingSectionIndex, int traveledDistanceOnStartingSectionInMeters)
Create a new instance of RefreshRouteParameters with the point on the section of the route as a new starting point.
factory
RefreshRouteParameters.withRouteHandleAndWaypoint(RouteHandle routeHandle, Waypoint startingPoint)
Create a new instance of RefreshRouteParameters with the new starting point on the route.
factory
RefreshRouteParameters.withRouteHandleAndWaypointAndSectionPosition(RouteHandle routeHandle, Waypoint startingPoint, int startingSectionIndex, int traveledDistanceOnStartingSectionInMeters)
Create a new instance of RefreshRouteParameters with the new starting point and the section position on the route.
factory

Properties

hashCode → int
The hash code for this object.
no setter
routeHandle ↔ RouteHandle
The route handle holding the route to be refreshed.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startingPoint ↔ Waypoint?
Identify the new starting point of the route. It should be of type WaypointType.stopover. Otherwise, an RoutingError.invalidParameter error is generated. Moreover, it should be very close to the original route specified with the RouteHandle. The location of this waypoint may by provided, for example, by a RouteProgress event. Since the new starting point is expected to be along the original route, the original route geometry is used to reach the remaining waypoints. The new route will not include the Waypoint items that lie behind the new starting point (i.e. the path that was already traveled). Plus, Route.lengthInMeters, Route.duration, and similar values are from the new starting point to the destination. If the new waypoint is too far off the original route, the route refresh may fail and an RoutingError.couldNotMatchOrigin error is triggered. In that case, an application may decide to calculate a new route from scratch.
getter/setter pair
startingSectionIndex ↔ int?
Indicates the index of the last traveled route section. When it is provided, the previous sections are discarded from the refreshed route and the starting point is searched in the provided section. If the starting point is not found in that section an RoutingError.couldNotMatchOrigin error is triggered.
getter/setter pair
traveledDistanceOnStartingSectionInMeters ↔ int?
Provides an indication on how much of the starting section is already traveled. The refresh route function would ignore the first part of the section. If it is provided with an invalid starting section index, an RoutingError.invalidParameter error is generated.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.