QGeoRoutingManager Class Reference

 #include <QGeoRoutingManager>

 class MyRouteHandler : public QObject
 {
     Q_OBJECT
 public:
     MyRouteHandler(QGeoRoutingManager *routingManager,
                    const QGeoCoordinate &origin,
                    const QGeoCoordinate &destination) {

         QGeoRouteRequest request(origin, destination);

         // The request defaults to the fastest route by car, which is
         // equivalent to:
         // request.setTravelMode(QGeoRouteRequest::CarTravel);
         // request.setRouteOptimization(QGeoRouteRequest::FastestRoute);

         request.setAvoidFeatureTypes(QGeoRouteRequest::AvoidTolls);
         request.setAvoidFeatureTypes(QGeoRouteRequest::AvoidMotorPoolLanes);

         QGeoRouteRequest::AvoidFeaturesTypes avoidableFeatures = routingManager->supportedAvoidFeatureTypes();

         if (!(avoidableFeatures & request.avoidFeatureTypes())) {
             // ... inform the user that the routing manager does not
             // provide support for avoiding tolls and/or motor pool lanes ...
             return;
         }

         QGeoRouteReply *reply = routingManager->calculateRoute(request);

         if (reply->isFinished()) {
             if (reply->error() == QGeoRouteReply::NoError) {
                 routeCalculated(reply);
             } else {
                 routeError(reply, reply->error(), reply->errorString());
             }
             return;
         }

         connect(routingManager,
                 SIGNAL(finished(QGeoRouteReply*)),
                 this,
                 SLOT(routeCalculated(QGeoRouteReply*)));

         connect(routingManager,
                 SIGNAL(error(QGeoRouteReply*,QGeoRouteReply::Error,QString)),
                 this,
                 SLOT(routeError(QGeoRouteReply*,QGeoRouteReply::Error,QString)));
     }

 private slots:
     void routeCalculated(QGeoRouteReply *reply)
     {
         // A route request can ask for several alternative routes ...
         if (reply->routes().size() != 0) {

             // ... but by default it will only get a single route
             QGeoRoute route = reply->routes().at(0);

             //... now we have to make use of the route ...
         }

         reply->deleteLater();
     }

     void routeError(QGeoRouteReply *reply, QGeoRouteReply:Error error, const QString &errorString)
     {
         // ... inform the user that an error has occurred ...
         reply->deleteLater();
     }
 };

Member Function Documentation

QGeoRoutingManager::~QGeoRoutingManager ()

Destroys this manager.

QGeoRouteReply * QGeoRoutingManager::calculateRoute ( const QGeoRouteRequest & request )

Begins the calculation of the route specified by request.

A QGeoRouteReply object will be returned, which can be used to manage the routing operation and to return the results of the operation.

This manager and the returned QGeoRouteReply object will emit signals indicating if the operation completes or if errors occur.

Once the operation has completed, QGeoRouteReply::routes can be used to retrieve the calculated route or routes.

If request includes features which are not supported by this manager, as reported by the methods in this manager, then a QGeoRouteReply::UnsupportedOptionError will occur.

The user is responsible for deleting the returned reply object, although this can be done in the slot connected to QGeoRoutingManager::finished(), QGeoRoutingManager::error(), QGeoRouteReply::finished() or QGeoRouteReply::error() with deleteLater().

This function was introduced in Qt Mobility 1.1.

void QGeoRoutingManager::error ( QGeoRouteReply * reply, QGeoRouteReply::Error error, QString errorString = QString() ) [signal]

This signal is emitted when an error has been detected in the processing of reply. The QGeoRoutingManager::finished() signal will probably follow.

The error will be described by the error code error. If errorString is not empty it will contain a textual description of the error.

This signal and QGeoRouteReply::error() will be emitted at the same time.

Note: Do no delete the reply object in the slot connected to this signal. Use deleteLater() instead.

This function was introduced in Qt Mobility 1.1.

void QGeoRoutingManager::finished ( QGeoRouteReply * reply ) [signal]

This signal is emitted when reply has finished processing.

If reply::error() equals QGeoRouteReply::NoError then the processing finished successfully.

This signal and QGeoRouteReply::finished() will be emitted at the same time.

Note: Do no delete the reply object in the slot connected to this signal. Use deleteLater() instead.

This function was introduced in Qt Mobility 1.1.

QLocale QGeoRoutingManager::locale () const

Returns the locale used to hint to this routing manager about what language to use for addresses and instructions.

This function was introduced in Qt Mobility 1.1.

See also setLocale().

QString QGeoRoutingManager::managerName () const

Returns the name of the engine which implements the behaviour of this routing manager.

The combination of managerName() and managerVersion() should be unique amongst the plugin implementations.

This function was introduced in Qt Mobility 1.1.

int QGeoRoutingManager::managerVersion () const

Returns the version of the engine which implements the behaviour of this routin manager.

The combination of managerName() and managerVersion() should be unique amongst the plugin implementations.

This function was introduced in Qt Mobility 1.1.

void QGeoRoutingManager::setLocale ( const QLocale & locale )

Sets the locale to be used by the this manager to locale.

If this routing manager supports returning addresses and instructions in different languages, they will be returned in the language of locale.

The locale used defaults to the system locale if this is not set.

This function was introduced in Qt Mobility 1.1.

See also locale().

QGeoRouteRequest::FeatureTypes QGeoRoutingManager::supportedFeatureTypes () const

Returns the types of features that this manager can take into account during route planning.

This function was introduced in Qt Mobility 1.1.

QGeoRouteRequest::FeatureWeights QGeoRoutingManager::supportedFeatureWeights () const

Returns the weightings which this manager can apply to different features during route planning.

This function was introduced in Qt Mobility 1.1.

QGeoRouteRequest::ManeuverDetails QGeoRoutingManager::supportedManeuverDetails () const

Returns the levels of detail for navigation maneuvers which can be requested by this manager.

This function was introduced in Qt Mobility 1.1.

QGeoRouteRequest::RouteOptimizations QGeoRoutingManager::supportedRouteOptimizations () const

Returns the route optimizations supported by this manager.

This function was introduced in Qt Mobility 1.1.

QGeoRouteRequest::SegmentDetails QGeoRoutingManager::supportedSegmentDetails () const

Returns the levels of detail for routing segments which can be requested with this manager.

This function was introduced in Qt Mobility 1.1.

QGeoRouteRequest::TravelModes QGeoRoutingManager::supportedTravelModes () const

Returns the travel modes supported by this manager.

This function was introduced in Qt Mobility 1.1.

bool QGeoRoutingManager::supportsAlternativeRoutes () const

Returns whether this manager supports request for alternative routes.

This function was introduced in Qt Mobility 1.1.

bool QGeoRoutingManager::supportsExcludeAreas () const

Returns whether this engine supports the exclusion of areas from routes.

This function was introduced in Qt Mobility 1.1.

bool QGeoRoutingManager::supportsRouteUpdates () const

Returns whether this manager supports updating routes.

This function was introduced in Qt Mobility 1.1.

QGeoRouteReply * QGeoRoutingManager::updateRoute ( const QGeoRoute & route, const QGeoCoordinate & position )

Begins the process of updating route based on the current position position.

A QGeoRouteReply object will be returned, which can be used to manage the routing operation and to return the results of the operation.

This manager and the returned QGeoRouteReply object will emit signals indicating if the operation completes or if errors occur.

If supportsRouteUpdates() returns false an QGeoRouteReply::UnsupportedOptionError will occur.

Once the operation has completed, QGeoRouteReply::routes can be used to retrieve the updated route.

The returned route could be entirely different to the original route, especially if position is far away from the initial route. Otherwise the route will be similar, although the remaining time and distance will be updated and any segments of the original route which have been traversed will be removed.

The user is responsible for deleting the returned reply object, although this can be done in the slot connected to QGeoRoutingManager::finished(), QGeoRoutingManager::error(), QGeoRouteReply::finished() or QGeoRouteReply::error() with deleteLater().

This function was introduced in Qt Mobility 1.1.