Skip To Content ArcGIS for Developers Sign In Dashboard

ServiceAreaTaskInfo Class

(Esri::ArcGISRuntime::ServiceAreaTaskInfo)

Information about a ServiceAreaTask. More...

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

Public Functions

ServiceAreaTaskInfo()
ServiceAreaTaskInfo(const ServiceAreaTaskInfo &other)
ServiceAreaTaskInfo(ServiceAreaTaskInfo &&other)
~ServiceAreaTaskInfo()
QStringList accumulateAttributeNames() const
QMap<QString, CostAttribute> costAttributes() const
QList<double> defaultImpedanceCutoffs() const
QString defaultTravelModeName() const
ServiceAreaPolygonCutoffGeometry geometryAtCutoff() const
ServiceAreaOverlapGeometry geometryAtOverlap() const
bool isEmpty() const
bool isReturnPolygons() const
bool isReturnPolylines() const
double maxLocatingDistance() const
QString networkName() const
SpatialReference outputSpatialReference() const
double polygonBufferDistance() const
ServiceAreaPolygonDetail polygonDetail() const
QMap<QString, RestrictionAttribute> restrictionAttributes() const
QDateTime startTime() const
QStringList supportedRestrictionUsageParameterValues() const
TravelDirection travelDirection() const
QList<TravelMode> travelModes() const
ServiceAreaTaskInfo &operator=(const ServiceAreaTaskInfo &other)
ServiceAreaTaskInfo &operator=(ServiceAreaTaskInfo &&other)

Detailed Description

Information about a ServiceAreaTask.

ServiceAreaTaskInfo contains the network dataset defaults from the ServiceAreaTask once it is loaded. Use this class to obtain information about ServiceAreaTask defaults before setting ServiceAreaParameters.

Member Function Documentation

ServiceAreaTaskInfo::ServiceAreaTaskInfo()

Default constructor.

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

ServiceAreaTaskInfo::ServiceAreaTaskInfo(const ServiceAreaTaskInfo &other)

Copy constructor from other ServiceAreaTaskInfo.

ServiceAreaTaskInfo::ServiceAreaTaskInfo(ServiceAreaTaskInfo &&other)

Move constructor from other ServiceAreaTaskInfo.

ServiceAreaTaskInfo::~ServiceAreaTaskInfo()

Destructor.

QStringList ServiceAreaTaskInfo::accumulateAttributeNames() const

This is a default list of accumulative attribute names.

For example, accumulateAttributeNames = ["Miles", "Kilometers"] indicates that the total cost of the route should also be calculated in miles and kilometers. All supported attributes can be obtained from ServiceAreaTaskInfo.costAttributes method.

Note: The same list of accumulate attribute names can be obtained from ServiceAreaParameters.accumulateAttributeNames method.

QMap<QString, CostAttribute> ServiceAreaTaskInfo::costAttributes() const

Returns a map of available cost attributes from the network.

The key is the name as a QString, and the value is the CostAttribute.

QList<double> ServiceAreaTaskInfo::defaultImpedanceCutoffs() const

Returns the default impedance cutoff values.

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 than can be reached within 5, 10, and 15 minutes.

QString ServiceAreaTaskInfo::defaultTravelModeName() const

Returns the default travel mode name.

See also TravelMode.

ServiceAreaPolygonCutoffGeometry ServiceAreaTaskInfo::geometryAtCutoff() const

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

ServiceAreaOverlapGeometry ServiceAreaTaskInfo::geometryAtOverlap() const

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

bool ServiceAreaTaskInfo::isEmpty() const

Returns whether this ServiceAreaTaskInfo is empty.

bool ServiceAreaTaskInfo::isReturnPolygons() const

Returns the type of output to be generated.

bool ServiceAreaTaskInfo::isReturnPolylines() const

Returns the type of output to be generated.

double ServiceAreaTaskInfo::maxLocatingDistance() const

Maximum locating distance.

Maximum locating distance is the furthest distance (in meters) that Network Analyst searches when locating or relocating a point onto the network. The search looks for suitable edges or junctions and snaps the point to the nearest one. If a suitable location isn't found within the maximum locating distance, the object is marked as unlocated.

This function was introduced in Esri::ArcGISRuntime 100.6.

QString ServiceAreaTaskInfo::networkName() const

Returns the network name.

SpatialReference ServiceAreaTaskInfo::outputSpatialReference() const

Returns the default output spatial reference.

double ServiceAreaTaskInfo::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.

ServiceAreaPolygonDetail ServiceAreaTaskInfo::polygonDetail() const

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

QMap<QString, RestrictionAttribute> ServiceAreaTaskInfo::restrictionAttributes() const

Returns a map of available restriction attributes from the network.

The key is the name as a QString, and the value is the RestrictionAttribute.

QDateTime ServiceAreaTaskInfo::startTime() const

Returns the default start time in UTC time.

QStringList ServiceAreaTaskInfo::supportedRestrictionUsageParameterValues() const

Returns the supported values for soft restrictions.

Restrictions can be identified for particular elements such that, during an analysis, traversing restricted elements is prohibited entirely, avoided, or preferred. The values in this list which are assigned to the restriction usage parameter determines whether the restriction attribute prohibits, avoids, or prefers the network elements it is associated with. Furthermore, the degree to which network elements are avoided or preferred can be defined by choosing High, Medium, or Low.

TravelDirection ServiceAreaTaskInfo::travelDirection() const

Returns the default travel direction type.

QList<TravelMode> ServiceAreaTaskInfo::travelModes() const

Returns a list of travel modes set in the ServiceAreaParameters.

ServiceAreaTaskInfo &ServiceAreaTaskInfo::operator=(const ServiceAreaTaskInfo &other)

Assignment operator from other ServiceAreaTaskInfo.

ServiceAreaTaskInfo &ServiceAreaTaskInfo::operator=(ServiceAreaTaskInfo &&other)

Move operator from other ServiceAreaTaskInfo.


Feedback on this topic?