Класс QGeoRouteReply
Класс QGeoRouteReply управляет операцией, начатой экземпляром QGeoRoutingManager. Подробнее...
| Заголовок: | #include <QGeoRouteReply> |
| qmake: | QT += location |
| С момента: | Qt 5.6 |
| Наследует: | QObject |
Открытые типы
| перечисление | Error { NoError, EngineNotSetError, CommunicationError, ParseError, UnsupportedOptionError, UnknownError } |
Открытые функции
| QGeoRouteReply(Error error, const QString &errorString, QObject *parent = Q_NULLPTR) | |
| виртуальный | ~QGeoRouteReply() |
| виртуальный void | abort() |
| Error | error() const |
| QString | errorString() const |
| bool | isFinished() const |
| QGeoRouteRequest | request() const |
| QList<QGeoRoute> | routes() const |
- 31 открытых функций унаследованных от QObject
Сигналы
| void | error(QGeoRouteReply::Error error, const QString &errorString = QString()) |
| void | finished() |
- 2 сигнала унаследованных от QObject
Защищённые функции
| QGeoRouteReply(const QGeoRouteRequest &request, QObject *parent = Q_NULLPTR) | |
| void | addRoutes(const QList<QGeoRoute> &routes) |
| void | setError(Error error, const QString &errorString) |
| void | setFinished(bool finished) |
| void | setRoutes(const QList<QGeoRoute> &routes) |
- 9 защищённых функций унаследованных от QObject
Дополнительные унаследованные члены
- 1 свойство унаследованное от QObject
- 1 открытый слот унаследованный от QObject
- 11 статические открытые члены унаследованные от QObject
Подробное описание
Класс QGeoRouteReply управляет операцией, начатой экземпляром QGeoRoutingManager.
Экземпляры QGeoRouteReply управляют состоянием и результатами этих операций.
Методы isFinished(), error() и errorString() предоставляют информацию о завершении операции и успешном её завершении.
Сигналы finished() и error(QGeoRouteReply::Error,QString) могут быть использованы для отслеживания прогресса операции.
Возможен случай, когда недавно созданный QGeoRouteReply может находиться в состоянии завершения, чаще всего из-за возникшей ошибки. Поскольку такой экземпляр никогда не выпустит сигналы finished() или error(QGeoRouteReply::Error,QString), важно проверить результат isFinished() перед подключением к сигналам. Документация для QGeoRoutingManager демонстрирует, как это можно сделать.
Если операция завершается успешно, результаты можно получить с помощью routes().
Документация по типу члена
перечисление QGeoRouteReply::Error
Описывает ошибку, которая помешала завершению операции.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteReply::NoError |
0 |
Ошибка не произошла. |
QGeoRouteReply::EngineNotSetError |
1 |
У управляющего маршрутизации, который использовался, не было связанного с ним экземпляра QGeoRoutingManagerEngine. |
QGeoRouteReply::CommunicationError |
2 |
Произошла ошибка при общении с поставщиком услуг. |
QGeoRouteReply::ParseError |
3 |
Ответ от поставщика услуг был в нераспознаваемом формате. |
QGeoRouteReply::UnsupportedOptionError |
4 |
Запрошенная операция или один из вариантов операции не поддерживается поставщиком услуг. |
QGeoRouteReply::UnknownError |
5 |
Произошла ошибка, которая не попадает ни в одну из других категорий. |
Документация по документации функции члена
QGeoRouteReply::QGeoRouteReply(Error error, const QString &errorString, QObject *parent = Q_NULLPTR)
Создаёт ответ на маршрут с заданной ошибкой и errorString и указанным parent.
[protected] QGeoRouteReply::QGeoRouteReply(const QGeoRouteRequest &request, QObject *parent = Q_NULLPTR)
Создаёт объект ответа на маршрут на основе request, с указанным parent.
[virtual] QGeoRouteReply::~QGeoRouteReply()
Уничтожает этот объект ответа на маршрут.
[virtual] void QGeoRouteReply::abort()
Отменяет операцию немедленно.
Это ничего не сделает, если ответ завершён.
[protected] void QGeoRouteReply::addRoutes(const QList<QGeoRoute> &routes)
Добавляет список маршрутов в существующий список.
Error QGeoRouteReply::error() const
Возвращает состояние ошибки этого ответа.
Если результат равен QGeoRouteReply::NoError, то ошибка не произошла.
См. также setError().
[signal] void QGeoRouteReply::error(QGeoRouteReply::Error error, const QString &errorString = QString())
Этот сигнал испускается, когда в обработке этого ответа была обнаружена ошибка. Скорее всего, последует сигнал finished().
Ошибка будет описана кодом ошибки error. Если errorString не пуста, она будет содержать текстовое описание ошибки.
Этот сигнал и QGeoRoutingManager::error() будут испускаться одновременно.
Примечание: Не удаляйте этот объект ответа в подключенном к этому сигналу слоте. Используйте deleteLater() вместо этого.
Примечание: Сигнал error перегружен в этом классе. Для подключения к этому одному с помощью синтаксиса указателя функции необходимо указать тип сигнала в статическом преобразовании, как показано в этом примере:
connect(geoRouteReply, static_cast<void(QGeoRouteReply::*)(QGeoRouteReply::Error, const QString &)>(&QGeoRouteReply::error),
[=](QGeoRouteReply::Error error, const QString &errorString){ /* ... */ }); QString QGeoRouteReply::errorString() const
Возвращает текстовое представление состояния ошибки этого ответа.
Если ошибка не произошла, возвращается пустая строка. Возможна ситуация, когда произошла ошибка, но у неё нет связанного текстового представления; в этом случае также возвращается пустая строка.
Чтобы определить, произошла ли ошибка, проверьте, равно ли QGeoRouteReply::error() значению QGeoRouteReply::NoError.
[signal] void QGeoRouteReply::finished()
Этот сигнал испускается, когда обработка этого ответа завершается.
Если error() равно QGeoRouteReply::NoError, обработка завершилась успешно.
Этот сигнал и QGeoRoutingManager::finished() будут испущены одновременно.
Примечание: Не удаляйте объект этого ответа в подключённом слоте к этому сигналу. Используйте deleteLater() вместо этого.
См. также setFinished().
bool QGeoRouteReply::isFinished() const
Возвращает true, если операция завершилась успешно или столкнулась с ошибкой, из-за которой операция была прервана.
QGeoRouteRequest QGeoRouteReply::request() const
Возвращает запрос маршрута, который указал маршрут.
QList<QGeoRoute> QGeoRouteReply::routes() const
Возвращает список маршрутов, которые были запрошены.
См. также setRoutes().
[protected] void QGeoRouteReply::setError(Error error, const QString &errorString)
Устанавливает состояние ошибки этого ответа в error и текстовое представление ошибки в errorString.
Это также вызовет испускание сигналов error() и finished() в указанном порядке.
См. также error().
[protected] void QGeoRouteReply::setFinished(bool finished)
Устанавливает, завершён ли этот ответ, в значение finished.
Если finished равно true, это вызовет испускание сигнала finished().
Если операция завершилась успешно, следует вызвать QGeoRouteReply::setRoutes() перед этой функцией. Если произошла ошибка, следует использовать QGeoRouteReply::setError().
См. также finished().
[protected] void QGeoRouteReply::setRoutes(const QList<QGeoRoute> &routes)
Устанавливает список маршрутов в ответе на routes.
См. также routes().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/archives/qt-5.6/qgeoroutereply.html