RouteResult Class

  • RouteResult
  • class Esri::ArcGISRuntime::RouteResult

    A route result object contains output of route task's solve. More...

    Header: #include <RouteResult.h>
    Since: Esri::ArcGISRuntime 100.0

    Public Functions

    RouteResult()
    RouteResult(const Esri::ArcGISRuntime::RouteResult &other)
    RouteResult(Esri::ArcGISRuntime::RouteResult &&other)
    ~RouteResult()
    QString directionsLanguage() const
    bool isEmpty() const
    QStringList messages() const
    QList<Esri::ArcGISRuntime::PointBarrier> pointBarriers() const
    QList<Esri::ArcGISRuntime::PolygonBarrier> polygonBarriers() const
    QList<Esri::ArcGISRuntime::PolylineBarrier> polylineBarriers() const
    QList<Esri::ArcGISRuntime::Route> routes() const
    Esri::ArcGISRuntime::RouteResult &operator=(const Esri::ArcGISRuntime::RouteResult &other)
    Esri::ArcGISRuntime::RouteResult &operator=(Esri::ArcGISRuntime::RouteResult &&other)

    Detailed Description

    A class that contains the output results from a route task. The route result contains all necessary output from a successfully- completed route task solve. This includes collection of routes, barriers and messages.

    Relevant samples:

    Member Function Documentation

    RouteResult::RouteResult()

    Default constructor.

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

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

    Copy constructor from other RouteResult.

    RouteResult::RouteResult(Esri::ArcGISRuntime::RouteResult &&other)

    Move constructor from other RouteResult.

    RouteResult::~RouteResult()

    Destructor.

    [since Esri::ArcGISRuntime 100.2] QString RouteResult::directionsLanguage() const

    Returns the directions language.

    This function was introduced in Esri::ArcGISRuntime 100.2.

    bool RouteResult::isEmpty() const

    Returns true if this RouteResult is empty.

    QStringList RouteResult::messages() const

    Returns the messages.

    Messages received when solve is completed. If a route cannot be solved, the message returned by the server identifies the route that could not be solved.

    QList<Esri::ArcGISRuntime::PointBarrier> RouteResult::pointBarriers() const

    Returns a list of the point barriers used in the RouteTask.

    Only applicable if RouteParameters::isReturnPointBarriers used in this RouteTask is true.

    QList<Esri::ArcGISRuntime::PolygonBarrier> RouteResult::polygonBarriers() const

    Returns a list of the polygon barriers used in the RouteTask.

    Only applicable if RouteParameters::isReturnPolygonBarriers used in this RouteTask is true.

    QList<Esri::ArcGISRuntime::PolylineBarrier> RouteResult::polylineBarriers() const

    Returns a list of the polyline barriers used in the RouteTask.

    Only applicable if RouteParameters::isReturnPolylineBarriers used in this RouteTask is true.

    QList<Esri::ArcGISRuntime::Route> RouteResult::routes() const

    Returns a list of the resulting Routes.

    Only applicable if RouteParameters::isReturnRoutes used in this RouteTask is true.

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

    Assignment operator from other RouteResult.

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

    Move operator from other RouteResult.

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

    You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

    Your ArcGIS portal

    Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

    Your ArcGIS Location Platform dashboard

    Manage billing, monitor service usage, and access additional resources.

    Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

    Close