arcgis-maps-kotlin/com.arcgismaps.tasks.networkanalysis/RouteParameters

RouteParameters

class RouteParameters

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.

Since

200.1.0

See also

Constructors

Link copied to clipboard
fun RouteParameters()

Creates a route parameters. Creates a route parameters object.

Properties

Link copied to clipboard
val accumulateAttributeNames: MutableList<String>

Accumulate attribute names.

Link copied to clipboard
var directionsDistanceUnits: UnitSystem

Directions distance text units. A directions distance text units. Describes the unit of measurement for the length of directions.

Link copied to clipboard
var directionsLanguage: String

Directions language.

Link copied to clipboard
var directionsStyle: DirectionsStyle

Directions style. A directions style. The directions setting to generate directions designed for different kind of applications.

Link copied to clipboard
var findBestSequence: Boolean

Find best sequence.

Link copied to clipboard
var outputSpatialReference: SpatialReference?

Output spatial reference.

Link copied to clipboard
var preserveFirstStop: Boolean

Preserve first stop.

Link copied to clipboard
var preserveLastStop: Boolean

Preserve last stop.

Link copied to clipboard
var returnDirections: Boolean

Return directions status.

Link copied to clipboard
var returnPointBarriers: Boolean

Return point barriers.

Link copied to clipboard
var returnPolygonBarriers: Boolean

Return polygon barriers.

Link copied to clipboard
var returnPolylineBarriers: Boolean

Return polyline barriers.

Link copied to clipboard
var returnRoutes: Boolean

Return routes.

Link copied to clipboard
var returnStops: Boolean

Return stops.

Link copied to clipboard
var routeShapeType: RouteShapeType

Route shape type.

Link copied to clipboard
var startTime: Instant?

Start time.

Link copied to clipboard
var travelMode: TravelMode?

Travel mode. Travel mode instance for route parameters.

Functions

Link copied to clipboard
fun clearPointBarriers()

Clears point barriers.

Link copied to clipboard
fun clearPolygonBarriers()

Clears polygon barriers.

Link copied to clipboard
fun clearPolylineBarriers()

Clears polyline barriers.

Link copied to clipboard
fun clearStops()

Clears stops.

Link copied to clipboard
Link copied to clipboard
fun getSearchWhereClause(sourceName: String): String

Gets the search where clause from the specified network dataset's source feature class.

Link copied to clipboard
fun setPointBarriers(pointBarriers: Iterable<PointBarrier>)

Sets point barriers.

fun setPointBarriers(featureTable: ArcGISFeatureTable, 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.

Link copied to clipboard
fun setPolygonBarriers(polygonBarriers: Iterable<PolygonBarrier>)

Sets polygon barriers.

fun setPolygonBarriers(featureTable: ArcGISFeatureTable, 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.

Link copied to clipboard
fun setPolylineBarriers(lineBarriers: Iterable<PolylineBarrier>)

Sets polyline barriers.

fun setPolylineBarriers(featureTable: ArcGISFeatureTable, 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.

Link copied to clipboard
fun setSearchWhereClause(sourceName: String, searchWhereClause: String)

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.

Link copied to clipboard
fun setStops(stops: Iterable<Stop>)

Sets stops.

fun setStops(featureTable: ArcGISFeatureTable, 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.