RouteParameters class final
A route parameters object contains parameters for route calculation.
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.
- Implemented types
Constructors
- RouteParameters()
-
Creates a route parameters.
factory
Properties
-
accumulateAttributeNames
→ List<
String> -
Accumulate attribute names.
no setter
- directionsDistanceUnits ↔ UnitSystem
-
Directions distance text units.
getter/setter pair
- directionsLanguage ↔ String
-
Directions language.
getter/setter pair
- directionsStyle ↔ DirectionsStyle
-
Directions style.
getter/setter pair
- findBestSequence ↔ bool
-
Find best sequence.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- outputSpatialReference ↔ SpatialReference?
-
Output spatial reference.
getter/setter pair
- preserveFirstStop ↔ bool
-
Preserve first stop.
getter/setter pair
- preserveLastStop ↔ bool
-
Preserve last stop.
getter/setter pair
- returnDirections ↔ bool
-
Return directions status.
getter/setter pair
- returnPointBarriers ↔ bool
-
Return point barriers.
getter/setter pair
- returnPolygonBarriers ↔ bool
-
Return polygon barriers.
getter/setter pair
- returnPolylineBarriers ↔ bool
-
Return polyline barriers.
getter/setter pair
- returnRoutes ↔ bool
-
Return routes.
getter/setter pair
- returnStops ↔ bool
-
Return stops.
getter/setter pair
- routeShapeType ↔ RouteShapeType
-
Route shape type.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startTime ↔ DateTime?
-
Start time.
getter/setter pair
- travelMode ↔ TravelMode?
-
Travel mode.
getter/setter pair
Methods
-
clearPointBarriers(
) → void - Clears point barriers.
-
clearPolygonBarriers(
) → void - Clears polygon barriers.
-
clearPolylineBarriers(
) → void - Clears polyline barriers.
-
clearStops(
) → void - Clears stops.
-
clone(
) → RouteParameters - Clones the RouteParameters.
-
getSearchWhereClause(
{required String sourceName}) → String - Gets the search where clause from the specified network dataset's source feature class.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setPointBarriers(
List< PointBarrier> pointBarriers) → void - Sets point barriers.
-
setPointBarriersWithFeatureTable(
{required ArcGISFeatureTable featureTable, required QueryParameters queryParameters}) → void - 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.
-
setPolygonBarriers(
List< PolygonBarrier> polygonBarriers) → void - Sets polygon barriers.
-
setPolygonBarriersWithFeatureTable(
{required ArcGISFeatureTable featureTable, required QueryParameters queryParameters}) → void - 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.
-
setPolylineBarriers(
{required List< PolylineBarrier> lineBarriers}) → void - Sets polyline barriers.
-
setPolylineBarriersWithFeatureTable(
{required ArcGISFeatureTable featureTable, required QueryParameters queryParameters}) → void - 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.
-
setSearchWhereClause(
{required String sourceName, required String searchWhereClause}) → void - 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.
-
setStops(
List< Stop> stops) → void - Sets stops.
-
setStopsWithFeatureTable(
{required ArcGISFeatureTable featureTable, required QueryParameters queryParameters}) → void - 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.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited