ServiceAreaParameters

A class that describes the service area parameters. Class holding the parameters of a service area to be solved by ServiceAreaTask. The default parameters for a ServiceAreaTask can be retrieved by calling ServiceAreaTask.createDefaultParameters() method.

Since

200.1.0

See also

Properties

Link copied to clipboard

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.

Link copied to clipboard

The default cutoffs value. Cutoffs specify the quantity of the impedance to apply. They constrain the extent of the service area to be calculated. For example, if you apply breaks of 5, 10, and 15 when the impedance is set to Time, the service area will include those streets that can be reached within 5, 10, and 15 minutes. The cutoffs you specify in the defaultBreaks property are applied to all facilities that don't contain their own cutoffs.

Link copied to clipboard

Geometry at cutoff. Specifies the behavior of service area output for a single facility when multiple cutoff values are specified. This parameter does not apply to line output. Default value ServiceAreaPolygonCutoffGeometry.Rings will be returned on error.

Link copied to clipboard

Geometry at overlap. Specifies the behavior of service-area output from multiple facilities in relation to one another. Default value ServiceAreaOverlapGeometry.Overlap will be returned on error.

Link copied to clipboard

Output spatial reference. All route's geometries will be returned in this spatial reference in the even of a successful solve.

Link copied to clipboard

Polygon buffer distance. The polygon buffer refers to the distance from the road the service area polygon should extend when no other reachable roads are nearby, similar to a line buffer size. This is useful if the network is very sparse and you don't want the service area to cover large areas where there are no features.

Link copied to clipboard

Polygon detail. Specifies the level of detail of the output polygons. If your analysis covers an urban area with a grid-like street network, the difference between generalized and standard polygons will be minimal. However, for mountain and rural roads, the standard and detailed polygons may present significantly more accurate results than generalized polygons. Default value ServiceAreaPolygonDetail.Standard will be returned on error.

Link copied to clipboard

Whether or not to return the point barriers used in the service area task.

Link copied to clipboard

Whether or not to return the polygon barriers used in the service area task.

Link copied to clipboard

Whether or not return service area polygons are to be returned. Enabled by default. Can be returned in the ServiceAreaResult of a successful solve.

Link copied to clipboard

Whether or not to return the polyline barriers used in the service area task.

Link copied to clipboard

Whether or not return service area polylines are to be returned. Disabled by default. Can be returned in the ServiceAreaResult of a successful solve.

Link copied to clipboard

Start time. Start time in the UTC time zone. Returns null if start time was not specified.

Link copied to clipboard

The travel direction for the service area computation (to or from facility). Default value TravelDirection.FromFacility will be returned on error.

Link copied to clipboard

Travel mode. Travel mode that will be used for service area's solving. List of supported travel modes can be obtained from ServiceAreaTaskInfo.travelModes method.

Functions

Link copied to clipboard

Clears facilities. Clears facilities that were set by ServiceAreaParameters.setFacilities(ArcGISFeatureTable, QueryParameters).

Link copied to clipboard
Link copied to clipboard

Gets the search where clause from the specified network dataset's source feature class.

Link copied to clipboard

Sets facilities. The set of service area facilities loaded as network locations during analysis. You need to specify at least one facility to successfully ServiceAreaTask.solveServiceArea(ServiceAreaParameters).

fun setFacilities(featureTable: ArcGISFeatureTable, 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. Sets facilities by importing them from local or remote table.

Link copied to clipboard

Sets point barriers.

fun setPointBarriers(featureTable: ArcGISFeatureTable, 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. Sets point barriers by importing them from local or remote table.

Link copied to clipboard

Sets polygon barriers.

fun setPolygonBarriers(featureTable: ArcGISFeatureTable, 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. Sets polygon barriers by importing them from local or remote table.

Link copied to clipboard

Sets polyline barriers.

fun setPolylineBarriers(featureTable: ArcGISFeatureTable, 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. Sets polyline barriers by importing them from local or remote table.

Link copied to clipboard
fun setSearchWhereClause(sourceName: String, searchWhereClause: String)

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 on the network during the solve operation. If a where clause is not set all network features are used.