Skip To Content ArcGIS for Developers Sign In Dashboard

RouteTaskInfo Class


Information about a RouteTask. More...

Header: #include <RouteTaskInfo>
Since: Esri::ArcGISRuntime 100.0

Public Functions

RouteTaskInfo(const RouteTaskInfo &other)
RouteTaskInfo(RouteTaskInfo &&other)
QStringList accumulateAttributeNames() const
QMap<QString, CostAttribute> costAttributes() const
QString defaultTravelModeName() const
UnitSystem directionsDistanceUnits() const
QString directionsLanguage() const
DirectionsStyle directionsStyle() const
NetworkDirectionsSupport directionsSupport() const
bool isEmpty() const
bool isFindBestSequence() const
bool isPreserveFirstStop() const
bool isPreserveLastStop() const
bool isSupportsRerouting() const
double maxLocatingDistance() const
QString networkName() const
SpatialReference outputSpatialReference() const
QMap<QString, RestrictionAttribute> restrictionAttributes() const
RouteShapeType routeShapeType() const
QDateTime startTime() const
QStringList supportedLanguages() const
QStringList supportedRestrictionUsageParameterValues() const
QList<TravelMode> travelModes() const
RouteTaskInfo &operator=(const RouteTaskInfo &other)
RouteTaskInfo &operator=(RouteTaskInfo &&other)

Detailed Description

Information about a RouteTask.

RouteTaskInfo contains the network dataset defaults from the RouteTask once it is loaded. Use this class to obtain information about RouteTask defaults before setting RouteParameters.

Member Function Documentation


Default constructor.

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

RouteTaskInfo::RouteTaskInfo(const RouteTaskInfo &other)

Copy constructor from other RouteTaskInfo.

RouteTaskInfo::RouteTaskInfo(RouteTaskInfo &&other)

Move constructor from other RouteTaskInfo.



QStringList RouteTaskInfo::accumulateAttributeNames() const

Returns names of all the accumulated attributes.

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

Returns the cost attributes as a key-value pair.

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

QString RouteTaskInfo::defaultTravelModeName() const

Returns the name of the default travel mode.

If the route task is initialized with a URL or local network that has no travel modes, then the default travel mode name is an empty string.

UnitSystem RouteTaskInfo::directionsDistanceUnits() const

Returns the units in which the length information will be reported in the route directions.

QString RouteTaskInfo::directionsLanguage() const

Returns the language of the resulting route directions.

DirectionsStyle RouteTaskInfo::directionsStyle() const

Returns the style of the resulting route directions.

NetworkDirectionsSupport RouteTaskInfo::directionsSupport() const

Returns whether the underlying network dataset supports the returning of directions.

Note: For services prior to ArcGIS 10.8, this value will be NetworkDirectionsSupport::Unknown.

This function was introduced in Esri::ArcGISRuntime 100.7.

bool RouteTaskInfo::isEmpty() const

Returns true if this RouteTaskInfo is empty.

bool RouteTaskInfo::isFindBestSequence() const

Returns whether the analysis should reorder stops to find the optimized route.

The default is false.

bool RouteTaskInfo::isPreserveFirstStop() const

Returns whether isPreserveFirstStop is true.

bool RouteTaskInfo::isPreserveLastStop() const

Returns whether isPreserveLastStop is true.

bool RouteTaskInfo::isSupportsRerouting() const

Returns the value of service property "Supports Rerouting".

If the "Supports Rerouting" property doesn't exist on service, the value will be false. For local data, the value will be true.

This function was introduced in Esri::ArcGISRuntime 100.6.

double RouteTaskInfo::maxLocatingDistance() const

Returns the 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 RouteTaskInfo::networkName() const

Returns the network name.

SpatialReference RouteTaskInfo::outputSpatialReference() const

Returns the output spatial reference.

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

Returns the restriction attributes as a key-value pair.

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

RouteShapeType RouteTaskInfo::routeShapeType() const

Returns the output shape type for a route.

QDateTime RouteTaskInfo::startTime() const

Returns the start time of the route in UTC time.

QStringList RouteTaskInfo::supportedLanguages() const

Returns a list of supported languages for the route directions.

QStringList RouteTaskInfo::supportedRestrictionUsageParameterValues() const

Returns a list of supported restriction usage parameter values.

Restrictions can be identified for particular elements such that, during an analysis, traversing restricted elements is prohibited entirely, avoided, or even 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.

QList<TravelMode> RouteTaskInfo::travelModes() const

Returns a list of travel modes set in the RouteParameters.

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

Assignment operator from other RouteTaskInfo.

RouteTaskInfo &RouteTaskInfo::operator=(RouteTaskInfo &&other)

Move operator from other RouteTaskInfo.

Feedback on this topic?