RouteParameters QML Type
A route parameters object contains parameters for route calculation. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
- List of all members, including inherited members
- RouteParameters is part of QML Type List.
Properties
- accumulateAttributeNames : list<string>
- directionsDistanceUnits : Enums.UnitSystem
- directionsLanguage : string
- directionsStyle : Enums.DirectionsStyle
- findBestSequence : bool
- outputSpatialReference : SpatialReference
- preserveFirstStop : bool
- preserveLastStop : bool
- returnDirections : bool
- returnPointBarriers : bool
- returnPolygonBarriers : bool
- returnPolylineBarriers : bool
- returnRoutes : bool
- returnStops : bool
- routeShapeType : Enums.RouteShapeType
- startTime : date
- travelMode : TravelMode
Signals
- accumulateAttributeNamesChanged()
- directionsDistanceUnitsChanged()
- directionsLanguageChanged()
- directionsStyleChanged()
- findBestSequenceChanged()
- outputSpatialReferenceChanged()
- preserveFirstStopChanged()
- preserveLastStopChanged()
- returnDirectionsChanged()
- returnPointBarriersChanged()
- returnPolygonBarriersChanged()
- returnPolylineBarriersChanged()
- returnRoutesChanged()
- returnStopsChanged()
- routeShapeTypeChanged()
- startTimeChanged()
- travelModeChanged()
Methods
- void clearPointBarriers()
- void clearPolygonBarriers()
- void clearPolylineBarriers()
- void clearStops()
- RouteParameters clone()
- string searchWhereClause(string sourceName)
- void setPointBarriers(list<PointBarriers> pointBarriers)
- void setPointBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setPolygonBarriers(list<PolygonBarriers> polygonBarriers)
- void setPolygonBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setPolylineBarriers(list<PolylineBarriers> polylineBarriers)
- void setPolylineBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setSearchWhereClause(string sourceName, string searchWhereClause)
- void setStops(list<Stop> stops)
- void setStopsWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
Detailed Description
A class that contains settings that are used when solving a Route_task. The Route_parameters class contains all inputs for the Route_task, as well as settings such as the impedance attribute, accumulate and restriction attributes, backtrack (u-turn) policy, etc.
Note: You cannot declare or create a component of this type in QML code. RouteParameters must be retrieved from the RouteTask so it will be assigned necessary defaults required to solve routes.
See also RouteTask::createDefaultParameters.
Property Documentation
accumulateAttributeNames : list<string> |
A list of network attribute names to be accumulated with the analysis.
directionsDistanceUnits : Enums.UnitSystem |
Directions distance text units.
A directions distance text units. Describes the unit of measurement for the length of directions.
directionsLanguage : string |
The language of the resulting route directions.
directionsStyle : Enums.DirectionsStyle |
Directions style.
A directions style. The directions setting to generate directions designed for different kind of applications.
findBestSequence : bool |
Whether the analysis should reorder stops to find the optimized route.
If the parameter value is false, the analysis returns a route that visits stops in the order you define. The order you define is the order that the stops are encountered in the array of stops in the RouteParameters. For example, the Stop at index zero is first, index 1 is second, and so on. If the parameter value is true, the analysis disregards the order you defined, and finds the best order to visit the stops. You can elect to preserve the first and/or the last stops while allowing the service to reorder intermediary stops by setting preserveFirstStop and preserveLastStop.
The default is false.
Note: A value of true causes the analysis to switch from solving a shortest-path problem to a traveling salesperson problem (TSP). Solving a TSP is computer-intensive operation and if using an online subscription-based service (e.g. ArcGIS Online) may incur additional service credits per route.
outputSpatialReference : SpatialReference |
The output spatial reference.
preserveFirstStop : bool |
Whether the analysis should preserve the first stop order.
This parameter is applicable only if findBestSequence is true.
preserveLastStop : bool |
Whether the analysis should preserve the last stop order.
This parameter is applicable only if findBestSequence is true.
returnDirections : bool |
Whether directions are returned with the RouteResult.
returnPointBarriers : bool |
Whether point barriers are returned with the RouteResult.
Reusing the PointBarriers from the RouteResult (as opposed to using the original PointBarriers) can increase the speed of any following route calculations.
returnPolygonBarriers : bool |
Whether polygon barriers are returned with the RouteResult.
Reusing the PolygonBarriers from the RouteResult (as opposed to using the original PolygonBarriers) can increase the speed of any subsequent route calculations. This is particularly true for complex polygons.
returnPolylineBarriers : bool |
Whether polyline barriers are returned with the RouteResult.
Reusing the PolylineBarriers from the RouteResult (as opposed to using the original PolylineBarriers) can increase the speed of any subsequent route calculations. This is particularly true for complex polylines.
returnRoutes : bool |
Whether routes are returned with the RouteResult.
returnStops : bool |
Whether stops are returned with the RouteResult.
routeShapeType : Enums.RouteShapeType |
The output shape type for a route.
See also Enums.RouteShapeType.
startTime : date |
The start time of the route in UTC time.
travelMode : TravelMode |
The travel mode for a route.
Signal Documentation
accumulateAttributeNamesChanged() |
Emitted when the accumulateAttributeNames property of this RouteParameters changes.
Note: The corresponding handler is onAccumulateAttributeNamesChanged.
directionsDistanceUnitsChanged() |
Emitted when the directionsDistanceUnits property of this RouteParameters changes.
Note: The corresponding handler is onDirectionsDistanceUnitsChanged.
directionsLanguageChanged() |
Emitted when the directionsLanguage property of this RouteParameters changes.
Note: The corresponding handler is onDirectionsLanguageChanged.
directionsStyleChanged() |
Emitted when the directionsStyle property of this RouteParameters changes.
Note: The corresponding handler is onDirectionsStyleChanged.
findBestSequenceChanged() |
Emitted when the findBestSequence property of this RouteParameters changes.
Note: The corresponding handler is onFindBestSequenceChanged.
outputSpatialReferenceChanged() |
Emitted when the outputSpatialReference property of this RouteParameters changes.
Note: The corresponding handler is onOutputSpatialReferenceChanged.
preserveFirstStopChanged() |
Emitted when the preserveFirstStop property of this RouteParameters changes.
Note: The corresponding handler is onPreserveFirstStopChanged.
preserveLastStopChanged() |
Emitted when the preserveLastStop property of this RouteParameters changes.
Note: The corresponding handler is onPreserveLastStopChanged.
returnDirectionsChanged() |
Emitted when the returnDirections property of this RouteParameters changes.
Note: The corresponding handler is onReturnDirectionsChanged.
returnPointBarriersChanged() |
Emitted when the returnPointBarriers property of this RouteParameters changes.
Note: The corresponding handler is onReturnPointBarriersChanged.
returnPolygonBarriersChanged() |
Emitted when the returnPolygonBarriers property of this RouteParameters changes.
Note: The corresponding handler is onReturnPolygonBarriersChanged.
returnPolylineBarriersChanged() |
Emitted when the returnPolylineBarriers property of this RouteParameters changes.
Note: The corresponding handler is onReturnPolylineBarriersChanged.
returnRoutesChanged() |
Emitted when the returnRoutes property of this RouteParameters changes.
Note: The corresponding handler is onReturnRoutesChanged.
returnStopsChanged() |
Emitted when the returnStops property of this RouteParameters changes.
Note: The corresponding handler is onReturnStopsChanged.
routeShapeTypeChanged() |
Emitted when the routeShapeType property of this RouteParameters changes.
Note: The corresponding handler is onRouteShapeTypeChanged.
startTimeChanged() |
Emitted when the startTime property of this RouteParameters changes.
Note: The corresponding handler is onStartTimeChanged.
travelModeChanged() |
Emitted when the travelMode property of this RouteParameters changes.
Note: The corresponding handler is onTravelModeChanged.
Method Documentation
void clearPointBarriers() |
Clears the point barriers that have been set on this RouteParameters.
void clearPolygonBarriers() |
Clears the polygon barriers that have been set on this RouteParameters.
void clearPolylineBarriers() |
Clears the polyline barriers that have been set on this RouteParameters.
void clearStops() |
Clears the stops that have been set on this RouteParameters.
|
Creates a deep copy of this object.
This method was introduced in Esri.ArcGISRuntime 200.1.
string searchWhereClause(string sourceName) |
Gets the search where clause from the specified network dataset's source feature class.
- sourceName - The name of the network dataset's source feature class to retrieve the where clause from.
See also setSearchWhereClause().
void setPointBarriers(list<PointBarriers> pointBarriers) |
Sets the pointBarriers for a RouteTask by providing a list of PointBarrier.
void setPointBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the point barriers from the features in specified feature table.
The feature table can be either local or online. The feature table must be of geometry type point. Attributes from the feature table are mapped to the properties on the barrier objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.
- featureTable - The feature table.
- queryParameters - The query parameters.
See also FeatureTable.
void setPolygonBarriers(list<PolygonBarriers> polygonBarriers) |
Sets the polygonBarriers for a RouteTask by providing a list of PolygonBarrier.
void setPolygonBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the polygon barriers from the features in specified feature table.
The feature table can be either local or online. The feature table must be of geometry type polygon. Attributes from the feature table are mapped to the properties on the barrier objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.
- featureTable - The feature table.
- queryParameters - The query parameters.
See also FeatureTable.
void setPolylineBarriers(list<PolylineBarriers> polylineBarriers) |
Sets the polylineBarriers for a RouteTask by providing a list of PolygonBarrier.
void setPolylineBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the polyline barriers from the features in specified feature table.
The feature table can be either local or online. The feature table must be of geometry type polyline. Attributes from the feature table are mapped to the properties on the barrier objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.
- featureTable - The feature table.
- queryParameters - The query parameters.
See also FeatureTable.
void setSearchWhereClause(string sourceName, string searchWhereClause) |
Sets a search where clause on the specified network dataset's source feature class.
Only features satisfying the where clause for the specified feature class will be used to locate stops on the network during the solve operation. If a where clause is not set all network features are used.
- sourceName - The name of the network dataset's source feature class the where clause will be applied to.
- searchWhereClause - The search where clause.
Note: Search WHERE clauses are not supported for online route tasks. They are only supported when solving local route tasks.
See also searchWhereClause().
void setStops(list<Stop> stops) |
void setStopsWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the stops from the features in specified feature table.
The feature table can be either local or online. The feature table must be of geometry type point. Attributes from the feature table are mapped to the properties on the stops objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the features will not be queried until Solve is called.
A minimum of 2 stops are required to complete a RouteTask.
- featureTable - The feature table.
- queryParameters - The query parameters.
See also FeatureTable.