Skip To Content ArcGIS for Developers Sign In Dashboard

ClosestFacilityTaskInfo Class

(Esri::ArcGISRuntime::ClosestFacilityTaskInfo)

Information about a ClosestFacilityTask. More...

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

Public Functions

ClosestFacilityTaskInfo()
ClosestFacilityTaskInfo(const ClosestFacilityTaskInfo &other)
ClosestFacilityTaskInfo(ClosestFacilityTaskInfo &&other)
~ClosestFacilityTaskInfo()
QStringList accumulateAttributeNames() const
QMap<QString, CostAttribute> costAttributes() const
double defaultImpedanceCutoff() const
int defaultTargetFacilityCount() const
QString defaultTravelModeName() const
UnitSystem directionsDistanceUnits() const
QString directionsLanguage() const
DirectionsStyle directionsStyle() const
bool isEmpty() const
double maxLocatingDistance() const
QString networkName() const
SpatialReference outputSpatialReference() const
QMap<QString, RestrictionAttribute> restrictionAttributes() const
RouteShapeType routeShapeType() const
QDateTime startTime() const
StartTimeUsage startTimeUsage() const
QStringList supportedLanguages() const
QStringList supportedRestrictionUsageParameterValues() const
TravelDirection travelDirection() const
QList<TravelMode> travelModes() const
ClosestFacilityTaskInfo &operator=(const ClosestFacilityTaskInfo &other)
ClosestFacilityTaskInfo &operator=(ClosestFacilityTaskInfo &&other)

Detailed Description

Information about a ClosestFacilityTask.

ClosestFacilityTaskInfo contains the network dataset defaults from the ClosestFacilityTask once it is loaded. Use this class to obtain information about ClosestFacilityTask defaults before setting ClosestFacilityParameters.

Member Function Documentation

ClosestFacilityTaskInfo::ClosestFacilityTaskInfo()

Default constructor.

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

ClosestFacilityTaskInfo::ClosestFacilityTaskInfo(const ClosestFacilityTaskInfo &other)

Copy constructor from other ClosestFacilityTaskInfo.

ClosestFacilityTaskInfo::ClosestFacilityTaskInfo(ClosestFacilityTaskInfo &&other)

Move constructor from other ClosestFacilityTaskInfo.

ClosestFacilityTaskInfo::~ClosestFacilityTaskInfo()

Destructor.

QStringList ClosestFacilityTaskInfo::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 ClosestFacilityTaskInfo::costAttributes() method.

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

QMap<QString, CostAttribute> ClosestFacilityTaskInfo::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.

double ClosestFacilityTaskInfo::defaultImpedanceCutoff() const

Returns the default value for the impedance beyond which facilities should not be found.

For instance, while finding the closest hospitals from the site of an accident, a cutoff value of 15 minutes would mean that the closest facility task would search for the closest hospital within 15 minutes from the incident. If the closest hospital is 17 minutes away, no routes will be returned in the output routes. A cutoff value is especially useful when searching for multiple facilities or incidents. The units for impedance cutoff is based on the value of the TravelMode::impedanceAttributeName(). For example, if TravelMode::impedanceAttributeName() parameter is TravelTime, the defaultCutoff is specified in minutes.

int ClosestFacilityTaskInfo::defaultTargetFacilityCount() const

Returns the default number of facilities to find.

QString ClosestFacilityTaskInfo::defaultTravelModeName() const

Returns the default travel mode name.

If the closest facility task is initialized with a URL that has no travel modes, then the default travel mode name is an empty string.

See also TravelMode.

UnitSystem ClosestFacilityTaskInfo::directionsDistanceUnits() const

Returns the default directions distance units.

QString ClosestFacilityTaskInfo::directionsLanguage() const

Returns the default directions language.

DirectionsStyle ClosestFacilityTaskInfo::directionsStyle() const

Returns the default style of the resulting route directions.

bool ClosestFacilityTaskInfo::isEmpty() const

Returns true if this ClosestFacilityTaskInfo is empty.

double ClosestFacilityTaskInfo::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 ClosestFacilityTaskInfo::networkName() const

Returns the network name.

SpatialReference ClosestFacilityTaskInfo::outputSpatialReference() const

Returns the default output spatial reference

QMap<QString, RestrictionAttribute> ClosestFacilityTaskInfo::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.

RouteShapeType ClosestFacilityTaskInfo::routeShapeType() const

Returns the default enumeration value for the output shape type.

QDateTime ClosestFacilityTaskInfo::startTime() const

Returns the default start time of the closest facility route in UTC time.

StartTimeUsage ClosestFacilityTaskInfo::startTimeUsage() const

Returns the default start time usage type.

QStringList ClosestFacilityTaskInfo::supportedLanguages() const

Returns a list of supported languages.

QStringList ClosestFacilityTaskInfo::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 determine whether the restriction attribute prohibits, avoids, or prefers its associated network elements. Furthermore, the degree to which network elements are avoided or preferred can be defined by choosing High, Medium, or Low.

TravelDirection ClosestFacilityTaskInfo::travelDirection() const

Returns the default travel direction type.

QList<TravelMode> ClosestFacilityTaskInfo::travelModes() const

Returns a list of travel modes set in the ClosestFacilityParameters.

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

Assignment operator from other ClosestFacilityTaskInfo.

ClosestFacilityTaskInfo &ClosestFacilityTaskInfo::operator=(ClosestFacilityTaskInfo &&other)

Move operator from other ClosestFacilityTaskInfo.


Feedback on this topic?