A general description of an event that is happening while navigating. More...
| Header | #include <Direction |
| Since | Esri |
Public Functions
| Direction | |
| Direction | |
| Direction | |
| ~ | |
| QDate | estimated |
| double | estimated |
| QList | event |
| QString | event |
(since Esri Esri | event |
| Esri | geometry() const |
| bool | is |
| Esri | operator=( |
| Esri | operator=(const Esri |
Detailed Description
The types of DirectionEvents are enumerated in DirectionMessageType. Examples of a DirectionEvent include "Departing from Stop 1", "Arriving at Stop 2", and "Going past Main Street".
Note: This class is not default constructible internally, but a default constructor is provided for convenience. If the default constructor is used, the object will be empty. Calling any method on an empty object is undefined behavior and any values returned should not be relied upon.
See also isEmpty.
Member Function Documentation
DirectionEvent::DirectionEvent ()
Default constructor.
Note: This is provided for convenience and produces an empty object.
See also isEmpty.
DirectionEvent::DirectionEvent (const Esri::ArcGISRuntime::DirectionEvent &other)
Copy constructor from other DirectionEvent.
[noexcept] DirectionEvent::DirectionEvent (Esri::ArcGISRuntime::DirectionEvent &&other)
Move constructor from other DirectionEvent.
[noexcept] DirectionEvent::~DirectionEvent ()
Destructor.
QDateTime DirectionEvent::estimatedArrivalTime () const
Returns the estimated arrival time for this DirectionEvent of the Route in UTC time.
double DirectionEvent::estimatedArrivalTimeShift () const
Returns the time zone shift in minutes of estimated arrival time for this segment of the route.
QList<Esri::ArcGISRuntime::DirectionMessage > DirectionEvent::eventMessages () const
Returns a list of detailed direction messages for this DirectionEvent.
QString DirectionEvent::eventText () const
Returns the textual representation of the DirectionEvent.
[since Esri::ArcGISRuntime 300.1] Esri::ArcGISRuntime::DirectionEventType DirectionEvent::eventType () const
Returns the category of this DirectionEvent.
This function was introduced in Esri::ArcGISRuntime 300.1.
Esri::ArcGISRuntime::Point DirectionEvent::geometry() const
Returns the geometry for this DirectionEvent of the Route.
bool DirectionEvent::isEmpty () const
Returns true if this DirectionEvent is empty.
[noexcept] Esri::ArcGISRuntime::DirectionEvent &DirectionEvent::operator=(Esri::ArcGISRuntime::DirectionEvent &&other)
Move operator from other DirectionEvent.
Esri::ArcGISRuntime::DirectionEvent &DirectionEvent::operator=(const Esri::ArcGISRuntime::DirectionEvent &other)
Assignment operator from other DirectionEvent.