Facility Class

  • Facility
  • class Esri::ArcGISRuntime::Facility

    A facility used with a closest facility task. More...

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

    Public Functions

    Facility(const Esri::ArcGISRuntime::Point &point)
    Facility(const Esri::ArcGISRuntime::Facility &other)
    Facility(Esri::ArcGISRuntime::Facility &&other)
    double addedCost(const QString &attributeName) const
    Esri::ArcGISRuntime::Facility clone() const
    Esri::ArcGISRuntime::CurbApproach curbApproach() const
    double currentBearing() const
    double currentBearingTolerance() const
    double distanceToNetworkLocation() const
    int facilityId() const
    Esri::ArcGISRuntime::Point geometry() const
    double impedanceCutoff() const
    bool isEmpty() const
    Esri::ArcGISRuntime::LocationStatus locationStatus() const
    QString name() const
    double navigationLatency() const
    double navigationSpeed() const
    Esri::ArcGISRuntime::NetworkLocation networkLocation() const
    void setAddedCost(const QString &attributeName, double costValue)
    void setCurbApproach(Esri::ArcGISRuntime::CurbApproach curbApproach)
    void setCurrentBearing(double currentBearing)
    void setCurrentBearingTolerance(double currentBearingTolerance)
    void setFacilityId(int id)
    void setGeometry(const Esri::ArcGISRuntime::Point &point)
    void setImpedanceCutoff(double impedanceCutoff)
    void setName(const QString &name)
    void setNavigationLatency(double navigationLatency)
    void setNavigationSpeed(double navigationSpeed)
    void setNetworkLocation(const Esri::ArcGISRuntime::NetworkLocation &networkLocation)
    Esri::ArcGISRuntime::Facility &operator=(const Esri::ArcGISRuntime::Facility &other)
    Esri::ArcGISRuntime::Facility &operator=(Esri::ArcGISRuntime::Facility &&other)

    Detailed Description

    Facilities represent locations that can serve as the starting point or ending point of a closest facility analysis, such as a fire station or a hospital. ClosestFacilityParameters contains the list of facilities. The ClosestFacilityTask creates routes between facilities and incidents.

    Member Function Documentation


    Default constructor.

    [explicit] Facility::Facility(const Esri::ArcGISRuntime::Point &point)

    Constructor that takes in a point.

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

    Copy constructor from other Facility.

    Facility::Facility(Esri::ArcGISRuntime::Facility &&other)

    Move constructor from other Facility.



    double Facility::addedCost(const QString &attributeName) const

    Returns added cost.

    • attributeName - The name of attribute.

    Returns added cost value for given impedance or accumulate attribute.

    See also setAddedCost().

    [since Esri::ArcGISRuntime 200.1] Esri::ArcGISRuntime::Facility Facility::clone() const

    Clones the Facility to a new instance.

    Returns a new instance of the current Facility.

    This function was introduced in Esri::ArcGISRuntime 200.1.

    Esri::ArcGISRuntime::CurbApproach Facility::curbApproach() const

    Returns the curb approach for this Facility.

    See also setCurbApproach().

    [since Esri::ArcGISRuntime 100.7] double Facility::currentBearing() const

    Returns the current bearing of this Facility in degrees.

    Current bearing in degrees, measured clockwise from True-North. Typical values are 0 to 360 or NaN, negative values will be subtracted from 360 (e.g. -15 => 345), values greater than 360 will be have 360 subtracted from them (e.g. 385 => 25). For this property to be used the bearing tolerance also has to be set.

    This function was introduced in Esri::ArcGISRuntime 100.7.

    See also setCurrentBearing().

    [since Esri::ArcGISRuntime 100.7] double Facility::currentBearingTolerance() const

    Returns current bearing tolerance in degrees.

    Valid values are 0 to 180 or NaN.

    This function was introduced in Esri::ArcGISRuntime 100.7.

    See also setCurrentBearingTolerance().

    double Facility::distanceToNetworkLocation() const

    Returns distance to network location in meters.

    The distance to network location in meters can be populated by closest facility task.

    Returns NaN if the facility has not been located.

    [since Esri::ArcGISRuntime 100.6] int Facility::facilityId() const

    Returns facility ID.

    This is a caller supplied foreign key that can be used to associate output facilities with input facilities.

    {ClosestFacilityParameters::setFacilities(Esri::ArcGISRuntime::ArcGISFeatureTable*, const Esri::ArcGISRuntime::QueryParameters&)}, {Esri::ArcGISRuntime::ClosestFacilityResult::facilities} {ClosestFacilityResult::facilities}

    This function was introduced in Esri::ArcGISRuntime 100.6.

    See also setFacilityId() and Esri::ArcGISRuntime::ClosestFacilityParameters::setFacilities().

    Esri::ArcGISRuntime::Point Facility::geometry() const

    Returns the geometry of a facility.

    Gets facility's location using geographical point.

    See also setGeometry().

    double Facility::impedanceCutoff() const

    Returns the Impedance Cutoff of this Facility.

    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() is TravelTime, then impedanceCutoff is specified in minutes.

    See also setImpedanceCutoff().

    bool Facility::isEmpty() const

    Returns true if this Facility is empty.

    Esri::ArcGISRuntime::LocationStatus Facility::locationStatus() const

    Returns location status.

    Facility location's status can be populated by closest facility task. Default value LocationStatus::NotLocated will be returned on error.

    QString Facility::name() const

    Returns facility's name.

    Facility's name to be reported in driving directions.

    See also setName().

    Returns navigation latency in seconds.

    This function was introduced in Esri::ArcGISRuntime 100.7.

    See also setNavigationLatency().

    Returns the navigation speed in meters-per-second.

    This function was introduced in Esri::ArcGISRuntime 100.7.

    See also setNavigationSpeed().

    Esri::ArcGISRuntime::NetworkLocation Facility::networkLocation() const

    Returns network location.

    The facility's location on the network that can be populated by closest facility task. Set to nullptr for resetting a network location.

    See also setNetworkLocation().

    void Facility::setAddedCost(const QString &attributeName, double costValue)

    Sets the costValue for a given attributeName.

    See also addedCost().

    void Facility::setCurbApproach(Esri::ArcGISRuntime::CurbApproach curbApproach)

    Sets the curbApproach for this Facility.

    See also curbApproach().

    [since Esri::ArcGISRuntime 100.7] void Facility::setCurrentBearing(double currentBearing)

    Sets the currentBearing to currentBearing.

    This function was introduced in Esri::ArcGISRuntime 100.7.

    See also currentBearing.

    [since Esri::ArcGISRuntime 100.7] void Facility::setCurrentBearingTolerance(double currentBearingTolerance)

    Sets the currentBearingTolerance to currentBearingTolerance.

    This function was introduced in Esri::ArcGISRuntime 100.7.

    See also currentBearingTolerance.

    [since Esri::ArcGISRuntime 100.6] void Facility::setFacilityId(int id)

    Sets the facilityId to id.

    This function was introduced in Esri::ArcGISRuntime 100.6.

    See also facilityId.

    void Facility::setGeometry(const Esri::ArcGISRuntime::Point &point)

    Sets the point geometry of where this Facility is located.

    See also geometry().

    void Facility::setImpedanceCutoff(double impedanceCutoff)

    Sets the impedanceCutoff to impedanceCutoff.

    See also impedanceCutoff.

    void Facility::setName(const QString &name)

    Sets the name to name.

    See also name.

    [since Esri::ArcGISRuntime 100.7] void Facility::setNavigationLatency(double navigationLatency)

    Sets the navigationLatency to navigationLatency.

    This function was introduced in Esri::ArcGISRuntime 100.7.

    See also navigationLatency.

    [since Esri::ArcGISRuntime 100.7] void Facility::setNavigationSpeed(double navigationSpeed)

    Sets the navigationSpeed to navigationSpeed.

    This function was introduced in Esri::ArcGISRuntime 100.7.

    See also navigationSpeed.

    void Facility::setNetworkLocation(const Esri::ArcGISRuntime::NetworkLocation &networkLocation)

    Sets the networkLocation to networkLocation.

    Set to nullptr to reset a network location.

    See also networkLocation.

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

    Assignment operator from other Facility.

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

    Move operator from other Facility.

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