QGeoRoutingManagerEngine¶
The
QGeoRoutingManagerEngine
class provides an interface and convenience methods to implementers ofQGeoServiceProvider
plugins who want to provide access to geographic routing information. More…
Synopsis¶
Functions¶
def
locale
()def
managerName
()def
managerVersion
()def
measurementSystem
()def
setLocale
(locale)def
setMeasurementSystem
(system)def
setSupportedFeatureTypes
(featureTypes)def
setSupportedFeatureWeights
(featureWeights)def
setSupportedManeuverDetails
(maneuverDetails)def
setSupportedRouteOptimizations
(optimizations)def
setSupportedSegmentDetails
(segmentDetails)def
setSupportedTravelModes
(travelModes)def
supportedFeatureTypes
()def
supportedFeatureWeights
()def
supportedManeuverDetails
()def
supportedRouteOptimizations
()def
supportedSegmentDetails
()def
supportedTravelModes
()
Virtual functions¶
def
calculateRoute
(request)def
updateRoute
(route, position)
Signals¶
Detailed Description¶
Subclasses of
QGeoRoutingManagerEngine
need to provide an implementation ofcalculateRoute()
.In the default implementation, supportsRouteUpdates() returns false and
updateRoute()
returns aQGeoRouteReply
object containing aUnsupportedOptionError
.If the routing service supports updating routes as they are being traveled, the subclass should provide an implementation of
updateRoute()
and call setSupportsRouteUpdates(true) at some point in time beforeupdateRoute()
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 capabilities 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 behavior.A subclass of QGeoRouteManagerEngine will often make use of a subclass fo
QGeoRouteReply
internally, in order to add any engine-specific data (such as aQNetworkReply
object for network-based services) to theQGeoRouteReply
instances used by the engine.See also
- class PySide2.QtLocation.QGeoRoutingManagerEngine(parameters[, parent=None])¶
- param parent:
- param parameters:
Constructs a new engine with the specified
parent
, usingparameters
to pass any implementation specific data to the engine.
- PySide2.QtLocation.QGeoRoutingManagerEngine.calculateRoute(request)¶
- Parameters:
request –
PySide2.QtLocation.QGeoRouteRequest
- Return type:
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,
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 aUnsupportedOptionError
will occur.The user is responsible for deleting the returned reply object, although this can be done in the slot connected to
finished()
,error()
,finished()
orerror()
withdeleteLater()
.
- PySide2.QtLocation.QGeoRoutingManagerEngine.error(reply, error[, errorString=""])¶
- Parameters:
error –
Error
errorString – str
- PySide2.QtLocation.QGeoRoutingManagerEngine.finished(reply)¶
- Parameters:
- PySide2.QtLocation.QGeoRoutingManagerEngine.locale()¶
- Return type:
Returns the locale used to hint to this routing manager about what language to use for addresses and instructions.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.managerName()¶
- Return type:
str
Returns the name which this engine implementation uses to distinguish itself from the implementations provided by other plugins.
The combination of and
managerVersion()
should be unique amongst plugin implementations.
- PySide2.QtLocation.QGeoRoutingManagerEngine.managerVersion()¶
- Return type:
int
Returns the version of this engine implementation.
The combination of
managerName()
and should be unique amongst plugin implementations.
- PySide2.QtLocation.QGeoRoutingManagerEngine.measurementSystem()¶
- Return type:
Returns the measurement system used by this manager.
If
setMeasurementSystem()
has been called then the value returned by this function may be different to that returned bylocale()
.measurementSystem()
. In which case the value returned by this function is what will be used by the manager.See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.setLocale(locale)¶
- Parameters:
locale –
PySide2.QtCore.QLocale
Sets the locale to be used by 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.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.setMeasurementSystem(system)¶
- Parameters:
system –
MeasurementSystem
Sets the measurement system used by this manager to
system
.The measurement system can be set independently of the locale. Both
setLocale()
and this function set the measurement system. The value set by the last function called will be used.See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.setSupportedFeatureTypes(featureTypes)¶
- Parameters:
featureTypes –
FeatureTypes
Sets the types of features that this engine can take into account during route planning to
featureTypes
.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 feature types at all.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.setSupportedFeatureWeights(featureWeights)¶
- Parameters:
featureWeights –
FeatureWeights
Sets the weightings which this engine can apply to different features during route planning to
featureWeights
.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 feature weights at all.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.setSupportedManeuverDetails(maneuverDetails)¶
- Parameters:
maneuverDetails –
ManeuverDetails
Sets the levels of detail for navigation maneuvers which can be requested by this engine to
maneuverDetails
.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 maneuver details at all.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.setSupportedRouteOptimizations(optimizations)¶
- Parameters:
optimizations –
RouteOptimizations
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
- PySide2.QtLocation.QGeoRoutingManagerEngine.setSupportedSegmentDetails(segmentDetails)¶
- Parameters:
segmentDetails –
SegmentDetails
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
- PySide2.QtLocation.QGeoRoutingManagerEngine.setSupportedTravelModes(travelModes)¶
- Parameters:
travelModes –
TravelModes
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
- PySide2.QtLocation.QGeoRoutingManagerEngine.supportedFeatureTypes()¶
- Return type:
FeatureTypes
Returns the types of features that this engine can take into account during route planning.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.supportedFeatureWeights()¶
- Return type:
FeatureWeights
Returns the weightings which this engine can apply to different features during route planning.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.supportedManeuverDetails()¶
- Return type:
ManeuverDetails
Returns the levels of detail for navigation maneuvers which can be requested by this engine.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.supportedRouteOptimizations()¶
- Return type:
RouteOptimizations
Returns the route optimizations supported by this engine.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.supportedSegmentDetails()¶
- Return type:
SegmentDetails
Returns the levels of detail for routing segments which can be requested by this engine.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.supportedTravelModes()¶
- Return type:
TravelModes
Returns the travel modes supported by this engine.
See also
- PySide2.QtLocation.QGeoRoutingManagerEngine.updateRoute(route, position)¶
- Parameters:
route –
PySide2.QtLocation.QGeoRoute
position –
PySide2.QtPositioning.QGeoCoordinate
- Return type:
Begins the process of updating
route
based on the current positionposition
.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
UnsupportedOptionError
will occur.Once the operation has completed,
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
finished()
,error()
,finished()
orerror()
withdeleteLater()
.
© 2022 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.