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

ClosestFacilityRoute

class ClosestFacilityRoute

A class that contains the output from a solving closest task for a single result. The solving closest route contains all necessary output from a successfully- completed ClosestFacilityTask.solveClosestFacility(ClosestFacilityParameters). This includes the cost, geometry, and additional metadata specific to the resulting route solution (e.g., route directions, local start/end time, etc.).

Since

200.1.0

See also

Properties

Link copied to clipboard
val arrivalCurbApproach: CurbApproach

Arrival curb approach. Default value CurbApproach.EitherSide will be returned on error.

Link copied to clipboard
val departureCurbApproach: CurbApproach

Departure curb approach.

Link copied to clipboard
val directionManeuvers: List<DirectionManeuver>

Direction maneuver. The list of turn-by-turn directions for this route. Can be empty array in case if ClosestFacilityParameters.returnDirections is false.

Link copied to clipboard
val endTime: Instant?

End time. A null if departure/arrival time was not specified in ClosestFacilityParameters.

Link copied to clipboard
val endTimeShift: Double

Time zone shift for end time, in minutes. Value of the 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) in case if ClosestFacilityParameters.returnRoutes is true.

Link copied to clipboard
val startTime: Instant?

Start time. A null if departure/arrival time was not specified in ClosestFacilityParameters.

Link copied to clipboard
val startTimeShift: Double

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

Link copied to clipboard
val totalLength: Double

Total length in meters. The total length of a closest facility route (meters).

Link copied to clipboard
val totalTime: Double

Total time in minutes. The total time in minutes calculated for the route. In order to get this value, time attribute should be set in as impedance or accumulate attribute in parameters object.

Link copied to clipboard
val travelTime: Double

Travel time in minutes. Travel time is total amount of travel time exclude added minutes from incident/facility added costs(if specified).

Functions

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

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