- Qt 5.15
- Qt Location
- C++ Classes
- QGeoRoute
- Qt 5.15.15 Reference Documentation

# 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

This class was introduced in Qt 5.6.

- List of all members, including inherited members

## Public Functions

| QGeoRoute(const QGeoRoute &other)
| QGeoRoute()
QGeoRoute & | operator=(const QGeoRoute &other)
| ~QGeoRoute()
QGeoRectangle | bounds() const
qreal | distance() const
QVariantMap | extendedAttributes() 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 | setExtendedAttributes(const QVariantMap &extendedAttributes)
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
bool | operator==(const QGeoRoute &other) const

## Protected Functions

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

## Detailed Description

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

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

Constructs a route object using dd as private implementation.

### QGeoRoute::QGeoRoute(const QGeoRoute &other)

Constructs a route object from the contents of other.

### QGeoRoute::QGeoRoute()

Constructs a route object.

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

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

### QGeoRoute::~QGeoRoute()

Destroys this route object.

### QGeoRectangle QGeoRoute::bounds() const

Returns a bounding box which encompasses the entire route.

See also setBounds().

### `[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().

### QVariantMap QGeoRoute::extendedAttributes() const

Returns the extended attributes associated with this route.

This function was introduced in Qt 5.13.

See also setExtendedAttributes().

### 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::setExtendedAttributes(const QVariantMap &extendedAttributes)

Sets the extended attributes extendedAttributes associated with this route.

This function was introduced in Qt 5.13.

See also extendedAttributes().

### 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.

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

Returns whether this route and other are equal.