ClosestFacilityResult QML Type
A class that contains the output results from a ClosestFacilityTask. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.1 |
| Inherits: |
- List of all members, including inherited members
- ClosestFacilityResult is part of QML Type List.
Properties
- directionsLanguage : string
- facilities : list<Facility>
- incidents : list<Incident>
- messages : list<string>
- pointBarriers : list<PointBarrier>
- polygonBarriers : list<PolygonBarrier>
- polylineBarriers : list<PolylineBarrier>
Methods
- list<double> facilityCosts(string attributeName, int facilityIndex)
- list<int> rankedFacilityIndexes(int incidentIndex)
- ClosestFacilityRoute route(int facilityIndex, int incidentIndex)
Detailed Description
The closest facility result contains all necessary output from a successfully completed ClosestFacilityTask::solveClosestFacility(ClosestFacilityParameters). This includes collection of routes, barriers and messages.
Note: You cannot declare or create a component of this type in QML code.
See also ClosestFacilityTask and ClosestFacilityTask::solveClosestFacility(ClosestFacilityParameters).
Property Documentation
[read-only] directionsLanguage : string |
Directions language (read-only).
The language used to generate driving directions text instructions.
[read-only] facilities : list<Facility> |
Returns a list of the facilities used in the ClosestFacilityTask (read-only).
[read-only] incidents : list<Incident> |
Returns a list of the incidents used in the ClosestFacilityTask (read-only).
[read-only] messages : list<string> |
Messages (read-only).
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.
[read-only] pointBarriers : list<PointBarrier> |
List of the point barriers (read-only).
Barriers are only returned if the returnPointBarriers property of ClosestFacilityParameters is true.
See also ClosestFacilityParameters.
[read-only] polygonBarriers : list<PolygonBarrier> |
List of the polygon barriers (read-only).
Barriers are only returned if the returnPolygonBarriers property of ClosestFacilityParameters is true.
See also ClosestFacilityParameters.
[read-only] polylineBarriers : list<PolylineBarrier> |
List of the polyline barriers (read-only).
Barriers are only returned if the returnPolylineBarriers property of ClosestFacilityParameters is true.
See also ClosestFacilityParameters.
Method Documentation
list<double> facilityCosts(string attributeName, int facilityIndex) |
Returns total cost values for given attributeName and facilityIndex (read-only).
list<int> rankedFacilityIndexes(int incidentIndex) |
Returns a list of facility indexes ordered by rank level for a given incidentIndex (read-only).
- incidentIndex - The index of facility.
Returns facility indexes for a given incident where the index is a rank level and the value is a facility 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:
ClosestFacilityRoute route(int facilityIndex, int incidentIndex) |
Returns a route between the specified facilityIndex and incidentIndex (read-only).