QGeoRouteSegment Class
The QGeoRouteSegment class represents a segment of a route. More...
| Header: | #include <QGeoRouteSegment> |
| qmake: | QT += location |
Properties
- distance : const qreal
- maneuver : const QGeoManeuver
- path : const QList<QGeoCoordinate>
- travelTime : const int
Public Functions
| QGeoRouteSegment() | |
| QGeoRouteSegment(const QGeoRouteSegment &other) | |
| ~QGeoRouteSegment() | |
| qreal | distance() const |
| bool | isLegLastSegment() const |
| bool | isValid() const |
| QGeoManeuver | maneuver() const |
| QGeoRouteSegment | nextRouteSegment() const |
| QList<QGeoCoordinate> | path() const |
| void | setNextRouteSegment(const QGeoRouteSegment &routeSegment) |
| int | travelTime() const |
| QGeoRouteSegment & | operator=(const QGeoRouteSegment &other) |
Related Non-Members
| bool | operator!=(const QGeoRouteSegment &lhs, const QGeoRouteSegment &rhs) |
| bool | operator==(const QGeoRouteSegment &lhs, const QGeoRouteSegment &rhs) |
Detailed Description
A QGeoRouteSegment instance has information about the physical layout of the route segment, the length of the route and estimated time required to traverse the route segment and an optional QGeoManeuver associated with the beginning of the route segment.
QGeoRouteSegment instances can be thought of as edges on a routing graph, with QGeoManeuver instances as optional labels attached to the vertices of the graph.
Property Documentation
[read-only] distance : const qreal
This property holds the distance covered by this segment of the route, in meters.
Access functions:
| qreal | distance() const |
[read-only] maneuver : const QGeoManeuver
This property holds the maneuver for this route segment.
Holds an invalid QGeoManeuver if no information has been attached to the starting point of this route segment.
Access functions:
| QGeoManeuver | maneuver() const |
[read-only] path : const QList<QGeoCoordinate>
This property holds the geometric shape of this route segment of the route.
The coordinates should be listed in the order in which they would be traversed by someone traveling along this segment of the route.
Access functions:
| QList<QGeoCoordinate> | path() const |
[read-only] travelTime : const int
This property holds the estimated amount of time, in seconds, that it will take to traverse this segment.
Access functions:
| int | travelTime() const |
Member Function Documentation
QGeoRouteSegment::QGeoRouteSegment()
Constructs an invalid route segment object.
The route segment will remain invalid until one of setNextRouteSegment(), setTravelTime(), setDistance(), setPath() or setManeuver() is called.
[noexcept] QGeoRouteSegment::QGeoRouteSegment(const QGeoRouteSegment &other)
Constructs a route segment object from the contents of other.
[noexcept] QGeoRouteSegment::~QGeoRouteSegment()
Destroys this route segment object.
bool QGeoRouteSegment::isLegLastSegment() const
Returns whether this route segment is the last segment of a route leg.
bool QGeoRouteSegment::isValid() const
Returns whether this route segment is valid or not.
If nextRouteSegment() is called on the last route segment of a route, the returned value will be an invalid route segment.
QGeoRouteSegment QGeoRouteSegment::nextRouteSegment() const
Returns the next route segment in the route.
Will return an invalid route segment if this is the last route segment in the route.
See also setNextRouteSegment().
void QGeoRouteSegment::setNextRouteSegment(const QGeoRouteSegment &routeSegment)
Sets the next route segment in the route to routeSegment.
See also nextRouteSegment().
[noexcept] QGeoRouteSegment &QGeoRouteSegment::operator=(const QGeoRouteSegment &other)
Assigns other to this route segment object and then returns a reference to this route segment object.
Related Non-Members
[noexcept] bool operator!=(const QGeoRouteSegment &lhs, const QGeoRouteSegment &rhs)
Returns whether the route segments lhs and rhs are not equal.
The value of nextRouteSegment() is not considered in the comparison.
[noexcept] bool operator==(const QGeoRouteSegment &lhs, const QGeoRouteSegment &rhs)
Returns whether the route segments lhs and rhs are equal.
The value of nextRouteSegment() is not considered in the comparison.