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

ClosestFacilityTask

class ClosestFacilityTask : ApiKeyResource, Loadable, Resourceable

A class that implements the closest facility task. The closest facility task class uses a transportation network to measure the cost of traveling between incidents and facilities and determines which are nearest to one other. When finding closest facilities, you can specify how many to find and whether the direction of travel is toward or away from them.

Since

200.1.0

Constructors

ClosestFacilityTask

constructor(pathToDatabase: String, networkName: String)

Creates a closest facility task with path to geodatabase.

constructor(dataset: TransportationNetworkDataset)

Creates a closest facility task with transportation network dataset.

constructor(url: String)

Creates a closest facility task with URL. Creates a closest facility task.

Properties

closestFacilityTaskInfo

val closestFacilityTaskInfo: ClosestFacilityTaskInfo?

Closest facility task info. Information about this closest facility task. For a closest facility task using an online service, this will involve a network call.

transportationNetworkDataset

val transportationNetworkDataset: TransportationNetworkDataset?

Transportation network dataset.

url

val url: String?

The URL of online service.

Inherited properties

apiKey

open override var apiKey: ApiKey?

An API key is a unique key used to authorize access to specific services and resources in ArcGIS Online. It is also used to monitor access to those services.

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

Functions

createDefaultParameters

suspend fun createDefaultParameters(): Result<ClosestFacilityParameters>

Creates default parameters. Retrieves the default parameters as defined by the service.

solveClosestFacility

suspend fun solveClosestFacility(closestFacilityParameters: ClosestFacilityParameters): Result<ClosestFacilityResult>

Solves a closest facility passing in a parameters object. Executes the ClosestFacilityParameters defined for this ClosestFacilityTask and returns a ClosestFacilityResult containing the results.