ClosestFacilityParameters class final
A class that contains settings that are used when solving a ClosestFacilityTask.
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.
- Implemented types
Properties
-
accumulateAttributeNames
→ List<
String> -
Accumulate attribute names.
no setter
- defaultImpedanceCutoff ↔ double
-
The default cutoff value to stop traversing.
getter/setter pair
- defaultTargetFacilityCount ↔ int
-
The default number of target facilities to find.
getter/setter pair
- directionsDistanceUnits ↔ UnitSystem
-
Directions distance units.
getter/setter pair
- directionsLanguage ↔ String
-
Directions language e.g. "en-US".
getter/setter pair
- directionsStyle ↔ DirectionsStyle
-
Directions style.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- outputSpatialReference ↔ SpatialReference?
-
Output spatial reference.
getter/setter pair
- returnDirections ↔ bool
-
Whether or not turn-by-turn directions for the closest facility routes are
to be returned.
getter/setter pair
- returnPointBarriers ↔ bool
-
Whether or not to return the point barriers used in the closest facility
task.
getter/setter pair
- returnPolygonBarriers ↔ bool
-
Whether or not to return the polygon barriers used in the closest facility
task.
getter/setter pair
- returnPolylineBarriers ↔ bool
-
Whether or not to return the polyline barriers used in the closest
facility task.
getter/setter pair
- returnRoutes ↔ bool
-
Whether or not return routes are to be returned.
getter/setter pair
- routeShapeType ↔ RouteShapeType
-
Route shape type.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- startTime ↔ DateTime?
-
Start time.
getter/setter pair
- startTimeUsage ↔ StartTimeUsage
-
Start time usage.
getter/setter pair
- travelDirection ↔ TravelDirection
-
The travel direction for the closest facility computation (to or from
facility).
getter/setter pair
- travelMode ↔ TravelMode?
-
Travel mode.
getter/setter pair
Methods
-
clearFacilities(
) → void - Clears facilities.
-
clearIncidents(
) → void - Clears incidents.
-
clearPointBarriers(
) → void - Clears point barriers.
-
clearPolygonBarriers(
) → void - Clears polygon barriers.
-
clearPolylineBarriers(
) → void - Clears polyline barriers.
-
clone(
) → ClosestFacilityParameters - Clones the ClosestFacilityParameters.
-
getSearchWhereClause(
{required String sourceName}) → String - Gets the search where clause from the specified network dataset's source feature class.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setFacilities(
List< Facility> facilities) → void - Sets facilities.
-
setFacilitiesWithFeatureTable(
{required ArcGISFeatureTable featureTable, required QueryParameters queryParameters}) → void - 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.
-
setIncidents(
List< Incident> incidents) → void - Sets incidents.
-
setIncidentsWithFeatureTable(
{required ArcGISFeatureTable featureTable, required QueryParameters queryParameters}) → void - 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.
-
setPointBarriers(
List< PointBarrier> pointBarriers) → void - Sets point barriers.
-
setPointBarriersWithFeatureTable(
{required ArcGISFeatureTable featureTable, required QueryParameters queryParameters}) → void - 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.
-
setPolygonBarriers(
List< PolygonBarrier> polygonBarriers) → void - Sets polygon barriers.
-
setPolygonBarriersWithFeatureTable(
{required ArcGISFeatureTable featureTable, required QueryParameters queryParameters}) → void - 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.
-
setPolylineBarriers(
{required List< PolylineBarrier> lineBarriers}) → void - Sets polyline barriers.
-
setPolylineBarriersWithFeatureTable(
{required ArcGISFeatureTable featureTable, required QueryParameters queryParameters}) → void - 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.
-
setSearchWhereClause(
{required String sourceName, required String searchWhereClause}) → void - 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.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited