A facility used with a closest facility task. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.1 |
| Inherits: |
Properties
- curbApproach : Enums.CurbApproach
- currentBearing : double
- currentBearingTolerance : double
- distanceToNetworkLocation : double
- facilityId : int
- geometry : Point
- impedanceCutoff : double
- locationStatus : Enums.LocationStatus
- name : string
- navigationLatency : double
- navigationSpeed : double
- networkLocation : NetworkLocation
Signals
- curbApproachChanged()
- currentBearingChanged()
- currentBearingToleranceChanged()
- distanceToNetworkLocationChanged()
- facilityIdChanged()
- geometryChanged()
- impedanceCutoffChanged()
- locationStatusChanged()
- nameChanged()
- navigationLatencyChanged()
- navigationSpeedChanged()
- networkLocationChanged()
Methods
- double addedCost(string attributeName)
- void setAddedCost(string attributeName, double costValue)
Detailed Description
Facilities represent locations that can serve as the starting point or ending point of a closest facility analysis, such as a fire station or a hospital. ClosestFacilityParameters contain a list of Facility objects. The ClosestFacilityTask creates routes between facilities and incidents.
This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.
| Type | Default Property |
|---|---|
| Point | geometry |
| NetworkLocation | networkLocation |
Property Documentation
The curb approach for this Facility.
See also Enums.CurbApproach.
The current bearing of this Facility 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.
Bearing and bearing tolerance help to disambiguate how to locate facilities. For example, if you are driving on a freeway overpass and you need to reroute, then you would pass in your device compass bearing and a tolerance (say 45 degrees). This information is used to filter out streets that are potentially closer to your device x,y but are heading in the wrong direction (e.g. An underpass street might be closer to the x,y of your device but it is heading in the wrong direction and would be filtered out).
This property was introduced in Esri.ArcGISRuntime 100.7.
See also currentBearingTolerance.
The current bearing tolerance of this Facility in degrees.
Bearing and bearing tolerance are meant to be used together. If you only set one, then the other is ignored. Bearing tolerance units are in degrees. Bearing tolerance is plus or minus the currentBearing provided. For example, you could set the currentBearing to 360, to locate streets to the north, and provide a currentBearingTolerance of 45, to find streets plus or minus 45 degrees from north.
This property was introduced in Esri.ArcGISRuntime 100.7.
See also currentBearing.
The distance of this Facility to a network feature in meters (read-only).
Returns NaN if the facility has not been located.
The Impedance Cutoff of this Facility.
For instance, while finding the closest hospitals from the site of an accident, a cutoff value of 15 minutes would mean that the closest facility task would search for the closest hospital within 15 minutes from the incident. If the closest hospital is 17 minutes away, no routes will be returned in the output routes. A cutoff value is especially useful when searching for multiple facilities or incidents. The units for impedance cutoff is based on the value of the TravelMode.impedanceAttributeName. For example, if TravelMode.impedanceAttributeName is TravelTime, then impedanceCutoff is specified in minutes.
Returns the LocationStatus of this Facility (read-only).
See also Enums.LocationStatus.
The navigation latency of this Facility in seconds.
This property was introduced in Esri.ArcGISRuntime 100.7.
The navigation speed of this Facility in meters-per-second.
This property was introduced in Esri.ArcGISRuntime 100.7.
networkLocation : NetworkLocation |
The network location of this Facility.
Signal Documentation
Emitted when the curbApproach property of this Facility changes.
Note: The corresponding handler is onCurbApproachChanged.
Emitted when the currentBearing property of this Facility changes.
Note: The corresponding handler is onCurrentBearingChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the currentBearingTolerance property of this Facility changes.
Note: The corresponding handler is onCurrentBearingToleranceChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the distanceToNetworkLocation property of this Facility changes.
Note: The corresponding handler is onDistanceToNetworkLocationChanged.
Emitted when the facilityId property of this Facility changes.
Note: The corresponding handler is onFacilityIdChanged.
This signal was introduced in Esri.ArcGISRuntime 100.6.
Emitted when the geometry property of this Facility changes.
Note: The corresponding handler is onGeometryChanged.
Emitted when the impedanceCutoff property of this Facility changes.
Note: The corresponding handler is onImpedanceCutoffChanged.
Emitted when the locationStatus property of this Facility changes.
Note: The corresponding handler is onLocationStatusChanged.
Emitted when the name property of this Facility changes.
Note: The corresponding handler is onNameChanged.
Emitted when the navigationLatency property of this Facility changes.
Note: The corresponding handler is onNavigationLatencyChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the navigationSpeed property of this Facility changes.
Note: The corresponding handler is onNavigationSpeedChanged.
This signal was introduced in Esri.ArcGISRuntime 100.7.
Emitted when the networkLocation property of this Facility changes.
Note: The corresponding handler is onNetworkLocationChanged.
Method Documentation
Returns the added cost of a given attributeName.
See also setAddedCost().
Sets the costValue for a given attributeName.
See also addedCost().