Класс QGeoRoutingManagerEngine

Класс QGeoRoutingManagerEngine предоставляет интерфейс и удобные методы для разработчиков плагинов QGeoServiceProvider, которые хотят предоставить доступ к географической информации о маршрутах.

Подробнее...

• Список всех членов, включая унаследованные

Открытые функции

• 34 открытых функции унаследованные от QObject

Сигналы

• 2 сигнала унаследованные от QObject

Защищенные функции

• 9 защищенных функций унаследованные от QObject

Дополнительные унаследованные члены

• 1 свойство унаследованное от QObject
• 1 открытый слот унаследованный от QObject
• 1 открытая переменная унаследованная от QObject
• 10 статических открытых членов унаследованные от QObject
• 2 защищенных переменных унаследованные от QObject

Подробное описание

Класс QGeoRoutingManagerEngine предоставляет интерфейс и удобные методы для разработчиков плагинов QGeoServiceProvider, которые хотят предоставить доступ к географической информации о маршрутах.

Подклассы QGeoRoutingManagerEngine должны реализовать метод calculateRoute().

В реализации по умолчанию, supportsRouteUpdates() возвращает false, а updateRoute() возвращает объект QGeoRouteReply, содержащий ошибку QGeoRouteReply::UnsupportedOptionError.

Если служба маршрутизации поддерживает обновление маршрутов по мере их прохождения, подкласс должен реализовать updateRoute() и вызвать setSupportsRouteUpdates(true) в какой-то момент до вызова updateRoute().

Функция setSupportsRouteUpdates() — одна из нескольких функций, которые конфигурируют сообщённые возможности движка. Если возможности движка отличаются от значений по умолчанию, эти функции должны быть использованы, чтобы сообщённые возможности были точными.

Важно, чтобы это было сделано до вызова calculateRoute(), updateRoute() или любых функций отчёта о возможностях, чтобы предотвратить некорректное или несогласованное поведение.

Подкласс QGeoRouteManagerEngine часто использует подкласс QGeoRouteReply внутри, чтобы добавить любые данные, специфичные для движка (например, объект QNetworkReply для сетевых служб), в экземпляры QGeoRouteReply, используемые движком.

См. также QGeoRoutingManager.

Документация по членам-функциям

QGeoRoutingManagerEngine::QGeoRoutingManagerEngine(const QVariantMap &parameters, QObject *parent = nullptr)

Создаёт новый движок с указанным parent, используя parameters для передачи любых данных, специфичных для реализации, в движок.

[virtual] QGeoRoutingManagerEngine::~QGeoRoutingManagerEngine()

Удаляет этот движок.

[pure virtual] QGeoRouteReply *QGeoRoutingManagerEngine::calculateRoute(const QGeoRouteRequest &request)

Начинает вычисление маршрута, заданного request.

Возвращается объект QGeoRouteReply, который можно использовать для управления операцией маршрутизации и получения результатов операции.

Движок и возвращаемый объект QGeoRouteReply будут испускать сигналы, показывающие, завершена ли операция или произошли ошибки.

После завершения операции QGeoRouteReply::routes может быть использован для получения рассчитанного маршрута или маршрутов.

Если request содержит функции, которые не поддерживаются этим движком, как указано методами в этом движке, то произойдёт ошибка QGeoRouteReply::UnsupportedOptionError.

Пользователь отвечает за удаление возвращаемого объекта reply, хотя это можно сделать в слоте, подключенном к QGeoRoutingManagerEngine::finished(), QGeoRoutingManagerEngine::error(), QGeoRouteReply::finished() или QGeoRouteReply::error() с помощью deleteLater().

[signal] void QGeoRoutingManagerEngine::error(QGeoRouteReply *reply, QGeoRouteReply::Error error, QString errorString = QString())

Этот сигнал подаётся, когда в обработке reply обнаружена ошибка. Сигнал QGeoRoutingManagerEngine::finished() вероятно последует за ним.

Ошибка будет описана кодом ошибки error. Если errorString не пуста, она будет содержать текстовое описание ошибки.

Этот сигнал и QGeoRouteReply::error() будут поданы одновременно.

Примечание: Не удаляйте объект reply в слоте, подключенном к этому сигналу. Используйте deleteLater() вместо этого.

[signal] void QGeoRoutingManagerEngine::finished(QGeoRouteReply *reply)

Этот сигнал подаётся, когда обработка reply завершена.

Если reply::error() равно QGeoRouteReply::NoError, то обработка завершилась успешно.

Этот сигнал и QGeoRouteReply::finished() будут поданы одновременно.

Примечание: Не удаляйте объект reply в слоте, подключенном к этому сигналу. Используйте deleteLater() вместо этого.

QLocale QGeoRoutingManagerEngine::locale() const

Возвращает локаль, используемую для указания этому менеджеру маршрутизации, какой язык использовать для адресов и инструкций.

См. также setLocale().

QString QGeoRoutingManagerEngine::managerName() const

Возвращает имя, которое эта реализация движка использует для отличия от реализаций, предоставляемых другими плагинами.

Сочетание managerName() и managerVersion() должно быть уникальным среди реализаций плагинов.

int QGeoRoutingManagerEngine::managerVersion() const

Возвращает версию этой реализации движка.

Сочетание managerName() и managerVersion() должно быть уникальным среди реализаций плагинов.

QLocale::MeasurementSystem QGeoRoutingManagerEngine::measurementSystem() const

Возвращает систему измерения, используемую этим менеджером.

Если была вызвана setMeasurementSystem(), то значение, возвращаемое этой функцией, может отличаться от значения, возвращаемого locale().measurementSystem(). В этом случае значение, возвращаемое этой функцией, будет использоваться менеджером.

См. также setMeasurementSystem() и setLocale().

void QGeoRoutingManagerEngine::setLocale(const QLocale &locale)

Устанавливает локаль, используемую этим менеджером, на locale.

Если этот менеджер маршрутизации поддерживает возврат адресов и инструкций на разных языках, они будут возвращаться на языке locale.

По умолчанию используется системная локаль, если она не установлена.

См. также locale().

void QGeoRoutingManagerEngine::setMeasurementSystem(QLocale::MeasurementSystem system)

Устанавливает систему измерения, используемую этим менеджером, на system.

Систему измерения можно установить независимо от локали. Обе setLocale() и эта функция устанавливают систему измерения. Значение, установленное последней вызванной функцией, будет использоваться.

См. также measurementSystem(), locale() и setLocale().

[protected] void QGeoRoutingManagerEngine::setSupportedFeatureTypes(QGeoRouteRequest::FeatureTypes featureTypes)

Устанавливает типы объектов, которые этот движок может учитывать при планировании маршрута, на featureTypes.

Подклассы должны использовать этот метод, чтобы убедиться, что движок правильно сообщает о своих возможностях. Если эта функция не используется, движок будет сообщать, что не поддерживает никаких типов объектов.

См. также supportedFeatureTypes().

[protected] void QGeoRoutingManagerEngine::setSupportedFeatureWeights(QGeoRouteRequest::FeatureWeights featureWeights)

Устанавливает весовые коэффициенты, которые этот движок может применять к различным объектам при планировании маршрута, на featureWeights.

Подклассы должны использовать этот метод, чтобы убедиться, что движок правильно сообщает о своих возможностях. Если эта функция не используется, движок будет сообщать, что не поддерживает никаких весовых коэффициентов.

См. также supportedFeatureWeights().

[protected] void QGeoRoutingManagerEngine::setSupportedManeuverDetails(QGeoRouteRequest::ManeuverDetails maneuverDetails)

Устанавливает уровни детализации для маневров навигации, которые может запросить этот движок, на maneuverDetails.

Подклассы должны использовать этот метод, чтобы убедиться, что движок правильно сообщает о своих возможностях. Если эта функция не используется, движок будет сообщать, что не поддерживает никаких подробностей маневров.

См. также supportedManeuverDetails().

[protected] void QGeoRoutingManagerEngine::setSupportedRouteOptimizations(QGeoRouteRequest::RouteOptimizations optimizations)

Устанавливает оптимизации маршрутов, поддерживаемые этим движком, на optimizations.

Подклассы должны использовать этот метод, чтобы убедиться, что движок правильно сообщает о своих возможностях. Если эта функция не используется, движок будет сообщать, что не поддерживает никаких оптимизаций маршрута.

См. также supportedRouteOptimizations().

[protected] void QGeoRoutingManagerEngine::setSupportedSegmentDetails(QGeoRouteRequest::SegmentDetails segmentDetails)

Устанавливает уровни детализации для сегментов маршрута, которые может запросить этот движок, на segmentDetails.

Подклассы должны использовать этот метод, чтобы убедиться, что движок правильно сообщает о своих возможностях. Если эта функция не используется, движок будет сообщать, что не поддерживает никаких подробностей сегмента.

См. также supportedSegmentDetails().

[protected] void QGeoRoutingManagerEngine::setSupportedTravelModes(QGeoRouteRequest::TravelModes travelModes)

Устанавливает типы транспортных режимов, поддерживаемые этим движком, на travelModes.

Подклассы должны использовать этот метод, чтобы убедиться, что движок правильно сообщает о своих возможностях. Если эта функция не используется, движок будет сообщать, что не поддерживает никаких режимов передвижения.

См. также supportedTravelModes().

QGeoRouteRequest::FeatureTypes QGeoRoutingManagerEngine::supportedFeatureTypes() const

Возвращает типы объектов, которые этот движок может учитывать при планировании маршрута.

См. также setSupportedFeatureTypes().

QGeoRouteRequest::FeatureWeights QGeoRoutingManagerEngine::supportedFeatureWeights() const

Возвращает весовые коэффициенты, которые этот движок может применять к различным объектам при планировании маршрута.

См. также setSupportedFeatureWeights().

QGeoRouteRequest::ManeuverDetails QGeoRoutingManagerEngine::supportedManeuverDetails() const

Возвращает уровни детализации для маневров навигации, которые может запросить этот движок.

См. также setSupportedManeuverDetails().

QGeoRouteRequest::RouteOptimizations QGeoRoutingManagerEngine::supportedRouteOptimizations() const

Возвращает оптимизации маршрутов, поддерживаемые этим движком.

См. также setSupportedRouteOptimizations().

QGeoRouteRequest::SegmentDetails QGeoRoutingManagerEngine::supportedSegmentDetails() const

Возвращает уровни детализации для маршрутных сегментов, которые могут быть запрошены этим движком.

См. также setSupportedSegmentDetails().

QGeoRouteRequest::TravelModes QGeoRoutingManagerEngine::supportedTravelModes() const

Возвращает режимы передвижения, поддерживаемые этим движком.

См. также setSupportedTravelModes().

[virtual] QGeoRouteReply *QGeoRoutingManagerEngine::updateRoute(const QGeoRoute &route, const QGeoCoordinate &position)

Начинает процесс обновления route на основе текущего положения position.

Будет возвращён объект QGeoRouteReply, который может быть использован для управления операцией маршрутизации и возврата результатов операции.

Этот движок и возвращённый объект QGeoRouteReply будут излучать сигналы, указывающие на завершение операции или возникновение ошибок.

Если supportsRouteUpdates() возвращает false, произойдёт ошибка QGeoRouteReply::UnsupportedOptionError.

После завершения операции, QGeoRouteReply::routes можно использовать для получения обновлённого маршрута.

Возвращённый маршрут может быть полностью отличным от исходного маршрута, особенно если position находится достаточно далеко от начального маршрута. В противном случае маршрут будет похожим, хотя оставшееся время и расстояние будут обновлены, и любые сегменты исходного маршрута, которые уже пройдены, будут удалены.

Пользователь несёт ответственность за удаление возвращённого объекта ответа, хотя это можно сделать в слоте, подключённом к QGeoRoutingManagerEngine::finished(), QGeoRoutingManagerEngine::error(), QGeoRouteReply::finished() или QGeoRouteReply::error() с помощью deleteLater().