QGeoRoute Class

The QGeoRoute class represents a route between two points. More...

Header: #include <QGeoRoute>
qmake: QT += location
Since: Qt 5.6
Inherited By:

QGeoRouteLeg

Public Functions

QGeoRoute()
QGeoRoute(const QGeoRoute &other)
~QGeoRoute()
QGeoRectangle bounds() const
qreal distance() const
QGeoRouteSegment firstRouteSegment() const
QList<QGeoCoordinate> path() const
QGeoRouteRequest request() const
QString routeId() const
QList<QGeoRouteLeg> routeLegs() const
void setBounds(const QGeoRectangle &bounds)
void setDistance(qreal distance)
void setFirstRouteSegment(const QGeoRouteSegment &routeSegment)
void setPath(const QList<QGeoCoordinate> &path)
void setRequest(const QGeoRouteRequest &request)
void setRouteId(const QString &id)
void setRouteLegs(const QList<QGeoRouteLeg> &legs)
void setTravelMode(QGeoRouteRequest::TravelMode mode)
void setTravelTime(int secs)
QGeoRouteRequest::TravelMode travelMode() const
int travelTime() const
bool operator!=(const QGeoRoute &other) const
QGeoRoute &operator=(const QGeoRoute &other)
bool operator==(const QGeoRoute &other) const

Protected Functions

QGeoRoute(const QExplicitlySharedDataPointer<QGeoRoutePrivate> &dd)
const QExplicitlySharedDataPointer<QGeoRoutePrivate> &const_d() const
QExplicitlySharedDataPointer<QGeoRoutePrivate> &d()

Detailed Description

The QGeoRoute class represents a route between two points.

A QGeoRoute object contains high level information about a route, such as the length the route, the estimated travel time for the route, and enough information to render a basic image of the route on a map.

The QGeoRoute object also contains a list of QGeoRouteSegment objecs which describe subsections of the route in greater detail.

Routing information is normally requested using QGeoRoutingManager::calculateRoute(), which returns a QGeoRouteReply instance. If the operation is completed successfully the routing information can be accessed with QGeoRouteReply::routes()

See also QGeoRoutingManager.

Member Function Documentation

QGeoRoute::QGeoRoute()

Constructs a route object.

QGeoRoute::QGeoRoute(const QGeoRoute &other)

Constructs a route object from the contents of other.

[protected] QGeoRoute::QGeoRoute(const QExplicitlySharedDataPointer<QGeoRoutePrivate> &dd)

Constructs a route object using dd as private implementation.

QGeoRoute::~QGeoRoute()

Destroys this route object.

QGeoRectangle QGeoRoute::bounds() const

Returns a bounding box which encompasses the entire route.

See also setBounds().

[protected] const QExplicitlySharedDataPointer<QGeoRoutePrivate> &QGeoRoute::const_d() const

[protected] QExplicitlySharedDataPointer<QGeoRoutePrivate> &QGeoRoute::d()

Returns the private implementation.

qreal QGeoRoute::distance() const

Returns the distance covered by this route, in meters.

See also setDistance().

QGeoRouteSegment QGeoRoute::firstRouteSegment() const

Returns the first route segment in the route.

Will return an invalid route segment if there are no route segments associated with the route.

The remaining route segments can be accessed sequentially with QGeoRouteSegment::nextRouteSegment.

See also setFirstRouteSegment().

QList<QGeoCoordinate> QGeoRoute::path() const

Returns the geometric shape 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.

See also setPath().

QGeoRouteRequest QGeoRoute::request() const

Returns the route request which describes the criteria used in the calculation of this route.

See also setRequest().

QString QGeoRoute::routeId() const

Returns the identifier of this route.

Service providers which support the updating of routes commonly assign identifiers to routes. If this route did not come from such a service provider the function will return an empty string.

See also setRouteId().

QList<QGeoRouteLeg> QGeoRoute::routeLegs() const

Returns the legs for the route.

This function was introduced in Qt 5.12.

See also setRouteLegs() and QGeoRouteLeg.

void QGeoRoute::setBounds(const QGeoRectangle &bounds)

Sets the bounding box which encompasses the entire route to bounds.

See also bounds().

void QGeoRoute::setDistance(qreal distance)

Sets the distance covered by this route, in meters, to distance.

See also distance().

void QGeoRoute::setFirstRouteSegment(const QGeoRouteSegment &routeSegment)

Sets the first route segment in the route to routeSegment.

See also firstRouteSegment().

void QGeoRoute::setPath(const QList<QGeoCoordinate> &path)

Sets the geometric shape of the route to path.

The coordinates in path should be listed in the order in which they would be traversed by someone traveling along this segment of the route.

See also path().

void QGeoRoute::setRequest(const QGeoRouteRequest &request)

Sets the route request which describes the criteria used in the calculcation of this route to request.

See also request().

void QGeoRoute::setRouteId(const QString &id)

Sets the identifier of this route to id.

Service providers which support the updating of routes commonly assign identifiers to routes. If this route came from such a service provider changing the identifier will probably cause route updates to stop working.

See also routeId().

void QGeoRoute::setRouteLegs(const QList<QGeoRouteLeg> &legs)

Sets the route legs for a multi-waypoint route.

This function was introduced in Qt 5.12.

See also routeLegs() and QGeoRouteLeg.

void QGeoRoute::setTravelMode(QGeoRouteRequest::TravelMode mode)

Sets the travel mode for this route to mode.

This should be one of the travel modes returned by request().travelModes().

See also travelMode().

void QGeoRoute::setTravelTime(int secs)

Sets the estimated amount of time it will take to traverse this route, in seconds, to secs.

See also travelTime().

QGeoRouteRequest::TravelMode QGeoRoute::travelMode() const

Returns the travel mode for the this route.

This should be one of the travel modes returned by request().travelModes().

See also setTravelMode().

int QGeoRoute::travelTime() const

Returns the estimated amount of time it will take to traverse this route, in seconds.

See also setTravelTime().

bool QGeoRoute::operator!=(const QGeoRoute &other) const

Returns whether this route and other are not equal.

QGeoRoute &QGeoRoute::operator=(const QGeoRoute &other)

Assigns the contents of other to this route and returns a reference to this route.

bool QGeoRoute::operator==(const QGeoRoute &other) const

Returns whether this route and other are equal.

© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.