Skip To Content ArcGIS for Developers Sign In Dashboard

ServiceAreaParameters Class

class Esri::ArcGISRuntime::ServiceAreaParameters

Represents input parameters for computing service area using ServiceAreaTask. More...

Header: #include <ServiceAreaParameters>
Since: Esri::ArcGISRuntime 100.1

This class was introduced in Esri::ArcGISRuntime 100.1.

Public Functions

ServiceAreaParameters(Esri::ArcGISRuntime::ServiceAreaParameters &&other)
ServiceAreaParameters(const Esri::ArcGISRuntime::ServiceAreaParameters &other)
ServiceAreaParameters()
Esri::ArcGISRuntime::ServiceAreaParameters &operator=(Esri::ArcGISRuntime::ServiceAreaParameters &&other)
Esri::ArcGISRuntime::ServiceAreaParameters &operator=(const Esri::ArcGISRuntime::ServiceAreaParameters &other)
~ServiceAreaParameters()
QStringList accumulateAttributeNames() const
void clearFacilities()
void clearPointBarriers()
void clearPolygonBarriers()
void clearPolylineBarriers()
QList<double> defaultImpedanceCutoffs() const
Esri::ArcGISRuntime::ServiceAreaPolygonCutoffGeometry geometryAtCutoff() const
Esri::ArcGISRuntime::ServiceAreaOverlapGeometry geometryAtOverlap() const
bool isEmpty() const
bool isReturnPointBarriers() const
bool isReturnPolygonBarriers() const
bool isReturnPolygons() const
bool isReturnPolylineBarriers() const
bool isReturnPolylines() const
Esri::ArcGISRuntime::SpatialReference outputSpatialReference() const
double polygonBufferDistance() const
Esri::ArcGISRuntime::ServiceAreaPolygonDetail polygonDetail() const
QString searchWhereClause(const QString &sourceName) const
void setAccumulateAttributeNames(const QStringList &accumulateAttributeNames)
void setDefaultImpedanceCutoffs(const QList<double> &defaultImpedanceCutoffs)
void setFacilities(const QList<Esri::ArcGISRuntime::ServiceAreaFacility> &facilities)
void setFacilitiesWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::QueryParameters &queryParameters)
void setGeometryAtCutoff(Esri::ArcGISRuntime::ServiceAreaPolygonCutoffGeometry geometryAtCutoff)
void setGeometryAtOverlap(Esri::ArcGISRuntime::ServiceAreaOverlapGeometry geometryAtOverlap)
void setOutputSpatialReference(const Esri::ArcGISRuntime::SpatialReference &outputSpatialReference)
void setPointBarriers(const QList<Esri::ArcGISRuntime::PointBarrier> &pointBarriers)
void setPointBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::QueryParameters &queryParameters)
void setPolygonBarriers(const QList<Esri::ArcGISRuntime::PolygonBarrier> &polygonBarriers)
void setPolygonBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::QueryParameters &queryParameters)
void setPolygonBufferDistance(double polygonBufferDistance)
void setPolygonDetail(Esri::ArcGISRuntime::ServiceAreaPolygonDetail polygonDetail)
void setPolylineBarriers(const QList<Esri::ArcGISRuntime::PolylineBarrier> &polylineBarriers)
void setPolylineBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::QueryParameters &queryParameters)
void setReturnPointBarriers(bool returnPointBarriers)
void setReturnPolygonBarriers(bool returnPolygonBarriers)
void setReturnPolygons(bool returnPolygons)
void setReturnPolylineBarriers(bool returnPolylineBarriers)
void setReturnPolylines(bool returnPolylines)
void setSearchWhereClause(const QString &sourceName, const QString &searchWhereClause)
void setStartTime(const QDateTime &startTime)
void setTravelDirection(Esri::ArcGISRuntime::TravelDirection travelDirection)
void setTravelMode(const Esri::ArcGISRuntime::TravelMode &travelMode)
QDateTime startTime() const
Esri::ArcGISRuntime::TravelDirection travelDirection() const
Esri::ArcGISRuntime::TravelMode travelMode() const

Detailed Description

The ServiceAreaParameters class contains all inputs for the ServiceAreaTask, as well as settings such as the facilities, impedance attribute, accumulate and restriction attributes, backtrack (U-turn) policy, etc.

See also ServiceAreaTask::createDefaultParameters.

Member Function Documentation

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

Move constructor from other ServiceAreaParameters.

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

Copy constructor from other ServiceAreaParameters.

ServiceAreaParameters::ServiceAreaParameters()

Default constructor.

Warning: This is for convenience only and will construct an empty object.

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

Move operator from other ServiceAreaParameters.

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

Assignment operator from other ServiceAreaParameters.

ServiceAreaParameters::~ServiceAreaParameters()

Destructor.

QStringList ServiceAreaParameters::accumulateAttributeNames() const

Returns the list of network attribute names to be accumulated with the analysis.

See also setAccumulateAttributeNames().

void ServiceAreaParameters::clearFacilities()

Clears point barriers that were set by ServiceAreaParameters::setPointBarriers().

void ServiceAreaParameters::clearPointBarriers()

Clears polygon barriers that were set by ServiceAreaParameters::setPolygonBarriers().

void ServiceAreaParameters::clearPolygonBarriers()

Clears polyline barriers that were set by ServiceAreaParameters::setPolylineBarriers().

void ServiceAreaParameters::clearPolylineBarriers()

Clears the polyline barriers that have been set on this ServiceAreaParameters.

QList<double> ServiceAreaParameters::defaultImpedanceCutoffs() const

Returns the default impedance cutoffs.

See also setDefaultImpedanceCutoffs().

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

Returns the behavior of service area output for a single facility when multiple cutoff values are specified.

See also setGeometryAtCutoff().

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

Returns the behavior of service area output from multiple facilities in relation to one another.

See also setGeometryAtOverlap().

bool ServiceAreaParameters::isEmpty() const

Returns whether this ServiceAreaParameters is empty.

bool ServiceAreaParameters::isReturnPointBarriers() const

Returns whether point barriers are returned with the ServiceAreaResult.

bool ServiceAreaParameters::isReturnPolygonBarriers() const

Returns whether polygon barriers are returned with the ServiceAreaResult.

bool ServiceAreaParameters::isReturnPolygons() const

Returns whether to return ServiceAreaPolygons with the ServiceAreaResult.

bool ServiceAreaParameters::isReturnPolylineBarriers() const

Returns whether polyline barriers are returned with the ServiceAreaResult.

bool ServiceAreaParameters::isReturnPolylines() const

Returns whether to return ServiceAreaPolylines with the ServiceAreaResult.

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

Returns the output spatial reference.

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 level of detail of the output polygons.

See also setPolygonDetail().

QString ServiceAreaParameters::searchWhereClause(const QString &sourceName) const

Returns the search WHERE clause from the specified sourceName.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setSearchWhereClause().

void ServiceAreaParameters::setAccumulateAttributeNames(const QStringList &accumulateAttributeNames)

Sets the list of accumulate attribute names to be returned 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 for this ServiceAreaParameters from a list of ServiceAreaFacility objects (facilities).

void ServiceAreaParameters::setFacilitiesWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::QueryParameters &queryParameters)

Sets the facilities for this ServiceAreaParameters from an ArcGISFeatureTable.

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

Sets the behavior of service area output for a single facility when multiple cutoff values are specified to geometryAtCutoff.

See also geometryAtCutoff().

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

Sets the behavior of service area output from multiple facilities in relation to one another to geometryAtOverlap.

Specifies the behavior of service area output from multiple facilities in relation to one another.

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 on this ServiceAreaParameters from a list of PointBarrier objects (pointBarriers).

void ServiceAreaParameters::setPointBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::QueryParameters &queryParameters)

Sets the point barriers for a ServiceAreaParameters from an ArcGISFeatureTable.

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

Sets the polygon barriers on this ServiceAreaParameters from a list of PolygonBarrier objects (polygonBarriers).

void ServiceAreaParameters::setPolygonBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::QueryParameters &queryParameters)

Sets the polygon barriers for this ServiceAreaParameters from an ArcGISFeatureTable.

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 on a ServiceAreaParameters from a list of PolylineBarrier objects (polylineBarriers).

void ServiceAreaParameters::setPolylineBarriersWithFeatureTable(Esri::ArcGISRuntime::ArcGISFeatureTable *featureTable, const Esri::ArcGISRuntime::QueryParameters &queryParameters)

Sets the polyline barriers for a ServiceAreaParameters from an ArcGISFeatureTable.

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 whether to return ServiceAreaPolygons with the ServiceAreaResult to returnPolygons.

See also isReturnPolygons().

void ServiceAreaParameters::setReturnPolylineBarriers(bool returnPolylineBarriers)

Sets whether polyline barriers are returned with the ServiceAreaResult to returnPolylineBarriers.

See also isReturnPolylineBarriers().

void ServiceAreaParameters::setReturnPolylines(bool returnPolylines)

Sets whether to return ServiceAreaPolylines with the ServiceAreaResult to returnPolylines.

See also isReturnPolylines().

void ServiceAreaParameters::setSearchWhereClause(const QString &sourceName, const QString &searchWhereClause)

Sets the search WHERE clause from the specified sourceName to searchWhereClause.

This filters the potential matches returned from the task based on an expression.

Note: Search WHERE clauses are not supported for online service area tasks. They are only supported when solving local service area tasks.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also searchWhereClause().

void ServiceAreaParameters::setStartTime(const QDateTime &startTime)

Sets the start time of the route in UTC time to startTime.

See also startTime().

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

Sets the travel direction property to travelDirection.

See also travelDirection().

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

Sets the travel mode to travelMode.

See also travelMode().

QDateTime ServiceAreaParameters::startTime() const

Returns the start time of the route in UTC time.

See also setStartTime().

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

Returns the travel direction type.

See also setTravelDirection().

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

Returns the travel mode.

See also setTravelMode().


Feedback on this topic?