ClosestFacilityTaskInfo Class

  • ClosestFacilityTaskInfo
  • class Esri::ArcGISRuntime::ClosestFacilityTaskInfo

    A class that describes the transportation network that a closest facility task is bound to. More...

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

    Public Functions

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

    Detailed Description

    It describes information about 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


    Default constructor.

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

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

    Copy constructor from other ClosestFacilityTaskInfo.

    ClosestFacilityTaskInfo::ClosestFacilityTaskInfo(Esri::ArcGISRuntime::ClosestFacilityTaskInfo &&other)

    Move constructor from other ClosestFacilityTaskInfo.



    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, Esri::ArcGISRuntime::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.

    Esri::ArcGISRuntime::UnitSystem ClosestFacilityTaskInfo::directionsDistanceUnits() const

    Returns directions distance text units.

    Default value UnitSystem::Metric will be returned on error.

    QString ClosestFacilityTaskInfo::directionsLanguage() const

    Returns directions language.

    The language of the output directions e.g. "en-US".

    Esri::ArcGISRuntime::DirectionsStyle ClosestFacilityTaskInfo::directionsStyle() const

    Returns directions style.

    The directions setting to generate directions designed for different kind of applications. Default value DirectionsStyle::Desktop will be returned on error.

    [since Esri::ArcGISRuntime 100.7] Esri::ArcGISRuntime::NetworkDirectionsSupport ClosestFacilityTaskInfo::directionsSupport() const

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

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

    This function was introduced in Esri::ArcGISRuntime 100.7.

    bool ClosestFacilityTaskInfo::isEmpty() const

    Returns true if this ClosestFacilityTaskInfo is empty.

    [since Esri::ArcGISRuntime 100.6] double ClosestFacilityTaskInfo::maxLocatingDistance() const

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

    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.

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

    Returns the default output spatial reference.

    The spatial reference that will be used for output geometry during closest facility solving.

    QMap<QString, Esri::ArcGISRuntime::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.

    The names of set restriction attributes e.g. "Oneway".

    Esri::ArcGISRuntime::RouteShapeType ClosestFacilityTaskInfo::routeShapeType() const

    Returns route shape type.

    The enumeration value for the output shape type e.g.straight line shape, true shape, or no shape. Default value RouteShapeType::None will be returned on error.

    QDateTime ClosestFacilityTaskInfo::startTime() const

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

    An empty QDateTime if a start time was not set.

    Esri::ArcGISRuntime::StartTimeUsage ClosestFacilityTaskInfo::startTimeUsage() const

    Returns the default start time usage type.

    Default value StartTimeUsage::DepartureTime will be returned on error.

    QStringList ClosestFacilityTaskInfo::supportedLanguages() const

    Returns a list of supported languages.

    Supported languages of the output directions.

    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.

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

    Returns the default travel direction type.

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

    QList<Esri::ArcGISRuntime::TravelMode> ClosestFacilityTaskInfo::travelModes() const

    Returns a list of travel modes set in the ClosestFacilityParameters.

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

    Assignment operator from other ClosestFacilityTaskInfo.

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

    Move operator from other ClosestFacilityTaskInfo.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.