QGeoRouteReply Class
The QGeoRouteReply class manages an operation started by an instance of QGeoRoutingManager. More...
| Header: | #include <QGeoRouteReply> |
| qmake: | QT += location |
| Inherits: | QObject |
Public Types
| enum | Error { NoError, EngineNotSetError, CommunicationError, ParseError, UnsupportedOptionError, UnknownError } |
Public Functions
| QGeoRouteReply(QGeoRouteReply::Error error, const QString &errorString, QObject *parent = nullptr) | |
| virtual | ~QGeoRouteReply() |
| virtual void | abort() |
| QGeoRouteReply::Error | error() const |
| QString | errorString() const |
| bool | isFinished() const |
| QGeoRouteRequest | request() const |
| QList<QGeoRoute> | routes() const |
Signals
| void | aborted() |
| void | errorOccurred(QGeoRouteReply::Error error, const QString &errorString = QString()) |
| void | finished() |
Protected Functions
| QGeoRouteReply(const QGeoRouteRequest &request, QObject *parent = nullptr) | |
| void | addRoutes(const QList<QGeoRoute> &routes) |
| void | setError(QGeoRouteReply::Error error, const QString &errorString) |
| void | setFinished(bool finished) |
| void | setRoutes(const QList<QGeoRoute> &routes) |
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 errorOccurred(QGeoRouteReply::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 errorOccurred(QGeoRouteReply::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().
Member Type Documentation
enum QGeoRouteReply::Error
Describes an error which prevented the completion of the operation.
| Constant | Value | Description |
|---|---|---|
QGeoRouteReply::NoError | 0 | No error has occurred. |
QGeoRouteReply::EngineNotSetError | 1 | The routing manager that was used did not have a QGeoRoutingManagerEngine instance associated with it. |
QGeoRouteReply::CommunicationError | 2 | An error occurred while communicating with the service provider. |
QGeoRouteReply::ParseError | 3 | The response from the service provider was in an unrecognizable format. |
QGeoRouteReply::UnsupportedOptionError | 4 | The requested operation or one of the options for the operation are not supported by the service provider. |
QGeoRouteReply::UnknownError | 5 | An error occurred which does not fit into any of the other categories. |
Member Function Documentation
[explicit] QGeoRouteReply::QGeoRouteReply(QGeoRouteReply::Error error, const QString &errorString, QObject *parent = nullptr)
Constructs a route reply with a given error and errorString and the specified parent.
[explicit protected] QGeoRouteReply::QGeoRouteReply(const QGeoRouteRequest &request, QObject *parent = nullptr)
Constructs a route reply object based on request, with the specified parent.
[virtual noexcept] QGeoRouteReply::~QGeoRouteReply()
Destroys this route reply object.
[virtual] void QGeoRouteReply::abort()
Cancels the operation immediately.
This will do nothing if the reply is finished.
[signal] void QGeoRouteReply::aborted()
This signal is emitted when the operation has been cancelled.
See also abort().
[protected] void QGeoRouteReply::addRoutes(const QList<QGeoRoute> &routes)
Appends the list of routes to the existing list.
QGeoRouteReply::Error QGeoRouteReply::error() const
Returns the error state of this reply.
If the result is QGeoRouteReply::NoError then no error has occurred.
See also setError().
[signal] void QGeoRouteReply::errorOccurred(QGeoRouteReply::Error error, const QString &errorString = QString())
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. If errorString is not empty it will contain a textual description of the error.
This signal and QGeoRoutingManager::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.
QString QGeoRouteReply::errorString() const
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 QGeoRouteReply::error() is equal to QGeoRouteReply::NoError.
[signal] void QGeoRouteReply::finished()
This signal is emitted when this reply has finished processing.
If error() equals QGeoRouteReply::NoError then the processing finished successfully.
This signal and QGeoRoutingManager::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 setFinished().
bool QGeoRouteReply::isFinished() const
Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.
QGeoRouteRequest QGeoRouteReply::request() const
Returns the route request which specified the route.
QList<QGeoRoute> QGeoRouteReply::routes() const
Returns the list of routes which were requested.
See also setRoutes().
[protected] void QGeoRouteReply::setError(QGeoRouteReply::Error error, const QString &errorString)
Sets the error state of this reply to error and the textual representation of the error to errorString.
This will also cause errorOccurred() and finished() signals to be emitted, in that order.
See also error().
[protected] void QGeoRouteReply::setFinished(bool finished)
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, QGeoRouteReply::setRoutes() should be called before this function. If an error occurred, QGeoRouteReply::setError() should be used instead.
See also finished().
[protected] void QGeoRouteReply::setRoutes(const QList<QGeoRoute> &routes)
Sets the list of routes in the reply to routes.
See also routes().