A class that contains settings that are used when solving a ClosestFacilityTask. More...
Import Statement: | import Esri.ArcGISRuntime |
Since: | Esri.ArcGISRuntime 100.1 |
Inherits: |
- List of all members, including inherited members
- ClosestFacilityParameters is part of QML Type List.
Properties
- accumulateAttributeNames : list<string>
- defaultImpedanceCutoff : double
- defaultTargetFacilityCount : int
- directionsDistanceUnits : Enums.UnitSystem
- directionsLanguage : string
- directionsStyle : Enums.DirectionsStyle
- outputSpatialReference : SpatialReference
- returnDirections : bool
- returnPointBarriers : bool
- returnPolygonBarriers : bool
- returnPolylineBarriers : bool
- returnRoutes : bool
- routeShapeType : Enums.RouteShapeType
- startTime : date
- startTimeUsage : Enums.StartTimeUsage
- travelDirection : Enums.TravelDirection
- travelMode : TravelMode
Signals
- accumulateAttributeNamesChanged()
- defaultImpedanceCutoffChanged()
- defaultTargetFacilityCountChanged()
- directionsDistanceUnitsChanged()
- directionsLanguageChanged()
- directionsStyleChanged()
- outputSpatialReferenceChanged()
- returnDirectionsChanged()
- returnPointBarriersChanged()
- returnPolygonBarriersChanged()
- returnPolylineBarriersChanged()
- returnRoutesChanged()
- routeShapeTypeChanged()
- startTimeChanged()
- startTimeUsageChanged()
- travelDirectionChanged()
- travelModeChanged()
Methods
- void clearFacilities()
- void clearIncidents()
- void clearPointBarriers()
- void clearPolygonBarriers()
- void clearPolylineBarriers()
- ClosestFacilityParameters clone()
- string searchWhereClause(string sourceName)
- void setFacilities(list<Facility> facilities)
- void setFacilitiesWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setIncidents(list<Incident> incidents)
- void setIncidentsWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setPointBarriers(list<PointBarrier> pointBarriers)
- void setPointBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setPolygonBarriers(list<PolygonBarrier> polygonBarriers)
- void setPolygonBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setPolylineBarriers(list<PolylineBarrier> polylineBarriers)
- void setPolylineBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters)
- void setSearchWhereClause(string sourceName, string searchWhereClause)
Detailed Description
The ClosestFacilityParameters class contains all inputs for the ClosestFacilityTask, as well as settings such as the impedance attribute, accumulate and restriction attributes, backtrack (u-turn) policy, etc.
Note: You cannot declare or create a component of this type in QML code. The standard pattern is to retrieve one from the ClosestFacilityTask type so it already contain defaults values necessary for solving closest facility.
See also ClosestFacilityTask::createDefaultParameters.
Property Documentation
accumulateAttributeNames : list<string> |
Accumulate attribute names.
The accumulate attribute names e.g. "Minutes", "Miles", etc. Accumulate attributes are useful when more information other than the default impedance attribute is required.
defaultImpedanceCutoff : double |
The default cutoff value to stop traversing.
The units for impedance cutoff is based on the value of the TravelMode.impedanceAttributeName. For example, if TravelMode.impedanceAttributeName parameter is TravelTime, the defaultImpedanceCutoff is specified in minutes.
defaultTargetFacilityCount : int |
The default number of facilities to find.
directionsDistanceUnits : Enums.UnitSystem |
Directions distance units.
Describes the unit of measurement for the length of directions. Default value Enums.UnitSystemMetric will be returned on error.
directionsLanguage : string |
Directions language e.g. "en-US".
The ISO language code of the directions language to be set. If an unsupported language is set, an exception will occur at solve time in ClosestFacilityTask::solveClosestFacility(ClosestFacilityParameters) method.
directionsStyle : Enums.DirectionsStyle |
Directions style.
The directions setting to generate directions designed for different kind of applications. Default value Enums.DirectionsStyleDesktop will be returned on error.
outputSpatialReference : SpatialReference |
The output spatial reference.
All route's geometries will be returned in this spatial reference in the even of a successful solve.
returnDirections : bool |
Whether or not turn-by-turn directions for the closest facility routes are to be returned.
returnPointBarriers : bool |
The returnPointBarriers of the ClosestFacilityParameters.
Reusing the PointBarriers from the ClosestFacilityResult (as opposed to using the original PointBarriers) can increase the speed of any subsequent route calculations.
returnPolygonBarriers : bool |
The returnPolygonBarriers of the ClosestFacilityParameters.
Reusing the PolygonBarriers from the ClosestFacilityResult (as opposed to using the original PolygonBarriers) can increase the speed of any subsequent route calculations. This is particularly true for complex polygons.
returnPolylineBarriers : bool |
The returnPolylineBarriers of the ClosestFacilityParameters.
Reusing the PolylineBarriers from the ClosestFacilityResult (as opposed to using the original PolylineBarriers) can increase the speed of any subsequent route calculations. This is particularly true for complex polylines.
returnRoutes : bool |
Whether or not return routes are to be returned.
Enabled by default. Can be returned in the event of a successful solve.
routeShapeType : Enums.RouteShapeType |
Route shape type.
The enumeration value for the output shape type e.g. straight line shape, true
shape, or no shape. Default value Enums.RouteShapeTypeNone will be returned on error.
startTime : date |
The start time of the route in UTC time.
Expects time in the time zone of first Stop.
startTimeUsage : Enums.StartTimeUsage |
The startTimeUsage of the ClosestFacilityParameters.
Default value Enums.StartTimeUsageDepartureTime will be returned on error.
travelDirection : Enums.TravelDirection |
The travel direction for the closest facility computation (to or from facility).
Default value Enums.TravelDirectionFromFacility will be returned on error.
travelMode : TravelMode |
Travel mode.
Travel mode that will be used for closest facility's solving. List of supported travel modes can be obtained from ClosestFacilityTaskInfo::travelModes method.
Signal Documentation
accumulateAttributeNamesChanged() |
Emitted when the accumulateAttributeNames property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onAccumulateAttributeNamesChanged
.
defaultImpedanceCutoffChanged() |
Emitted when the defaultImpedanceCutoff property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onDefaultImpedanceCutoffChanged
.
defaultTargetFacilityCountChanged() |
Emitted when the defaultTargetFacilityCount property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onDefaultTargetFacilityCountChanged
.
directionsDistanceUnitsChanged() |
Emitted when the directionsDistanceUnits property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onDirectionsDistanceUnitsChanged
.
directionsLanguageChanged() |
Emitted when the directionsLanguage property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onDirectionsLanguageChanged
.
directionsStyleChanged() |
Emitted when the directionsStyle property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onDirectionsStyleChanged
.
outputSpatialReferenceChanged() |
Emitted when the outputSpatialReference property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onOutputSpatialReferenceChanged
.
returnDirectionsChanged() |
Emitted when the returnDirections property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onReturnDirectionsChanged
.
returnPointBarriersChanged() |
Emitted when the returnPointBarriers property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onReturnPointBarriersChanged
.
returnPolygonBarriersChanged() |
Emitted when the returnPolygonBarriers property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onReturnPolygonBarriersChanged
.
returnPolylineBarriersChanged() |
Emitted when the returnPolylineBarriers property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onReturnPolylineBarriersChanged
.
returnRoutesChanged() |
Emitted when the returnRoutes property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onReturnRoutesChanged
.
routeShapeTypeChanged() |
Emitted when the routeShapeType property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onRouteShapeTypeChanged
.
startTimeChanged() |
Emitted when the startTime property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onStartTimeChanged
.
startTimeUsageChanged() |
Emitted when the startTimeUsage property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onStartTimeUsageChanged
.
travelDirectionChanged() |
Emitted when the travelDirection property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onTravelDirectionChanged
.
travelModeChanged() |
Emitted when the travelMode property of this ClosestFacilityParameters changes.
Note: The corresponding handler is onTravelModeChanged
.
Method Documentation
void clearFacilities() |
Clears facilities that were set by ClosestFacilityParameters::setFacilities()
void clearIncidents() |
Clears incidents that were set by setIncidents().
void clearPointBarriers() |
Clears point barriers that were set by setPointBarriers().
void clearPolygonBarriers() |
Clears the polygon barriers that have been set on this ClosestFacilityParameters.
void clearPolylineBarriers() |
Clears polyline barriers that were set by ClosestFacilityParameters::setPolylineBarriers().
|
Creates a deep copy of this object.
This method was introduced in Esri.ArcGISRuntime 200.1.
string searchWhereClause(string sourceName) |
Gets the search where clause from the specified network dataset's source feature class.
- sourceName - The name of the network dataset's source feature class to retrieve the where clause from.
See also setSearchWhereClause().
void setFacilities(list<Facility> facilities) |
void setFacilitiesWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the facilities from the features in specified feature table.
The feature table can be either local or online. The feature table must be of geometry type point. Attributes from the feature table are mapped to the properties on the facilities objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.
- featureTable - The feature table.
- queryParameters - The query parameters.
Sets facilities by importing them from local or remote table.
See also FeatureTable and QueryParameters.
void setIncidents(list<Incident> incidents) |
void setIncidentsWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the incidents from the features in specified feature table.
The feature table can be either local or online. The feature table must be of geometry type point. Attributes from the feature table are mapped to the properties on the incidents objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.
- featureTable - The feature table.
- queryParameters - The query parameters.
Sets incidents by importing them from local or remote table.
See also FeatureTable and QueryParameters.
void setPointBarriers(list<PointBarrier> pointBarriers) |
Sets point barriers.
- pointBarriers - A list of PointBarrier instances. Contents of the list are copied.
See also PointBarrier.
void setPointBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the point barriers from the features in specified feature table.
The feature table can be either local or online. The feature table must be of geometry type point. Attributes from the feature table are mapped to the properties on the barrier objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.
- featureTable - The feature table.
- queryParameters - The query parameters.
Sets point barriers by importing them from local or remote table.
See also FeatureTable and QueryParameters.
void setPolygonBarriers(list<PolygonBarrier> polygonBarriers) |
Sets polygon barriers.
- polygonBarriers - A list of PolygonBarrier instances. Contents of the list are copied.
See also PolygonBarrier.
void setPolygonBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the polygon barriers from the features in specified feature table.
The feature table can be either local or online. The feature table must be of geometry type polygon. Attributes from the feature table are mapped to the properties on the barrier objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.
- featureTable - The feature table.
- queryParameters - The query parameters.
Sets polygon barriers by importing them from local or remote table.
See also FeatureTable and QueryParameters.
void setPolylineBarriers(list<PolylineBarrier> polylineBarriers) |
Sets polyline barriers.
- polylineBarriers - A list of PolylineBarrier instances. Contents of the list are copied.
See also PolylineBarrier.
void setPolylineBarriersWithFeatureTable(ArcGISFeatureTable featureTable, QueryParameters queryParameters) |
Sets the polyline barriers from the features in specified feature table.
The feature table can be either local or online. The feature table must be of geometry type polyline. Attributes from the feature table are mapped to the properties on the barrier objects generated from the specified feature table. The where clause set in the query parameters will be applied to the feature table. If an online feature table is specified the table will not be queried for features until Solve is called.
- featureTable - The feature table.
- queryParameters - The query parameters.
Sets polyline barriers by importing them from local or remote table.
See also FeatureTable and QueryParameters.
void setSearchWhereClause(string sourceName, string searchWhereClause) |
Sets a search where clause on the specified network dataset's source feature class.
Only features satisfying the where clause for the specified feature class will be used to locate facilities or incidents on the network during the solve operation. If a where clause is not set all network features are used.
- sourceName - The name of the network dataset's source feature class the where clause will be applied to.
- searchWhereClause - The search where clause.
See also searchWhereClause().