Class ClosestFacilityParameters
A class that contains input parameters used when solving a ClosestFacilityTask.
Inheritance
Namespace: Esri.ArcGISRuntime.Tasks.NetworkAnalysis
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class ClosestFacilityParameters : objectRemarks
The ClosestFacilityParameters class contains all inputs for the ClosestFacilityTask, as well as settings such as the impedance attribute, accumulate and restriction attributes, backtrack (u-turn) policy, etc.
Consider using the CreateDefaultParametersAsync() method to get an instance of this class that is initialized with smart default values based on the task's metadata.
Properties
| Name | Description |
|---|---|
| AccumulateAttributeNames | Gets A list of network attributes to be accumulated and returned as part of a solve result. |
| DefaultImpedanceCutoff | Gets or sets the default cutoff beyond which incidents or facilities will not be traversed. |
| DefaultTargetFacilityCount | Gets or sets the default number of target facilities to find for each incident. |
| DirectionsDistanceUnits | Gets or sets the linear units to use for distances in turn-by-turn directions. |
| DirectionsLanguage | Gets or sets the output directions language (e.g. "en-US"). |
| DirectionsStyle | Gets or sets the style for returned directions. |
| OutputSpatialReference | Gets or sets the SpatialReference in which the result geometries should be returned. |
| ReturnDirections | Gets or sets a value indicating whether or not turn-by-turn directions for the closest facility routes are to be returned. |
| ReturnPointBarriers | Gets or sets a value indicating whether or not to return the point barriers used in the closest facility task. |
| ReturnPolygonBarriers | Gets or sets a value indicating whether or not to return the polygon barriers used in the closest facility task. |
| ReturnPolylineBarriers | Gets or sets a value indicating whether or not to return the polyline barriers used in the closest facility task. |
| ReturnRoutes | Gets or sets a value indicating whether to include route geometries in closest facility calculation results. |
| RouteShapeType | Gets or sets the RouteShapeType of resulting route geometries. |
| StartTime | Gets or sets the time that the route begins (in UTC). |
| StartTimeUsage | Gets or sets a value that determines whether the StartTime is used as the time of departing from the facility or incident, or time of arriving at the facility or incident. |
| TravelDirection | Gets or sets a value that specifies the TravelDirection between facilities and incidents. |
| TravelMode | Gets or sets a value that specifies the TravelMode to use when computing the routes. |
Methods
| Name | Description |
|---|---|
| ClearFacilities() | Clears any previously set facilities. |
| ClearIncidents() | Clears any previously set incidents. |
| ClearPointBarriers() | Clears any previously set point barriers. |
| ClearPolygonBarriers() | Clears any previously set polygon barriers. |
| ClearPolylineBarriers() | Clears any previously set polyline barriers. |
| GetSearchWhereClause(String) | Gets the search filter that specifies which network elements facilities and incidents can be located on. |
| SetFacilities(ArcGISFeatureTable, QueryParameters) | Sets facilities to use in the analysis from a feature table. |
| SetFacilities(IEnumerable<Facility>) | Sets the facilities to use in the analysis. |
| SetIncidents(ArcGISFeatureTable, QueryParameters) | Sets incidents to use in the analysis from a feature table. |
| SetIncidents(IEnumerable<Incident>) | Sets incidents to use in the analysis. |
| SetPointBarriers(ArcGISFeatureTable, QueryParameters) | Sets point barriers to avoid in the result route from a feature table. |
| SetPointBarriers(IEnumerable<PointBarrier>) | Sets point barriers to avoid in the result route. |
| SetPolygonBarriers(ArcGISFeatureTable, QueryParameters) | Sets polygon barriers to avoid in the result route from a feature table. |
| SetPolygonBarriers(IEnumerable<PolygonBarrier>) | Sets polygon barriers to avoid in the result route. |
| SetPolylineBarriers(ArcGISFeatureTable, QueryParameters) | Sets polyline barriers to avoid in the result route from a feature table. |
| SetPolylineBarriers(IEnumerable<PolylineBarrier>) | Sets polyline barriers to avoid in the result route. |
| SetSearchWhereClause(String, String) | Sets a search filter that specifies which network elements facilities and incidents can be located on. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 100.15 |
| .NET 6.0 | 100.13 - 100.15 |
| .NET 6.0 Windows | 100.13 - 100.15 |
| .NET Framework | 100.1 - 100.15 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Xamarin.Android | 100.1 - 100.15 |
| Xamarin.iOS | 100.1 - 100.15 |
| UWP | 100.1 - 100.15 |