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

Facility

A class that represents a facility. Facilities represent locations that can serve as the starting point or ending point of a closest facility analysis, for example, a fire station or a hospital. The Facility class contains one of location inputs for the ClosestFacilityTask. The ClosestFacilityTask will create a route between facilities and incidents.

Since

200.1.0

Constructors

Facility

fun Facility(point: Point)

Creates a facility instance with point. Creates a facility.

Properties

curbApproach

var curbApproach: CurbApproach

Curb approach. Default value CurbApproach.EitherSide will be returned on error.

currentBearing

var currentBearing: Double

Current bearing in degrees. Current bearing in degrees, measured clockwise from true north. Typical values are 0 to 360 or NaN, negative values will be subtracted from 360 (e.g. -15 => 345), values greater than 360 will be have 360 subtracted from them (e.g. 385 => 25). For this property to be used the bearing tolerance also has to be set.

currentBearingTolerance

var currentBearingTolerance: Double

Current bearing tolerance in degrees. Valid values are 0 to 180 or NaN.

distanceToNetworkLocation

val distanceToNetworkLocation: Double

Distance to network location in meters. The distance to network location in meters can be populated by closest facility task.

facilityId

var facilityId: Int

Facility ID. This is a caller supplied foreign key that can be used to associate output facilities with input facilities.

geometry

val geometry: Point?

The geometry of a facility. Gets facility's location using geographical point.

impedanceCutoff

var impedanceCutoff: Double

Impedance cutoff. It's a value for the impedance beyond which facilities should not be found.

locationStatus

val locationStatus: LocationStatus

Location status. Facility location's status can be populated by closest facility task. Default value LocationStatus.NotLocated will be returned on error.

name

var name: String

Facility's name. Facility's name to be reported in driving directions.

navigationLatency

var navigationLatency: Double

Navigation latency in seconds.

navigationSpeed

var navigationSpeed: Double

Navigation speed in meters per second.

networkLocation

var networkLocation: NetworkLocation?

Network location. The facility's location on the network that can be populated by closest facility task. Set to null for resetting a network location.

Functions

clone

fun clone(): Facility

Clones the Facility.

getAddedCost

fun getAddedCost(attributeName: String): Double

Gets added cost. Returns added cost value for given impedance or accumulate attribute.

setAddedCost

fun setAddedCost(attributeName: String, addedCost: Double)

Sets added cost. Sets added cost value for given impedance or accumulate attribute.

Facility

Since

See also

Constructors

Properties

Functions