A class that contains the output from a solving closest task for a single result. More...
| Header: | #include <ClosestFacilityRoute.h> |
| Since: | Esri::ArcGISRuntime 100.1 |
Public Functions
| ClosestFacilityRoute() | |
| ClosestFacilityRoute(const Esri::ArcGISRuntime::ClosestFacilityRoute &other) | |
| ClosestFacilityRoute(Esri::ArcGISRuntime::ClosestFacilityRoute &&other) | |
| ~ClosestFacilityRoute() | |
| 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 |
| Esri::ArcGISRuntime::ClosestFacilityRoute & | operator=(const Esri::ArcGISRuntime::ClosestFacilityRoute &other) |
| Esri::ArcGISRuntime::ClosestFacilityRoute & | operator=(Esri::ArcGISRuntime::ClosestFacilityRoute &&other) |
Detailed Description
The solving closest route contains all necessary output from a successfully- completed ClosestFacilityTask::solveClosestFacilityAsync(const Esri::ArcGISRuntime::ClosestFacilityParameters&). This includes the cost, geometry, and additional metadata specific to the resulting route solution (e.g., route directions, local start/end time, etc.).
{ClosestFacilityTask::solveClosestFacilityAsync(const Esri::ArcGISRuntime::ClosestFacilityParameters&)}ync}
Relevant samples:
- Find closest facility to an incident (interactive): Find a route to the closest facility from a location.
- Find closest facility to multiple incidents (service): Find routes from several locations to the respective closest facility.
See also ClosestFacilityTask and Esri::ArcGISRuntime::ClosestFacilityTask::solveClosestFacilityAsync(const Esri::ArcGISRuntime::ClosestFacilityParameters&).
Member Function Documentation
ClosestFacilityRoute::ClosestFacilityRoute ()
Default constructor.
Warning: This is for convenience only and will construct an empty object.
ClosestFacilityRoute::ClosestFacilityRoute (const Esri::ArcGISRuntime::ClosestFacilityRoute &other)
Copy constructor from other ClosestFacilityRoute.
ClosestFacilityRoute::ClosestFacilityRoute (Esri::ArcGISRuntime::ClosestFacilityRoute &&other)
Move constructor from other ClosestFacilityRoute.
ClosestFacilityRoute::~ClosestFacilityRoute ()
Destructor.
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.
Default value CurbApproach::EitherSide will be returned on error.
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.
The list of turn-by-turn directions for this route. Can be empty array in case if ClosestFacilityParameters::isReturnDirections is false.
See also ClosestFacilityParameters::isReturnDirections.
QDateTime ClosestFacilityRoute::endTime () const
Returns the end time of a ClosestFacilityRoute in UTC time.
A empty QDateTime if departure/arrival time was not specified in ClosestFacilityParameters.
See also ClosestFacilityParameters.
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.
The geometry for the full route (polyline) in case if ClosestFacilityParameters::isReturnRoutes is true.
QDateTime ClosestFacilityRoute::startTime () const
Returns the start time of a ClosestFacilityRoute in UTC time.
An empty QDateTime if departure/arrival time was not specified in ClosestFacilityParameters.
See also ClosestFacilityParameters.
double ClosestFacilityRoute::startTimeShift () const
Returns the value of time zone shift for start time in minutes.
Value of the time zone shift for start time, in minutes.
See also QDateTime and startTime.
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.
In order to get this value, time attribute should be set in as impedance or accumulate attribute in parameters object.
double ClosestFacilityRoute::travelTime () const
Returns the travel time of a ClosestFacilityRoute in minutes.
This only includes time of travel.
Travel time is total amount of travel time exclude added minutes from incident/facility added costs (if specified).
Esri::ArcGISRuntime::ClosestFacilityRoute &ClosestFacilityRoute::operator=(const Esri::ArcGISRuntime::ClosestFacilityRoute &other)
Assignment operator from other ClosestFacilityRoute.
Esri::ArcGISRuntime::ClosestFacilityRoute &ClosestFacilityRoute::operator=(Esri::ArcGISRuntime::ClosestFacilityRoute &&other)
Move operator from other ClosestFacilityRoute.