PySide6.QtLocation.QGeoRouteReply¶
- class QGeoRouteReply¶
The
QGeoRouteReply
class manages an operation started by an instance ofQGeoRoutingManager
. More…Synopsis¶
Methods¶
def
__init__()
def
addRoutes()
def
error()
def
errorString()
def
isFinished()
def
request()
def
routes()
def
setError()
def
setFinished()
def
setRoutes()
Virtual methods¶
def
abort()
Signals¶
def
aborted()
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¶
Instances of
QGeoRouteReply
manage the state and results of these operations.The
isFinished()
,error()
anderrorString()
methods provide information on whether the operation has completed and if it completed successfully.The
finished()
anderrorOccurred
(Error
,QString) signals can be used to monitor the progress of the operation.It is possible that a newly created
QGeoRouteReply
may be in a finished state, most commonly because an error has occurred. Since such an instance will never emit thefinished()
orerrorOccurred
(Error
,QString) signals, it is important to check the result ofisFinished()
before making the connections to the signals. The documentation forQGeoRoutingManager
demonstrates how this might be carried out.If the operation completes successfully the results will be able to be accessed with
routes()
.- class Error¶
Describes an error which prevented the completion of the operation.
Constant
Description
QGeoRouteReply.NoError
No error has occurred.
QGeoRouteReply.EngineNotSetError
The routing manager that was used did not have a
QGeoRoutingManagerEngine
instance associated with it.QGeoRouteReply.CommunicationError
An error occurred while communicating with the service provider.
QGeoRouteReply.ParseError
The response from the service provider was in an unrecognizable format.
QGeoRouteReply.UnsupportedOptionError
The requested operation or one of the options for the operation are not supported by the service provider.
QGeoRouteReply.UnknownError
An error occurred which does not fit into any of the other categories.
- __init__(request[, parent=None])¶
- Parameters:
request –
QGeoRouteRequest
parent –
QObject
Constructs a route reply object based on
request
, with the specifiedparent
.- __init__(error, errorString[, parent=None])
Constructs a route reply with a given
error
anderrorString
and the specifiedparent
.- abort()¶
Cancels the operation immediately.
This will do nothing if the reply is finished.
- aborted()¶
This signal is emitted when the operation has been cancelled.
See also
- addRoutes(routes)¶
- Parameters:
routes – .list of QGeoRoute
Appends the list of
routes
to the existing list.Returns the error state of this reply.
If the result is
NoError
then no error has occurred.See also
This signal is emitted when an error has been detected in the processing of this reply. The
finished()
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 this reply object in the slot connected to this signal. Use deleteLater() instead.
- errorString()¶
- Return type:
str
Returns the textual representation of the error state of this reply.
If no error has occurred this will return an empty string. It is possible that an error occurred which has no associated textual representation, in which case this will also return an empty string.
To determine whether an error has occurred, check to see if
error()
is equal toNoError
.- finished()¶
This signal is emitted when this reply has finished processing.
If
error()
equalsNoError
then the processing finished successfully.This signal and
finished()
will be emitted at the same time.Note
Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.
See also
- isFinished()¶
- Return type:
bool
Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.
- request()¶
- Return type:
Returns the route request which specified the route.
Returns the list of routes which were requested.
See also
Sets the error state of this reply to
error
and the textual representation of the error toerrorString
.This will also cause
errorOccurred()
andfinished()
signals to be emitted, in that order.See also
- setFinished(finished)¶
- Parameters:
finished – bool
Sets whether or not this reply has finished to
finished
.If
finished
is true, this will cause thefinished()
signal to be emitted.If the operation completed successfully,
setRoutes()
should be called before this function. If an error occurred,setError()
should be used instead.See also
- setRoutes(routes)¶
- Parameters:
routes – .list of QGeoRoute
Sets the list of routes in the reply to
routes
.See also