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

Route

class 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.).

Since

200.1.0

Properties

Link copied to clipboard
val directionManeuvers: List<DirectionManeuver>

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

Link copied to clipboard
val endTime: Instant?

End time. Value of the end time.

Link copied to clipboard
val endTimeShift: Double

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

Link copied to clipboard
val routeGeometry: Polyline?

Route's geometry. The geometry for the full route (polyline).

Link copied to clipboard
val routeName: String

Route's name. The name of the route.

Link copied to clipboard
val startTime: Instant?

Start time. Value of the start time.

Link copied to clipboard
val startTimeShift: Double

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

Link copied to clipboard
val stops: List<Stop>

Stops. Collection of output stops.

Link copied to clipboard
val totalLength: Double

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

Link copied to clipboard
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.

Link copied to clipboard
val travelTime: Double

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

Link copied to clipboard
val violationTime: Double

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

Link copied to clipboard
val waitTime: Double

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

Functions

Link copied to clipboard
fun getCost(attributeName: String): Double

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