QGeoRouteReply

The QGeoRouteReply class manages an operation started by an instance of QGeoRoutingManager . More

Inheritance diagram of PySide2.QtLocation.QGeoRouteReply

Synopsis

Functions

Virtual functions

Signals

Detailed Description

Instances of QGeoRouteReply manage the state and results of these operations.

The isFinished() , error() and errorString() methods provide information on whether the operation has completed and if it completed successfully.

The finished() and error( 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 the finished() or error( Error , QString ) signals, it is important to check the result of isFinished() before making the connections to the signals. The documentation for QGeoRoutingManager demonstrates how this might be carried out.

If the operation completes successfully the results will be able to be accessed with routes() .

class PySide2.QtLocation.QGeoRouteReply(error, errorString[, parent=None])

PySide2.QtLocation.QGeoRouteReply(request[, parent=None])

param parent

PySide2.QtCore.QObject

param request

PySide2.QtLocation.QGeoRouteRequest

param errorString

str

param error

Error

Constructs a route reply with a given error and errorString and the specified parent .

Constructs a route reply object based on request , with the specified parent .

PySide2.QtLocation.QGeoRouteReply.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.

PySide2.QtLocation.QGeoRouteReply.abort()

Cancels the operation immediately.

This will do nothing if the reply is finished.

PySide2.QtLocation.QGeoRouteReply.aborted()
PySide2.QtLocation.QGeoRouteReply.addRoutes(routes)
Parameters

routes

Appends the list of routes to the existing list.

PySide2.QtLocation.QGeoRouteReply.error()
Return type

Error

Returns the error state of this reply.

If the result is NoError then no error has occurred.

See also

setError()

PySide2.QtLocation.QGeoRouteReply.error(error[, errorString=""])
Parameters
  • errorError

  • errorString – str

PySide2.QtLocation.QGeoRouteReply.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 to NoError .

PySide2.QtLocation.QGeoRouteReply.finished()
PySide2.QtLocation.QGeoRouteReply.isFinished()
Return type

bool

Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.

PySide2.QtLocation.QGeoRouteReply.request()
Return type

PySide2.QtLocation.QGeoRouteRequest

Returns the route request which specified the route.

PySide2.QtLocation.QGeoRouteReply.routes()
Return type

Returns the list of routes which were requested.

See also

setRoutes()

PySide2.QtLocation.QGeoRouteReply.setError(error, errorString)
Parameters
  • errorError

  • errorString – str

Sets the error state of this reply to error and the textual representation of the error to errorString .

This will also cause error() and finished() signals to be emitted, in that order.

See also

error()

PySide2.QtLocation.QGeoRouteReply.setFinished(finished)
Parameters

finished – bool

Sets whether or not this reply has finished to finished .

If finished is true, this will cause the finished() 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

finished()

PySide2.QtLocation.QGeoRouteReply.setRoutes(routes)
Parameters

routes

Sets the list of routes in the reply to routes .

See also

routes()