PySide6.QtLocation.QGeoRoutingManager¶
- class QGeoRoutingManager¶
The
QGeoRoutingManager
class provides support for geographic routing operations. More…Synopsis¶
Methods¶
def
calculateRoute()
def
locale()
def
managerName()
def
managerVersion()
def
setLocale()
def
updateRoute()
Signals¶
def
errorOccurred()
def
finished()
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description¶
Warning
This section contains snippets that were automatically translated from C++ to Python and may contain errors.
The
calculateRoute()
andupdateRoute()
methods functionQGeoRouteReply
objects, which manage these operations and report on the result of the operations and any errors which may have occurred.The
calculateRoute()
function is used to find a route (or routes) that follows a set of waypoints and matches various other criteria. TheQGeoRouteRequest
class is used to specify this information.If supportsRouteUpdates() returns true then the
QGeoRoutingManager
supports updating route information based on position updates. This will cause the travel time and distance estimates to be updated, and any QGeoRouteSegments already traversed to be removed from the route.The updates can be triggered with the
updateRoute()
function, which makes use of the QGeoPositionInfo instances emitted as position updates by QGeoPositionInfoSource.Instances of
QGeoRoutingManager
can be accessed withroutingManager()
.A small example of the usage of
QGeoRoutingManager
and QGeoRouteRequests follows:class RouteHandler(QObject): Q_OBJECT # public RouteHandler(QGeoRoutingManager routingManager, QGeoCoordinate origin, QGeoCoordinate destination) { request = QGeoRouteRequest(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 not (avoidableFeatures request.avoidFeatureTypes()): # ... inform the user that the routing manager does not # provide support for avoiding tolls and/or motor pool lanes ... return reply = routingManager.calculateRoute(request) if reply.isFinished(): if reply.error() == QGeoRouteReply.NoError: routeCalculated(reply) else: routeError(reply, reply.error(), reply.errorString()) return routingManager.finished.connect( self.routeCalculated) routingManager.errorOccurred.connect( self.routeError) # private slots def routeCalculated(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 route = reply.routes().at(0) #... now we have to make use of the route ... reply.deleteLater() def routeError(reply, error, errorString): # ... inform the user that an error has occurred ... reply.deleteLater()
- calculateRoute(request)¶
- Parameters:
request –
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 manager 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 manager, as reported by the methods in this manager, 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()
,errorOccurred()
,finished()
orerrorOccurred()
with deleteLater().- errorOccurred(reply, error[, errorString=""])¶
- Parameters:
reply –
QGeoRouteReply
error –
Error
errorString – str
This signal is emitted when an error has been detected in the processing of
reply
. Thefinished()
signal will probably follow.The error will be described by the error code
error
. IferrorString
is not empty it will contain a textual description of the error.This signal and
errorOccurred()
will be emitted at the same time.Note
Do not delete the
reply
object in the slot connected to this signal. Use deleteLater() instead.- finished(reply)¶
- Parameters:
reply –
QGeoRouteReply
This signal is emitted when
reply
has finished processing.If reply::error() equals
NoError
then the processing finished successfully.This signal and
finished()
will be emitted at the same time.Note
Do not delete the
reply
object in the slot connected to this signal. Use deleteLater() instead.Returns the locale used to hint to this routing manager about what language to use for addresses and instructions.
See also
- managerName()¶
- Return type:
str
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.- managerVersion()¶
- Return type:
int
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.- 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
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
- 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
- supportedFeatureTypes()¶
- Return type:
Combination of
FeatureType
Returns the types of features that this manager can take into account during route planning.
- supportedFeatureWeights()¶
- Return type:
Combination of
FeatureWeight
Returns the weightings which this manager can apply to different features during route planning.
- supportedManeuverDetails()¶
- Return type:
Combination of
ManeuverDetail
Returns the levels of detail for navigation maneuvers which can be requested by this manager.
- supportedRouteOptimizations()¶
- Return type:
Combination of
RouteOptimization
Returns the route optimizations supported by this manager.
- supportedSegmentDetails()¶
- Return type:
Combination of
SegmentDetail
Returns the levels of detail for routing segments which can be requested with this manager.
- supportedTravelModes()¶
- Return type:
Combination of
TravelMode
Returns the travel modes supported by this manager.
- updateRoute(route, position)¶
- Parameters:
route –
QGeoRoute
position –
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 manager 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 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()
,errorOccurred()
,finished()
orerrorOccurred()
with deleteLater().