arcgis-maps-kotlin/com.arcgismaps.tasks.networkanalysis/Route

Route

A route object contains information about single route. A class that contains the output from a route task for a single route. The route contains all necessary output from a successfully- completed route task solve. This includes the cost, shape, and additional metadata specific to the resulting route solution (e.g., route directions, local start/end time, etc.).

Functions

getCost

fun getCost(attributeName: String): Double

Gets cost. Returns the associated cost for this attribute name.

Properties

directionManeuvers

val directionManeuvers: List<DirectionManeuver>

Direction maneuver. The list of turn-by-turn directions for this route.

endTime

val endTime: Instant?

endTimeShift

val endTimeShift: Double

Time zone shift for end time, in minutes. Value of time zone shift for end time, in minutes.

routeGeometry

val routeGeometry: Polyline?

routeName

val routeName: String

Route's name. The name of the route.

startTime

val startTime: Instant?

startTimeShift

val startTimeShift: Double

Time zone shift for start time in minutes. Value of time zone shift for start time, in minutes.

stops

val stops: List<Stop>

Stops. Collection of output stops.

totalLength

val totalLength: Double

Total length in meters. The total length of the route (meters).

totalTime

val totalTime: Double

Total time in minutes. This includes any travel time, time spent waiting at stops (arriving before the start of a time window), and service time at stops.

travelTime

val travelTime: Double

Travel time in minutes. This includes only time of the travel.

violationTime

val violationTime: Double

Violation time in minutes. The total amount of additional time incurred due to time window violations.

waitTime

val waitTime: Double

Wait time in minutes. The total amount of additional time incurred due to waiting at time windows.