ServiceAreaParameters Class

Member Function Documentation

ServiceAreaParameters::ServiceAreaParameters()

Default constructor.

ServiceAreaParameters::ServiceAreaParameters(const Esri::ArcGISRuntime::ServiceAreaParameters &other)

Copy constructor from other ServiceAreaParameters.

ServiceAreaParameters::ServiceAreaParameters(Esri::ArcGISRuntime::ServiceAreaParameters &&other)

Move constructor from other ServiceAreaParameters.

ServiceAreaParameters::~ServiceAreaParameters()

Destructor.

QStringList ServiceAreaParameters::accumulateAttributeNames() const

Returns the 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.

See also setAccumulateAttributeNames().

void ServiceAreaParameters::clearFacilities()

Clears the facilities.

Clears facilities that were set by setFacilitiesWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable*, const Esri::ArcGISRuntime::QueryParameters&).

void ServiceAreaParameters::clearPointBarriers()

Clears the point barriers.

Clears point barriers that were set by setPointBarriers(const QList<Esri::ArcGISRuntime::PointBarrier>&) or setPointBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable*, const Esri::ArcGISRuntime::QueryParameters&).

void ServiceAreaParameters::clearPolygonBarriers()

Clears the polygon barriers.

Clears polygon barriers that were set by setPolygonBarriers(const QList<Esri::ArcGISRuntime::PolygonBarrier>&) or setPolygonBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable*, const Esri::ArcGISRuntime::QueryParameters&).

void ServiceAreaParameters::clearPolylineBarriers()

Clears the polyline barriers.

Clears polyline barriers that were set by setPolylineBarriers(const QList<Esri::ArcGISRuntime::PolylineBarrier>&) or setPolylineBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable*, const Esri::ArcGISRuntime::QueryParameters&).

[since Esri::ArcGISRuntime 200.1] Esri::ArcGISRuntime::ServiceAreaParameters ServiceAreaParameters::clone() const

Clones the ServiceAreaParameters to a new instance.

Returns a new instance of the current ServiceAreaParameters.

This function was introduced in Esri::ArcGISRuntime 200.1.

QList<double> ServiceAreaParameters::defaultImpedanceCutoffs() const

Returns the default impedance cutoffs.

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.

See also setDefaultImpedanceCutoffs().

Esri::ArcGISRuntime::ServiceAreaPolygonCutoffGeometry ServiceAreaParameters::geometryAtCutoff() const

Returns the 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.

See also setGeometryAtCutoff().

Esri::ArcGISRuntime::ServiceAreaOverlapGeometry ServiceAreaParameters::geometryAtOverlap() const

Returns the 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.

See also setGeometryAtOverlap().

bool ServiceAreaParameters::isEmpty() const

Returns a bool that determines whether this ServiceAreaParameters is empty.

bool ServiceAreaParameters::isReturnPointBarriers() const

Returns a bool that determines whether point barriers are returned with the ServiceAreaResult.

bool ServiceAreaParameters::isReturnPolygonBarriers() const

Returns a bool that determines whether polygon barriers are returned with the ServiceAreaResult.

bool ServiceAreaParameters::isReturnPolygons() const

Returns a bool that determines whether to return ServiceAreaPolygons with the ServiceAreaResult.

Enabled by default. Can be returned in the ServiceAreaResult of a successful solve.

bool ServiceAreaParameters::isReturnPolylineBarriers() const

Returns a bool that determines whether polyline barriers are returned with the ServiceAreaResult.

bool ServiceAreaParameters::isReturnPolylines() const

Returns a bool that determines whether or not return service area polylines are to be returned.

Disabled by default. Can be returned in the ServiceAreaResult of a successful solve.

Esri::ArcGISRuntime::SpatialReference ServiceAreaParameters::outputSpatialReference() const

Returns the output spatial reference.

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

See also setOutputSpatialReference().

double ServiceAreaParameters::polygonBufferDistance() const

Returns the polygon buffer distance in meters.

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.

See also setPolygonBufferDistance().

Esri::ArcGISRuntime::ServiceAreaPolygonDetail ServiceAreaParameters::polygonDetail() const

Returns the 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.

See also setPolygonDetail().

[since Esri::ArcGISRuntime 100.6] QString ServiceAreaParameters::searchWhereClause(const QString &sourceName) const

Returns 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.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setSearchWhereClause().

void ServiceAreaParameters::setAccumulateAttributeNames(const QStringList &accumulateAttributeNames)

Sets the accumulateAttributeNames to accumulateAttributeNames.

See also accumulateAttributeNames.

void ServiceAreaParameters::setDefaultImpedanceCutoffs(const QList<double> &defaultImpedanceCutoffs)

Sets the default impedance cutoffs to defaultImpedanceCutoffs.

See also defaultImpedanceCutoffs.

void ServiceAreaParameters::setFacilities(const QList<Esri::ArcGISRuntime::ServiceAreaFacility> &facilities)

Sets the facilities.

• facilities - A QList of ServiceAreaFacility instances. Contents of the QList are copied.

The set of service area facilities loaded as network locations during analysis. You need to specify at least one facility to successfully ServiceAreaTask::solveServiceAreaAsync(const Esri::ArcGISRuntime::ServiceAreaParameters&).

void ServiceAreaParameters::setFacilitiesWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::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.

void ServiceAreaParameters::setGeometryAtCutoff(Esri::ArcGISRuntime::ServiceAreaPolygonCutoffGeometry geometryAtCutoff)

Sets the geometryAtCutoff to geometryAtCutoff.

See also geometryAtCutoff.

void ServiceAreaParameters::setGeometryAtOverlap(Esri::ArcGISRuntime::ServiceAreaOverlapGeometry geometryAtOverlap)

Sets the geometryAtOverlap to geometryAtOverlap.

See also geometryAtOverlap.

void ServiceAreaParameters::setOutputSpatialReference(const Esri::ArcGISRuntime::SpatialReference &outputSpatialReference)

Sets the output spatial reference to outputSpatialReference.

See also outputSpatialReference.

void ServiceAreaParameters::setPointBarriers(const QList<Esri::ArcGISRuntime::PointBarrier> &pointBarriers)

Sets the point barriers.

• pointBarriers - A QList of PointBarrier instances. Contents of the QList are copied.

void ServiceAreaParameters::setPointBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::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.

void ServiceAreaParameters::setPolygonBarriers(const QList<Esri::ArcGISRuntime::PolygonBarrier> &polygonBarriers)

Sets the polygon barriers.

• polygonBarriers - A QList of PolygonBarrier instances. Contents of the QList are copied.

void ServiceAreaParameters::setPolygonBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::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.

void ServiceAreaParameters::setPolygonBufferDistance(double polygonBufferDistance)

Sets the polygon buffer distance to polygonBufferDistance.

See also polygonBufferDistance.

void ServiceAreaParameters::setPolygonDetail(Esri::ArcGISRuntime::ServiceAreaPolygonDetail polygonDetail)

Sets the polygon detail level to polygonDetail.

See also polygonDetail.

void ServiceAreaParameters::setPolylineBarriers(const QList<Esri::ArcGISRuntime::PolylineBarrier> &polylineBarriers)

Sets the polyline barriers.

• polylineBarriers - A QList of PolylineBarrier instances. Contents of the QList are copied.

void ServiceAreaParameters::setPolylineBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::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.

void ServiceAreaParameters::setReturnPointBarriers(bool returnPointBarriers)

Sets whether to return point barriers with the ServiceAreaResult to returnPointBarriers.

See also isReturnPointBarriers.

void ServiceAreaParameters::setReturnPolygonBarriers(bool returnPolygonBarriers)

Sets whether polygon barriers are returned with the ServiceAreaResult to returnPolygonBarriers.

See also isReturnPolygonBarriers.

void ServiceAreaParameters::setReturnPolygons(bool returnPolygons)

Sets the returnPolygons to returnPolygons.

See also isReturnPolygons.

void ServiceAreaParameters::setReturnPolylineBarriers(bool returnPolylineBarriers)

Sets the returnPolylineBarriers to returnPolylineBarriers.

See also isReturnPolylineBarriers.

void ServiceAreaParameters::setReturnPolylines(bool returnPolylines)

Sets the returnPolylines to returnPolylines.

See also isReturnPolylines.

[since Esri::ArcGISRuntime 100.6] void ServiceAreaParameters::setSearchWhereClause(const QString &sourceName, const QString &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 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.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also searchWhereClause().

void ServiceAreaParameters::setStartTime(const QDateTime &startTime)

Sets the startTime to startTime.

See also startTime.

void ServiceAreaParameters::setTravelDirection(Esri::ArcGISRuntime::TravelDirection travelDirection)

Sets the travelDirection to travelDirection.

See also travelDirection.

void ServiceAreaParameters::setTravelMode(const Esri::ArcGISRuntime::TravelMode &travelMode)

Sets the travelMode to travelMode.

See also travelMode.

QDateTime ServiceAreaParameters::startTime() const

Returns the start time.

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

See also setStartTime().

Esri::ArcGISRuntime::TravelDirection ServiceAreaParameters::travelDirection() const

Returns the travel direction for the service area computation (to or from facility).

Default value TravelDirection::FromFacility will be returned on error.

See also setTravelDirection().

Esri::ArcGISRuntime::TravelMode ServiceAreaParameters::travelMode() const

Returns the 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.

See also setTravelMode().

Esri::ArcGISRuntime::ServiceAreaParameters &ServiceAreaParameters::operator=(const Esri::ArcGISRuntime::ServiceAreaParameters &other)

Assignment operator from other ServiceAreaParameters.

Esri::ArcGISRuntime::ServiceAreaParameters &ServiceAreaParameters::operator=(Esri::ArcGISRuntime::ServiceAreaParameters &&other)

Move operator from other ServiceAreaParameters.