Parameters for a ClosestFacilityTask, such as facilities, incidents, barriers, and whether to return directions. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.1 |
| Inherits: |
Properties
- accumulateAttributeNames : list<string>
- defaultImpedanceCutoff : double
- defaultTargetFacilityCount : int
- directionsDistanceUnits : Enums.UnitSystem
- directionsLanguage : string
- directionsStyle : Enums.DirectionsStyle
- outputSpatialReference : SpatialReference
- returnDirections : bool
- returnPointBarriers : bool
- returnPolygonBarriers : bool
- returnPolylineBarriers : bool
- returnRoutes : bool
- routeShapeType : Enums.RouteShapeType
- startTime : date
- startTimeUsage : Enums.StartTimeUsage
- travelDirection : Enums.TravelDirection
- travelMode : TravelMode
Signals
- accumulateAttributeNamesChanged()
- defaultImpedanceCutoffChanged()
- defaultTargetFacilityCountChanged()
- directionsDistanceUnitsChanged()
- directionsLanguageChanged()
- directionsStyleChanged()
- outputSpatialReferenceChanged()
- returnDirectionsChanged()
- returnPointBarriersChanged()
- returnPolygonBarriersChanged()
- returnPolylineBarriersChanged()
- returnRoutesChanged()
- routeShapeTypeChanged()
- startTimeChanged()
- startTimeUsageChanged()
- travelDirectionChanged()
- travelModeChanged()
Methods
- void clearFacilities()
- void clearIncidents()
- void clearPointBarriers()
- void clearPolygonBarriers()
- void clearPolylineBarriers()
- string searchWhereClause(string sourceName)
- void setFacilities(list<Facility> facilities)
- void setFacilitiesWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setIncidents(list<Incident> incidents)
- void setIncidentsWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setPointBarriers(list<PointBarrier> pointBarriers)
- void setPointBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setPolygonBarriers(list<PolygonBarrier> polygonBarriers)
- void setPolygonBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setPolylineBarriers(list<PolylineBarrier> polylineBarriers)
- void setPolylineBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setSearchWhereClause(string sourceName, string searchWhereClause)
Detailed Description
Facilities, incidents and barriers must have the same spatial reference, but do not need to be reprojected to match the network dataset's spatial reference. For example, the network dataset could be in WKID 4326, and your map, facilities, incidents and barriers could all be in WKID 3857. The ClosestFacilityTask will automatically reproject the facilities, incidents and barriers, and output the ClosestFacilityRoute in whatever output spatial reference is specified.
Note: You cannot declare or create a component of this type in QML code. The standard pattern is to retrieve one from the ClosestFacilityTask type so it already contain defaults values necessary for solving closest facility.
See also ClosestFacilityTask::createDefaultParameters.
Property Documentation
The accumulateAttributeNames of the ClosestFacilityParameters.
The default cutoff value to stop traversing.
The units for impedance cutoff is based on the value of the TravelMode.impedanceAttributeName. For example, if TravelMode.impedanceAttributeName parameter is TravelTime, the defaultImpedanceCutoff is specified in minutes.
The units in which the length information will be reported in the route directions.
See also Enums.UnitSystem.
The style of the resulting route directions.
See also Enums.DirectionsStyle.
outputSpatialReference : SpatialReference |
The output spatial reference.
The returnDirections of the ClosestFacilityParameters.
The returnPointBarriers of the ClosestFacilityParameters.
Reusing the PointBarriers from the ClosestFacilityResult (as opposed to using the original PointBarriers) can increase the speed of any subsequent route calculations.
The returnPolygonBarriers of the ClosestFacilityParameters.
Reusing the PolygonBarriers from the ClosestFacilityResult (as opposed to using the original PolygonBarriers) can increase the speed of any subsequent route calculations. This is particularly true for complex polygons.
The returnPolylineBarriers of the ClosestFacilityParameters.
Reusing the PolylineBarriers from the ClosestFacilityResult (as opposed to using the original PolylineBarriers) can increase the speed of any subsequent route calculations. This is particularly true for complex polylines.
The returnRoutes of the ClosestFacilityParameters.
The output shape type for a closest facility.
See also Enums.RouteShapeType.
The startTimeUsage of the ClosestFacilityParameters.
See also Enums.StartTimeUsage.
The travel direction (to or away from the facility) of the ClosestFacilityParameters.
See also Enums.TravelDirection.
travelMode : TravelMode |
The travel mode for a closest facility.
Signal Documentation
Emitted when the accumulateAttributeNames property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onAccumulateAttributeNamesChanged.
Emitted when the defaultImpedanceCutoff property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onDefaultImpedanceCutoffChanged.
Emitted when the defaultTargetFacilityCount property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onDefaultTargetFacilityCountChanged.
Emitted when the directionsDistanceUnits property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onDirectionsDistanceUnitsChanged.
Emitted when the directionsLanguage property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onDirectionsLanguageChanged.
Emitted when the directionsStyle property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onDirectionsStyleChanged.
Emitted when the outputSpatialReference property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onOutputSpatialReferenceChanged.
Emitted when the returnDirections property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onReturnDirectionsChanged.
Emitted when the returnPointBarriers property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onReturnPointBarriersChanged.
Emitted when the returnPolygonBarriers property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onReturnPolygonBarriersChanged.
Emitted when the returnPolylineBarriers property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onReturnPolylineBarriersChanged.
Emitted when the returnRoutes property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onReturnRoutesChanged.
Emitted when the routeShapeType property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onRouteShapeTypeChanged.
Emitted when the startTime property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onStartTimeChanged.
Emitted when the startTimeUsage property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onStartTimeUsageChanged.
Emitted when the travelDirection property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onTravelDirectionChanged.
Emitted when the travelMode property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onTravelModeChanged.
Method Documentation
Clears facilities that were set by ClosestFacilityParameters::setFacilities()
Clears incidents that were set by setIncidents().
Clears point barriers that were set by setPointBarriers().
Clears the polygon barriers that have been set on this ClosestFacilityParameters.
Clears polyline barriers that were set by ClosestFacilityParameters::setPolylineBarriers().
Returns the search WHERE clause from the specified sourceName.
See also setSearchWhereClause().
void setFacilities(list<Facility> facilities) |
Sets the facilities for a ClosestFacilityTask by providing a list of Facilities.
void setFacilitiesWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the facilities for a ClosestFacilityTask by providing a featureTable filtered with queryParameters.
void setIncidents(list<Incident> incidents) |
Sets the incidents for a ClosestFacilityTask by providing a list of Incidents.
void setIncidentsWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the incidents for a ClosestFacilityTask by providing a featureTable filtered with queryParameters.
void setPointBarriers(list<PointBarrier> pointBarriers) |
Sets the pointBarriers for a ClosestFacilityTask by providing a list of PointBarriers.
void setPointBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the point barriers for a ClosestFacilityTask by providing a featureTable filtered with queryParameters.
void setPolygonBarriers(list<PolygonBarrier> polygonBarriers) |
Sets the polygonBarriers for a ClosestFacilityTask by providing a list of PolygonBarriers.
void setPolygonBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the polygon barriers for a ClosestFacilityTask by providing a featureTable filtered with queryParameters.
void setPolylineBarriers(list<PolylineBarrier> polylineBarriers) |
Sets the polylineBarriers for a ClosestFacilityTask by providing a list of PolylineBarriers.
void setPolylineBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the polyline barriers for a ClosestFacilityTask by providing a featureTable filtered with queryParameters.
Sets the searchWhereClause for the specified sourceName.
This filters the potential matches returned from the task based on an expression.
See also searchWhereClause().