QGeoRoutingManagerEngine Class Reference
The QGeoRoutingManagerEngine class provides an interface and convenience methods to implementers of QGeoServiceProvider plugins who want to provide access to geographic routing information. More...
#include <QGeoRoutingManagerEngine>
Public Functions
Signals
void | error ( QGeoRouteReply * reply, QGeoRouteReply::Error error, QString errorString = QString() ) |
void | finished ( QGeoRouteReply * reply ) |
Protected Functions
Detailed Description
The QGeoRoutingManagerEngine class provides an interface and convenience methods to implementers of QGeoServiceProvider plugins who want to provide access to geographic routing information.
Subclasses of QGeoRoutingManagerEngine need to provide an implementation of calculateRoute().
In the default implementation, supportsRouteUpdates() returns false and updateRoute() returns a QGeoRouteReply object containing a QGeoRouteReply::UnsupportedOptionError.
If the routing service supports updating routes as they are being travelled, the subclass should provide an implementation of updateRoute() and call setSupportsRouteUpdates(true) at some point in time before updateRoute() is called.
The function setSupportsRouteUpdates() is one of several functions which configure the reported capabilities of the engine. If the capabilities of an engine differ from the default values these functions should be used so that the reported capabilies are accurate.
It is important that this is done before calculateRoute(), updateRoute() or any of the capability reporting functions are used to prevent incorrect or inconsistent behaviour.
A subclass of QGeoRouteManagerEngine will often make use of a subclass fo QGeoRouteReply internally, in order to add any engine-specific data (such as a QNetworkReply object for network-based services) to the QGeoRouteReply instances used by the engine.
See also QGeoRoutingManager.
Member Function Documentation
QGeoRoutingManagerEngine::QGeoRoutingManagerEngine ( const QMap<QString, QString> & parameters, QObject * parent = 0 )
Constructs a new engine with the specified parent, using parameters to pass any implementation specific data to the engine.
QGeoRoutingManagerEngine::~QGeoRoutingManagerEngine () [virtual]
Destroys this engine.
QGeoRouteReply * QGeoRoutingManagerEngine::calculateRoute ( const QGeoRouteRequest & request ) [pure virtual]
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 engine 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 engine, as reported by the methods in this engine, 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 QGeoRoutingManagerEngine::finished(), QGeoRoutingManagerEngine::error(), QGeoRouteReply::finished() or QGeoRouteReply::error() with deleteLater().
void QGeoRoutingManagerEngine::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 QGeoRoutingManagerEngine::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.
void QGeoRoutingManagerEngine::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.
QString QGeoRoutingManagerEngine::managerName () const
Returns the name which this engine implementation uses to distinguish itself from the implementations provided by other plugins.
The combination of managerName() and managerVersion() should be unique amongst plugin implementations.
QMap<QString, QString> QGeoRoutingManagerEngine::managerParameters () const
Returns the parameters used in the creation of this engine object.
int QGeoRoutingManagerEngine::managerVersion () const
Returns the version of this engine implementation.
The combination of managerName() and managerVersion() should be unique amongst plugin implementations.
void QGeoRoutingManagerEngine::setSupportedAvoidFeatureTypes ( QGeoRouteRequest::AvoidFeatureTypes avoidFeatureTypes ) [protected]
Sets the types of features that this engine can avoid during route planning to avoidFeatureTypes.
It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support avoiding features.
See also supportedAvoidFeatureTypes().
void QGeoRoutingManagerEngine::setSupportedInstructionDetails ( QGeoRouteRequest::InstructionDetails instructionDetails ) [protected]
Sets the levels of detail for navigation instructions which can be requested by this engine to instructionDetails.
It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it supports no instruction detail at all.
See also supportedInstructionDetails().
void QGeoRoutingManagerEngine::setSupportedRouteOptimizations ( QGeoRouteRequest::RouteOptimizations optimizations ) [protected]
Sets the route optimizations supported by this engine to optimizations.
It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it supports no route optimizations at all.
See also supportedRouteOptimizations().
void QGeoRoutingManagerEngine::setSupportedSegmentDetails ( QGeoRouteRequest::SegmentDetails segmentDetails ) [protected]
Sets the levels of detail for routing segments which can be requested by this engine to segmentDetails.
It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it supports no segment detail at all.
See also supportedSegmentDetails().
void QGeoRoutingManagerEngine::setSupportedTravelModes ( QGeoRouteRequest::TravelModes travelModes ) [protected]
Sets the travel modes supported by this engine to travelModes.
It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it supports no travel modes at all.
See also supportedTravelModes().
void QGeoRoutingManagerEngine::setSupportsAlternativeRoutes ( bool supported ) [protected]
Sets whether this engine supports request for alternative routes to supported.
It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support alternative routes.
See also supportsAlternativeRoutes().
void QGeoRoutingManagerEngine::setSupportsExcludeAreas ( bool supported ) [protected]
Sets whether this engine supports request for excluding areas from routes to supported.
It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support excluding areas.
See also supportsExcludeAreas().
void QGeoRoutingManagerEngine::setSupportsRouteUpdates ( bool supported ) [protected]
Sets whether this engine supports updating routes to supported.
It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support updating routes.
See also supportsRouteUpdates().
Returns the types of features that this engine can avoid during route planning.
See also setSupportedAvoidFeatureTypes().
Returns the levels of detail for navigation instructions which can be requested by this engine.
See also setSupportedInstructionDetails().
Returns the route optimizations supported by this engine.
See also setSupportedRouteOptimizations().
Returns the levels of detail for routing segments which can be requested by this engine.
See also setSupportedSegmentDetails().
Returns the travel modes supported by this engine.
See also setSupportedTravelModes().
bool QGeoRoutingManagerEngine::supportsAlternativeRoutes () const
Returns whether this engine supports request for alternative routes.
See also setSupportsAlternativeRoutes().
bool QGeoRoutingManagerEngine::supportsExcludeAreas () const
Returns whether this engine supports the exclusion of areas from routes.
See also setSupportsExcludeAreas().
bool QGeoRoutingManagerEngine::supportsRouteUpdates () const
Returns whether this engine supports updating routes.
See also setSupportsRouteUpdates().
QGeoRouteReply * QGeoRoutingManagerEngine::updateRoute ( const QGeoRoute & route, const QGeoCoordinate & position ) [virtual]
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 engine 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 enough 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 QGeoRoutingManagerEngine::finished(), QGeoRoutingManagerEngine::error(), QGeoRouteReply::finished() or QGeoRouteReply::error() with deleteLater().