ClosestFacilityRoute Class

  • ClosestFacilityRoute
  • class Esri::ArcGISRuntime::ClosestFacilityRoute

    A ClosestFacilityRoute contains information about the route to maneuver between an incident and a facility. More...

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

    Public Functions

    ClosestFacilityRoute(Esri::ArcGISRuntime::ClosestFacilityRoute &&other)
    ClosestFacilityRoute(const Esri::ArcGISRuntime::ClosestFacilityRoute &other)
    Esri::ArcGISRuntime::ClosestFacilityRoute &operator=(Esri::ArcGISRuntime::ClosestFacilityRoute &&other)
    Esri::ArcGISRuntime::ClosestFacilityRoute &operator=(const Esri::ArcGISRuntime::ClosestFacilityRoute &other)
    Esri::ArcGISRuntime::CurbApproach arrivalCurbApproach() const
    double cost(const QString &attributeName) const
    Esri::ArcGISRuntime::CurbApproach departureCurbApproach() const
    Esri::ArcGISRuntime::DirectionManeuverListModel *directionManeuvers(QObject *parent = nullptr) const
    QDateTime endTime() const
    double endTimeShift() const
    bool isEmpty() const
    Esri::ArcGISRuntime::Polyline routeGeometry() const
    QDateTime startTime() const
    double startTimeShift() const
    double totalLength() const
    double totalTime() const
    double travelTime() const

    Detailed Description

    The ClosestFacilityRoute contains information such as the route geometry, distance, travel time, and direction maneuvers. After ClosestFacilityTask is executed and completes successfully, retrieve the ClosestFacilityRoute from the ClosestFacilityResult.

    Member Function Documentation

    ClosestFacilityRoute::ClosestFacilityRoute(Esri::ArcGISRuntime::ClosestFacilityRoute &&other)

    Move constructor from other ClosestFacilityRoute.

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

    Copy constructor from other ClosestFacilityRoute.


    Default constructor.

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

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

    Move operator from other ClosestFacilityRoute.

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

    Assignment operator from other ClosestFacilityRoute.



    Esri::ArcGISRuntime::CurbApproach ClosestFacilityRoute::arrivalCurbApproach() const

    Returns the departure curb approach populated by the solver.

    The curb approach is dependent on incidents' and facilities' curb approaches.

    double ClosestFacilityRoute::cost(const QString &attributeName) const

    Returns the cost of a given attributeName.

    Example attribute names include "Minutes" or "TravelTime".

    Esri::ArcGISRuntime::CurbApproach ClosestFacilityRoute::departureCurbApproach() const

    Returns the departure curb approach populated by the solver.

    The curb approach is dependent on incidents' and facilities' curb approaches.

    Esri::ArcGISRuntime::DirectionManeuverListModel *ClosestFacilityRoute::directionManeuvers(QObject *parent = nullptr) const

    Returns a DirectionManeuverListModel of the direction maneuvers.

    Specify an optional parent to ensure that the list model persists if you want it to have lifetime beyond this ClosestFacilityRoute object.

    QDateTime ClosestFacilityRoute::endTime() const

    Returns the end time of a ClosestFacilityRoute in UTC time.

    double ClosestFacilityRoute::endTimeShift() const

    Returns the value of time zone shift for end time in minutes.

    bool ClosestFacilityRoute::isEmpty() const

    Returns true if this ClosestFacilityRoute is empty.

    Esri::ArcGISRuntime::Polyline ClosestFacilityRoute::routeGeometry() const

    Returns the geometry of the route to the closest facility.

    QDateTime ClosestFacilityRoute::startTime() const

    Returns the start time of a ClosestFacilityRoute in UTC time.

    double ClosestFacilityRoute::startTimeShift() const

    Returns the value of time zone shift for start time in minutes.

    double ClosestFacilityRoute::totalLength() const

    Returns the total length (distance) of the ClosestFacilityRoute.

    The returned value's units is in meters.

    double ClosestFacilityRoute::totalTime() const

    Returns the total time of a ClosestFacilityRoute in minutes.

    This includes the travel time, as well as any additional time from specified incident or facility costs.

    double ClosestFacilityRoute::travelTime() const

    Returns the travel time of a ClosestFacilityRoute in minutes.

    This only includes time of travel.

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