A location to stop along a Route. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
Properties
- arrivalCurbApproach : Enums.CurbApproach
- arrivalTime : date
- arrivalTimeShift : double
- curbApproach : Enums.CurbApproach
- currentBearing : double
- currentBearingTolerance : double
- departureCurbApproach : Enums.CurbApproach
- departureTime : date
- departureTimeShift : double
- distanceToNetworkLocation : double
- geometry : Point
- locationStatus : Enums.LocationStatus
- name : string
- navigationLatency : double
- navigationSpeed : double
- networkLocation : NetworkLocation
- routeName : string
- sequence : int
- stopId : int
- stopType : Enums.StopType
- timeWindowEnd : date
- timeWindowStart : date
- violationTime : double
- waitTime : double
Signals
- arrivalCurbApproachChanged()
- arrivalTimeChanged()
- arrivalTimeShiftChanged()
- curbApproachChanged()
- currentBearingChanged()
- currentBearingToleranceChanged()
- departureCurbApproachChanged()
- departureTimeChanged()
- departureTimeShiftChanged()
- distanceToNetworkLocationChanged()
- geometryChanged()
- locationStatusChanged()
- nameChanged()
- navigationLatencyChanged()
- navigationSpeedChanged()
- networkLocationChanged()
- routeNameChanged()
- sequenceChanged()
- stopIdChanged()
- stopTypeChanged()
- timeWindowEndChanged()
- timeWindowStartChanged()
- violationTimeChanged()
- waitTimeChanged()
Methods
- double addedCost(string attributeName)
- double cumulativeCost(string attributeName)
- double setAddedCost(string attributeName, double addedCost)
Detailed Description
A RouteTask solves a routing problem expressed in a RouteParameters. A RouteParameters includes two or more Stops that the routing solution must visit, including the route's starting location. For example, when routing between your house and your workplace, your house is one stop and your workplace is another.
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
Returns the arrival curb approach for this Stop (read-only).
See also Enums.CurbApproach.
Returns the value of time zone shift in minutes for the arrival time (read-only).
The curb approach for this Stop.
See also Enums.CurbApproach.
The current bearing of this Stop.
Current bearing in degrees, measured clockwise from true north. Typical values are 0 to 360 or NaN. Negative values are subtracted from 360 (e.g. -15 => 345). Values greater than 360 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 stops. 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).
See also currentBearingTolerance.
The current bearing tolerance of this Stop.
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.
See also currentBearing.
Returns the departure curb approach for this Stop (read-only).
See also Enums.CurbApproach.
Returns the value of time zone shift in minutes for the departure time (read-only).
Returns the distance in meters of this Stop along a network path (read-only).
Returns NaN if the Stop has not been located.
Returns the LocationStatus of this Stop (read-only).
See also Enums.LocationStatus.
[default] networkLocation : NetworkLocation |
The NetworkLocation of this Stop.
The name of the Route to which the stop belongs.
For example, if you want to find two distinct routes - a route with 4 stops and another with 6 stops - set the name to "Route1" for each of the four stops and "Route2" for each of the 6 stops.
The type of a stop.
This property was introduced in Esri.ArcGISRuntime 100.1.
See also Enums.StopType.
The end of the time window of this Stop in UTC time.
This is the latest time that the Stop can be visited.
The start of the time window of this Stop in UTC time.
This is the earliest time that the Stop can be visited.
Signal Documentation
Emitted when the arrivalCurbApproach property of this Stop changes.
Note: The corresponding handler is onArrivalCurbApproachChanged.
Emitted when the arrivalTime property of this Stop changes.
Note: The corresponding handler is onArrivalTimeChanged.
Emitted when the arrivalTimeShift property of this Stop changes.
Note: The corresponding handler is onArrivalTimeShiftChanged.
Emitted when the curbApproach property of this Stop changes.
Note: The corresponding handler is onCurbApproachChanged.
Emitted when the currentBearing property of this Stop changes.
Note: The corresponding handler is onCurrentBearingChanged.
Emitted when the currentBearingTolerance property of this Stop changes.
Note: The corresponding handler is onCurrentBearingToleranceChanged.
Emitted when the departureCurbApproach property of this Stop changes.
Note: The corresponding handler is onDepartureCurbApproachChanged.
Emitted when the departureTime property of this Stop changes.
Note: The corresponding handler is onDepartureTimeChanged.
Emitted when the departureTimeShift property of this Stop changes.
Note: The corresponding handler is onDepartureTimeShiftChanged.
Emitted when the distanceToNetworkLocation property of this Stop changes.
Note: The corresponding handler is onDistanceToNetworkLocationChanged.
Emitted when the geometry property of this Stop changes.
Note: The corresponding handler is onGeometryChanged.
Emitted when the locationStatus property of this Stop changes.
Note: The corresponding handler is onLocationStatusChanged.
Emitted when the name property of this Stop changes.
Note: The corresponding handler is onNameChanged.
Emitted when the navigationLatency property of this Stop changes.
Note: The corresponding handler is onNavigationLatencyChanged.
Emitted when the navigationSpeed property of this Stop changes.
Note: The corresponding handler is onNavigationSpeedChanged.
Emitted when the networkLocation property of this Stop changes.
Note: The corresponding handler is onNetworkLocationChanged.
Emitted when the routeName property of this Stop changes.
Note: The corresponding handler is onRouteNameChanged.
Emitted when the sequence property of this Stop changes.
Note: The corresponding handler is onSequenceChanged.
Emitted when the stopId property of this Stop changes.
Note: The corresponding handler is onStopIdChanged.
This signal was introduced in Esri.ArcGISRuntime 100.6.
Emitted when the stopType property of this Stop changes.
Note: The corresponding handler is onStopTypeChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Emitted when the timeWindowEnd property of this Stop changes.
Note: The corresponding handler is onTimeWindowEndChanged.
Emitted when the timeWindowStart property of this Stop changes.
Note: The corresponding handler is onTimeWindowStartChanged.
Emitted when the violationTime property of this Stop changes.
Note: The corresponding handler is onViolationTimeChanged.
Emitted when the waitTime property of this Stop changes.
Note: The corresponding handler is onWaitTimeChanged.
Method Documentation
Returns added cost of a given attributeName.
See also setAddedCost().
Sets the addedCost for a given attributeName.
See also addedCost().