Skip To Content ArcGIS for Developers Sign In Dashboard

Incident QML Type

A class that represents an incident. More...

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.1
Inherits:

Object

Properties

Signals

Methods

Detailed Description

An Incident is a location that can serve as the starting point or end point of a closest facility analysis, for example, a fire or a traffic accident. Incidents are part of ClosestFacilityParameters which is used as an input to ClosestFacilityTask.solveClosestFacilityRoute.

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.

Property Documentation

curbApproach : Enums.CurbApproach

The curb approach for this Incident.

See also Enums.CurbApproach.


currentBearing : double

The current bearing of this Incident 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 incidents. 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.


currentBearingTolerance : double

The current bearing tolerance of this Incident 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.


distanceToNetworkLocation : double

Returns the distance of this Incident to a network feature in meters (read-only).

Returns NaN if the facility has not been located.


geometry : Point

Returns the Point geometry of where this Incident is located (read-only).


impedanceCutoff : double

The impedance cutoff of this Incident.

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 facility. 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.


incidentId : int

The ID of this Incident.

This property was introduced in Esri.ArcGISRuntime 100.6.


locationStatus : Enums.LocationStatus

Returns the LocationStatus of this Incident (read-only).

See also Enums.LocationStatus.


name : string

The name of this Incident.


The navigation latency of this Incident in seconds.

This property was introduced in Esri.ArcGISRuntime 100.7.


The navigation speed of this Incident in meters-per-second.

This property was introduced in Esri.ArcGISRuntime 100.7.


networkLocation : NetworkLocation

The network location of this Incident.


targetFacilityCount : double

The target facility count of this Incident.

Specifies the number of facilities that need to be found for the incident. A negative value means that the target facility count property is not considered, but the default is used instead. The default value can be obtained from ClosestFacilityTaskInfo.defaultTargetFacilityCount.


Signal Documentation

curbApproachChanged()

Emitted when the curbApproach property of this Incident changes.

Note: The corresponding handler is onCurbApproachChanged.


currentBearingChanged()

Emitted when the currentBearing property of this Incident changes.

Note: The corresponding handler is onCurrentBearingChanged.

This signal was introduced in Esri.ArcGISRuntime 100.7.


currentBearingToleranceChanged()

Emitted when the currentBearingTolerance property of this Incident changes.

Note: The corresponding handler is onCurrentBearingToleranceChanged.

This signal was introduced in Esri.ArcGISRuntime 100.7.


distanceToNetworkLocationChanged()

Emitted when the distanceToNetworkLocation property of this Incident changes.

Note: The corresponding handler is onDistanceToNetworkLocationChanged.


geometryChanged()

Emitted when the geometry property of this Incident changes.

Note: The corresponding handler is onGeometryChanged.


impedanceCutoffChanged()

Emitted when the impedanceCutoff property of this Incident changes.

Note: The corresponding handler is onImpedanceCutoffChanged.


incidentIdChanged()

Emitted when the incidentId property of this Incident changes.

Note: The corresponding handler is onIncidentIdChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.


locationStatusChanged()

Emitted when the locationStatus property of this Incident changes.

Note: The corresponding handler is onLocationStatusChanged.


nameChanged()

Emitted when the name property of this Incident changes.

Note: The corresponding handler is onNameChanged.


Emitted when the navigationLatency property of this Incident changes.

Note: The corresponding handler is onNavigationLatencyChanged.

This signal was introduced in Esri.ArcGISRuntime 100.7.


Emitted when the navigationSpeed property of this Incident changes.

Note: The corresponding handler is onNavigationSpeedChanged.

This signal was introduced in Esri.ArcGISRuntime 100.7.


networkLocationChanged()

Emitted when the networkLocation property of this Incident changes.

Note: The corresponding handler is onNetworkLocationChanged.


targetFacilityCountChanged()

Emitted when the targetFacilityCount property of this Incident changes.

Note: The corresponding handler is onTargetFacilityCountChanged.


Method Documentation

double addedCost(attributeName)

Returns the added cost of a given attributeName.

See also setAddedCost().


void setAddedCost(attributeName, double costValue)

Sets the costValue for a given attributeName.

See also addedCost().



Feedback on this topic?