ClosestFacilityResult

A class that contains the output results from a ClosestFacilityTask. The closest facility result contains all necessary output from a successfully- completed ClosestFacilityTask.solveClosestFacility(ClosestFacilityParameters). This includes collection of routes, barriers and messages.

Since

200.1.0

See also

Properties

Link copied to clipboard

Directions language. The language used to generate driving directions text instructions.

Link copied to clipboard

Array of the facilities used to calculate the closest facility.

Link copied to clipboard

Array of the incidents from which to calculate the closest facility.

Link copied to clipboard

Messages. Messages received when solve is completed. If a route cannot be solved, the message returned by the server identifies the route that could not be solved.

Link copied to clipboard

Array of the point barriers. Barriers are only returned if the returnPointBarriers property of ClosestFacilityParameters is true.

Link copied to clipboard

Array of the polygon barriers. Barriers are only returned if the returnPolygonBarriers property of ClosestFacilityParameters is true.

Link copied to clipboard

Array of the polyline barriers. Barriers are only returned if the returnPolylineBarriers property of ClosestFacilityParameters is true.

Functions

Link copied to clipboard
fun getFacilityCosts(attributeName: String, facilityIndex: Int): List<Double>

Gets facility costs.

Link copied to clipboard
fun getRankedFacilityIndexes(incidentIndex: Int): List<Int>

Gets an ordered list of facility indexes for a given incident index. The first element in the list is the index of the closest facility, the second element is the next closest, etc. Multiple properties can effect the number of facilities returned for each incident.

Link copied to clipboard
fun getRoute(facilityIndex: Int, incidentIndex: Int): ClosestFacilityRoute?

Gets route.