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

RouteTask

class RouteTask : ApiKeyResource, Loadable, Resourceable

A route task object is used for calculation route by specified parameters. A class that implements the route task. The route task class uses a transportation network to create a route between multiple stops. The route generated and the results returned honor the settings provided by a route settings object.

Since

200.1.0

Constructors

RouteTask

constructor(pathToDatabase: String, networkName: String)

Creates a route task with path to geodatabase. Creates a route task.

constructor(dataset: TransportationNetworkDataset)

Creates a route task with path to geodatabase. Creates a route task.

constructor(url: String)

Creates a route task with URL. Creates a route task with specified service URL.

Types

Companion

object Companion

Properties

transportationNetworkDataset

val transportationNetworkDataset: TransportationNetworkDataset?

Transportation network dataset of local route task.

url

val url: String?

The URL of online service.

Inherited properties

apiKey

open override var apiKey: ApiKey?

The API key allows your app to access ArcGIS location services and private portal items. An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the Generate API keys privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

Functions

createDefaultParameters

suspend fun createDefaultParameters(): Result<RouteParameters>

Creates default parameters. Generates default parameters.

createParameters

suspend fun createParameters(collection: FeatureCollection): Result<RouteParameters>

Imports route parameters from feature collection and then adjusts imported parameters to current Route task. Travel mode would be null if it could not be created from the route layer settings for the route task's network. In case if travel mode is null then client can override it by another travel mode (for example obtained from RouteTaskInfo). Accumulate attributes from Route Info table going to be applied only if they exist in transportation network restriction and cost attributes.

suspend fun createParameters(portalItem: PortalItem): Result<RouteParameters>

Imports route parameters from portal item and then adjusts imported parameters to current Route task. Travel mode would be null if it could not be created from the route layer settings for the route task's network. In case if travel mode is null then client can override it by another travel mode (for example obtained from RouteTaskInfo). Accumulate attributes from Route Info table going to be applied only if they exist in transportation network restriction and cost attributes.

getRouteTaskInfo

fun getRouteTaskInfo(): RouteTaskInfo

Gets route task info. Generates default parameters.

solveRoute

suspend fun solveRoute(routeParameters: RouteParameters): Result<RouteResult>

Solves a route passing in a parameters object.

Inherited functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

load

open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

retryLoad

open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.