PointBarrier QML Type
A point barrier object is used to restrict route solving. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
- List of all members, including inherited members
- PointBarrier is part of QML Type List.
Properties
- barrierId : int
- barrierType : Enums.BarrierType
- curbApproach : Enums.CurbApproach
- geometry : Point
- locationStatus : Enums.LocationStatus
- name : string
Signals
- barrierIdChanged()
- barrierTypeChanged()
- curbApproachChanged()
- geometryChanged()
- locationStatusChanged()
- nameChanged()
Methods
- double addedCost(string attributeName)
- PointBarrier clone()
- void setAddedCost(string attributeName, double addedCost)
Detailed Description
A class that represents a point location to be avoided (or penalized) by a route. A point barrier may represent a restricted location to be avoided by a route (e.g., a car accident) or a location at which some additional delay occurs if visited along a route (e.g., a railroad crossing).
The point barrier class is derived from the graphic class.
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
[since Esri.ArcGISRuntime 100.6] barrierId : int |
Point barrier ID.
This is a caller supplied foreign key that can be used to associate output point barriers with input point barriers.
This property was introduced in Esri.ArcGISRuntime 100.6.
See also RouteParameters::setPointBarriers, RouteResult::pointBarriers, ClosestFacilityParameters::setPointBarriers, ClosestFacilityResult::pointBarriers, ServiceAreaParameters::setPointBarriers, and ServiceAreaResult::pointBarriers.
barrierType : Enums.BarrierType |
The BarrierType of this PointBarrier.
See also Enums.BarrierType.
curbApproach : Enums.CurbApproach |
The CurbApproach of this PointBarrier.
See also Enums.CurbApproach.
[default] geometry : Point |
The Point of this PointBarrier.
[read-only] locationStatus : Enums.LocationStatus |
The LocationStatus of this PointBarrier.
See also Enums.LocationStatus.
[since Esri.ArcGISRuntime 100.3] name : string |
The name of this PointBarrier.
This property was introduced in Esri.ArcGISRuntime 100.3.
Signal Documentation
|
Emitted when the barrierId property of this PointBarrier changes.
Note: The corresponding handler is onBarrierIdChanged.
This signal was introduced in Esri.ArcGISRuntime 100.6.
barrierTypeChanged() |
Emitted when the barrierType property of this PointBarrier changes.
Note: The corresponding handler is onBarrierTypeChanged.
curbApproachChanged() |
Emitted when the curbApproach property of this PointBarrier changes.
Note: The corresponding handler is onCurbApproachChanged.
geometryChanged() |
Emitted when the geometry property of this PointBarrier changes.
Note: The corresponding handler is onGeometryChanged.
locationStatusChanged() |
Emitted when the locationStatus property of this PointBarrier changes.
Note: The corresponding handler is onLocationStatusChanged.
|
Emitted when the name property of this PointBarrier changes.
Note: The corresponding handler is onNameChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
Method Documentation
double addedCost(string attributeName) |
Gets added cost.
- attributeName - The name of attribute.
Get the amount of additional cost that has been added for a particular attribute on this Stop. If no cost has been added, or an incorrect name is specified, a value of zero will be returned.
See also setAddedCost().
|
Creates a deep copy of this object.
This method was introduced in Esri.ArcGISRuntime 200.1.
void setAddedCost(string attributeName, double addedCost) |
Sets added cost.
- attributeName - The name of attribute.
- addedCost - The added cost.
Set the amount of additional cost for an attribute by name. Any additional cost, e.g. Minutes, TravelTime, Kilometers, can be modified with this method.
See also addedCost().