Класс QGeoRouteRequest
Класс QGeoRouteRequest представляет параметры и ограничения, которые определяют запрос маршрутной информации. Подробнее...
| Заголовок: | #include <QGeoRouteRequest> |
| qmake: | QT += location |
| С момента: | Qt 5.6 |
Общедоступные типы
| Перечисление | ТипОсобенности { НетОсобенности, ОсобенностиПлатные, ОсобенностиАвтомагистрали, ОсобенностиОбщественныйТранспорт, ..., ОсобенностиДвижение } |
| флаги | ТипыОсобенности |
| Перечисление | ВесОсобенности { НейтральныйВесОсобенности, ПредпочитаемыйВесОсобенности, ТребуемыйВесОсобенности, ИзбегатьВесОсобенности, ЗапрещеноВесОсобенности } |
| флаги | ВесаОсобенности |
| Перечисление | ПодробностиМаневра { НетМаневров, БазовыеМаневры } |
| флаги | ПодробностиМаневров |
| Перечисление | ОптимизацияМаршрута { СамыйКороткийМаршрут, СамыйБыстрыйМаршрут, СамыйЭкономичныйМаршрут, СамыйКрасивыйМаршрут } |
| флаги | ОптимизацииМаршрута |
| Перечисление | ПодробностиОтрезка { НетДанныхОтрезка, БазовыеДанныеОтрезка } |
| флаги | ПодробностиОтрезков |
| Перечисление | РежимПередвижения { Авто, Пешеход, Велосипед, ОбщественныйТранспорт, Грузовик } |
| флаги | РежимыПередвижения |
Общедоступные функции
| QGeoRouteRequest(const QList<QGeoCoordinate> &waypoints = ...) | |
| QGeoRouteRequest(const QGeoCoordinate &origin, const QGeoCoordinate &destination) | |
| QGeoRouteRequest(const QGeoRouteRequest &other) | |
| ~QGeoRouteRequest() | |
| QList<QGeoRectangle> | excludeAreas() const |
| QVariantMap | extraParameters() const |
| QList<QGeoRouteRequest::FeatureType> | featureTypes() const |
| QGeoRouteRequest::FeatureWeight | featureWeight(QGeoRouteRequest::FeatureType featureType) const |
| QGeoRouteRequest::ManeuverDetail | maneuverDetail() const |
| int | numberAlternativeRoutes() const |
| QGeoRouteRequest::RouteOptimizations | routeOptimization() const |
| QGeoRouteRequest::SegmentDetail | segmentDetail() const |
| void | setExcludeAreas(const QList<QGeoRectangle> &areas) |
| void | setExtraParameters(const QVariantMap &extraParameters) |
| void | setFeatureWeight(QGeoRouteRequest::FeatureType featureType, QGeoRouteRequest::FeatureWeight featureWeight) |
| void | setManeuverDetail(QGeoRouteRequest::ManeuverDetail maneuverDetail) |
| void | setNumberAlternativeRoutes(int alternatives) |
| void | setRouteOptimization(QGeoRouteRequest::RouteOptimizations optimization) |
| void | setSegmentDetail(QGeoRouteRequest::SegmentDetail segmentDetail) |
| void | setTravelModes(QGeoRouteRequest::TravelModes travelModes) |
| void | setWaypoints(const QList<QGeoCoordinate> &waypoints) |
| void | setWaypointsMetadata(const QList<QVariantMap> &waypointMetadata) |
| QGeoRouteRequest::TravelModes | travelModes() const |
| QList<QGeoCoordinate> | waypoints() const |
| QList<QVariantMap> | waypointsMetadata() const |
| bool | operator!=(const QGeoRouteRequest &other) const |
| QGeoRouteRequest & | operator=(const QGeoRouteRequest &other) |
| bool | operator==(const QGeoRouteRequest &other) const |
Подробное описание
Класс QGeoRouteRequest представляет параметры и ограничения, определяющие запрос на маршрутную информацию.
Значение по умолчанию экземпляра QGeoRouteRequest приведет к запросу основных сегментов маршрута и навигационных маневров, описывающих самый быстрый автомобильный маршрут, который покрывает заданные точки.
В функциональности, поддерживаемой различными поставщиками маршрутной информации, могут быть значительные различия, а также различия в функциональности, поддерживаемой одним поставщиком при использовании различных уровней авторизации.
В QGeoRoutingManager есть несколько функций, которые можно использовать для проверки поддерживаемых функций с текущим уровнем авторизации и поставщиком.
См. также QGeoRoutingManager.
Документация по типам членов
enum QGeoRouteRequest::FeatureTypeflags QGeoRouteRequest::FeatureTypes
Определяет функцию, которая важна для планирования маршрута.
Эти значения будут использоваться в сочетании с QGeoRouteRequest::FeatureWeight для определения, должны ли они или не должны быть частью маршрута.
| Константа | Значение | Описание |
|---|---|---|
QGeoRouteRequest::NoFeature |
0x00000000 |
Используется функцией QGeoRoutingManager::supportedFeatureTypes() для указания того, что при планировании маршрута никакие функции не будут учитываться. |
QGeoRouteRequest::TollFeature |
0x00000001 |
Учитывать платные дороги при планировании маршрута. |
QGeoRouteRequest::HighwayFeature |
0x00000002 |
Учитывать автомагистрали при планировании маршрута. |
QGeoRouteRequest::PublicTransitFeature |
0x00000004 |
Учитывать общественный транспорт при планировании маршрута. |
QGeoRouteRequest::FerryFeature |
0x00000008 |
Учитывать паромы при планировании маршрута. |
QGeoRouteRequest::TunnelFeature |
0x00000010 |
Учитывать тоннели при планировании маршрута. |
QGeoRouteRequest::DirtRoadFeature |
0x00000020 |
Учитывать грунтовые дороги при планировании маршрута. |
QGeoRouteRequest::ParksFeature |
0x00000040 |
Учитывать парки при планировании маршрута. |
QGeoRouteRequest::MotorPoolLaneFeature |
0x00000080 |
Учитывать полосы для автобусов и грузовиков при планировании маршрута. |
QGeoRouteRequest::TrafficFeature |
0x00000100 |
Учитывать текущую дорожную ситуацию при планировании маршрута. С версии QtLocation 5.10 |
Тип FeatureTypes является типом-синонимом для QFlags<FeatureType>. Он хранит логическое ИЛИ сочетание значений FeatureType.
enum QGeoRouteRequest::FeatureWeightflags QGeoRouteRequest::FeatureWeights
Определяет вес, который необходимо присвоить функции при планировании маршрута.
Эти значения будут использоваться в сочетании с QGeoRouteRequest::Feature для определения, должны ли они или не должны быть частью маршрута.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteRequest::NeutralFeatureWeight |
0x00000000 |
Наличие или отсутствие функции не повлияет на планирование маршрута. |
QGeoRouteRequest::PreferFeatureWeight |
0x00000001 |
Маршруты, содержащие функцию, будут предпочтительнее тех, которые её не содержат. |
QGeoRouteRequest::RequireFeatureWeight |
0x00000002 |
Будут рассмотрены только маршруты, содержащие функцию; в противном случае маршрут не будет возвращён. |
QGeoRouteRequest::AvoidFeatureWeight |
0x00000004 |
Маршруты, не содержащие функцию, будут предпочтительнее тех, которые её содержат. |
QGeoRouteRequest::DisallowFeatureWeight |
0x00000008 |
Будут рассмотрены только маршруты, не содержащие функцию; в противном случае маршрут не будет возвращён. |
Тип FeatureWeights — это typedef для QFlags<FeatureWeight>. Он хранит логическое ИЛИ сочетание значений FeatureWeight.
enum QGeoRouteRequest::ManeuverDetailflags QGeoRouteRequest::ManeuverDetails
Определяет объём информации о манёврах, который должен быть включён в маршрут.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteRequest::NoManeuvers |
0x0000 |
Манёвры не должны быть включены в маршрут. |
QGeoRouteRequest::BasicManeuvers |
0x0001 |
В маршрут будут включены базовые манёвры. Это будет включать QGeoManeuver::instructionText(). |
Тип ManeuverDetails — это typedef для QFlags<ManeuverDetail>. Он хранит логическое ИЛИ сочетание значений ManeuverDetail.
enum QGeoRouteRequest::RouteOptimizationflags QGeoRouteRequest::RouteOptimizations
Определяет тип оптимизации, применяемый к планированию маршрута.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteRequest::ShortestRoute |
0x0001 |
Минимизация длины поездки. |
QGeoRouteRequest::FastestRoute |
0x0002 |
Минимизация времени поездки. |
QGeoRouteRequest::MostEconomicRoute |
0x0004 |
Минимизация стоимости поездки. |
QGeoRouteRequest::MostScenicRoute |
0x0008 |
Максимизация живописности поездки. |
Тип RouteOptimizations — это typedef для QFlags<RouteOptimization>. Он хранит логическое ИЛИ сочетание значений RouteOptimization.
enum QGeoRouteRequest::SegmentDetailflags QGeoRouteRequest::SegmentDetails
Определяет объём информации о сегментах маршрута, который должен быть включён в маршрут.
| Постоянная | Значение | Описание |
|---|---|---|
QGeoRouteRequest::NoSegmentData |
0x0000 |
Данные о сегментах не должны включаться в маршрут. Маршрут, запрошенный с таким уровнем детализации сегментов, инициализирует QGeoRouteSegment::path() прямой линией между позициями предыдущих и последующих экземпляров QGeoManeuver. |
QGeoRouteRequest::BasicSegmentData |
0x0001 |
В маршрут будут включены базовые данные о сегментах. Это будет включать QGeoRouteSegment::path(). |
Тип SegmentDetails — это typedef для QFlags<SegmentDetail>. Он хранит логическое ИЛИ сочетание значений SegmentDetail.
enum QGeoRouteRequest::TravelModeflags QGeoRouteRequest::TravelModes
Определяет режимы передвижения, которые следует использовать для маршрута.
| Константа | Значение | Описание |
|---|---|---|
QGeoRouteRequest::CarTravel |
0x0001 |
Маршрут будет оптимизирован для водителя автомобиля. |
QGeoRouteRequest::PedestrianTravel |
0x0002 |
Маршрут будет оптимизирован для пешехода. |
QGeoRouteRequest::BicycleTravel |
0x0004 |
Маршрут будет оптимизирован для велосипедиста. |
QGeoRouteRequest::PublicTransitTravel |
0x0008 |
Маршрут будет оптимизирован для использования общественного транспорта. |
QGeoRouteRequest::TruckTravel |
0x0010 |
Маршрут будет оптимизирован для водителя грузовика. |
Тип TravelModes — это typedef для QFlags<TravelMode>. Он хранит логическое ИЛИ сочетание значений TravelMode.
Документация функций-членов
QGeoRouteRequest::QGeoRouteRequest(const QList<QGeoCoordinate> &waypoints = ...)
Создаёт запрос на вычисление маршрута через координаты waypoints.
Маршрут будет проходить через объекты waypoints в указанном порядке.
QGeoRouteRequest::QGeoRouteRequest(const QGeoCoordinate &origin, const QGeoCoordinate &destination)
Создаёт запрос на вычисление маршрута между origin и destination.
QGeoRouteRequest::QGeoRouteRequest(const QGeoRouteRequest &other)
Создаёт объект запроса маршрута из содержимого other.
QGeoRouteRequest::~QGeoRouteRequest()
Удаляет запрос.
QList<QGeoRectangle> QGeoRouteRequest::excludeAreas() const
Возвращает области, через которые маршрут не должен проходить.
См. также setExcludeAreas().
QVariantMap QGeoRouteRequest::extraParameters() const
Возвращает дополнительные параметры, заданные для этого запроса маршрута.
Эта функция была добавлена в Qt 5.11.
См. также setExtraParameters().
QList<QGeoRouteRequest::FeatureType> QGeoRouteRequest::featureTypes() const
Возвращает список объектов, которые будут учитываться при планировании маршрута. Объекты с весом NeutralFeatureWeight не будут возвращены.
QGeoRouteRequest::FeatureWeight QGeoRouteRequest::featureWeight(QGeoRouteRequest::FeatureType featureType) const
Возвращает вес, назначенный featureType при планировании маршрута.
Если для featureType не был указан вес, будет возвращён NeutralFeatureWeight.
См. также setFeatureWeight().
QGeoRouteRequest::ManeuverDetail QGeoRouteRequest::maneuverDetail() const
Возвращает уровень детализации, который будет использован в представлении маршрутных маневров.
См. также setManeuverDetail().
int QGeoRouteRequest::numberAlternativeRoutes() const
Возвращает количество альтернативных маршрутов, которые будут запрошены.
См. также setNumberAlternativeRoutes().
QGeoRouteRequest::RouteOptimizations QGeoRouteRequest::routeOptimization() const
Возвращает критерии оптимизации, которые этот запрос определяет для использования при планировании маршрута.
См. также setRouteOptimization().
QGeoRouteRequest::SegmentDetail QGeoRouteRequest::segmentDetail() const
Возвращает уровень детализации, который будет использоваться при представлении маршрутных сегментов.
См. также setSegmentDetail().
void QGeoRouteRequest::setExcludeAreas(const QList<QGeoRectangle> &areas)
Устанавливает areas в качестве исключённых областей, через которые маршрут не должен проходить.
См. также excludeAreas().
void QGeoRouteRequest::setExtraParameters(const QVariantMap &extraParameters)
Устанавливает дополнительные параметры extraParameters для запроса маршрута. Формат дополнительных параметров зависит от плагина и документирован для каждого плагина.
Эта функция была добавлена в Qt 5.11.
См. также extraParameters().
void QGeoRouteRequest::setFeatureWeight(QGeoRouteRequest::FeatureType featureType, QGeoRouteRequest::FeatureWeight featureWeight)
Присваивает весомость featureWeight типу объекта featureType во время планирования маршрута.
По умолчанию всем объектам присваивается весомость NeutralFeatureWeight.
Невозможно присвоить весомость объекту QGeoRouteRequest::NoFeature.
См. также featureWeight().
void QGeoRouteRequest::setManeuverDetail(QGeoRouteRequest::ManeuverDetail maneuverDetail)
Устанавливает уровень детализации при представлении маршрутных маневров в maneuverDetail.
Значение по умолчанию — QGeoRouteRequest::BasicManeuvers.
См. также maneuverDetail().
void QGeoRouteRequest::setNumberAlternativeRoutes(int alternatives)
Устанавливает количество альтернативных маршрутов, которые необходимо запросить, в alternatives. Если alternatives отрицательно, количество альтернативных маршрутов устанавливается в 0.
Значение по умолчанию — 0.
См. также numberAlternativeRoutes().
void QGeoRouteRequest::setRouteOptimization(QGeoRouteRequest::RouteOptimizations optimization)
Устанавливает критерии оптимизации при планировании маршрута в optimization.
Значение по умолчанию — QGeoRouteRequest::FastestRoute.
См. также routeOptimization().
void QGeoRouteRequest::setSegmentDetail(QGeoRouteRequest::SegmentDetail segmentDetail)
Устанавливает уровень детализации при представлении маршрутных сегментов в segmentDetail.
См. также segmentDetail().
void QGeoRouteRequest::setTravelModes(QGeoRouteRequest::TravelModes travelModes)
Устанавливает типы передвижения, которые необходимо учитывать при планировании маршрута, в travelModes.
Значение по умолчанию — QGeoRouteRequest::CarTravel.
См. также travelModes().
void QGeoRouteRequest::setWaypoints(const QList<QGeoCoordinate> &waypoints)
Устанавливает waypoints в качестве точек маршрута, через которые должен проходить маршрут.
Точки маршрута должны быть указаны в порядке от начала до конца.
Этот запрос будет недействительным до тех пор, пока точки маршрута не будут установлены в список, содержащий две или более координат.
См. также waypoints().
void QGeoRouteRequest::setWaypointsMetadata(const QList<QVariantMap> &waypointMetadata)
Устанавливает waypointMetadata в качестве метаданных для точек маршрута, установленных в этом запросе. Метаданные предназначены как один QVariantMap на каждую точку маршрута, указанные в том же порядке, что и точки маршрута.
Содержимое QVariantMap зависит от бэкэнда, но свойства, которые можно указать с помощью элементов Waypoint в QML, предполагается именовать и работать одинаково во всех плагинах, где это поддерживается.
См. также waypointsMetadata().
QGeoRouteRequest::TravelModes QGeoRouteRequest::travelModes() const
Возвращает режимы передвижения, которые должны учитываться при планировании маршрута.
См. также setTravelModes().
QList<QGeoCoordinate> QGeoRouteRequest::waypoints() const
Возвращает точки маршрута, через которые будет проходить маршрут.
См. также setWaypoints().
QList<QVariantMap> QGeoRouteRequest::waypointsMetadata() const
Возвращает метаданные для точек маршрута в этом запросе.
См. также setWaypointsMetadata().
bool QGeoRouteRequest::operator!=(const QGeoRouteRequest &other) const
Возвращает значение true, если этот запрос на маршрут и other не равны.
QGeoRouteRequest &QGeoRouteRequest::operator=(const QGeoRouteRequest &other)
Присваивает other объекту запроса на маршрут и возвращает ссылку на этот объект запроса на маршрут.
bool QGeoRouteRequest::operator==(const QGeoRouteRequest &other) const
Возвращает значение true, если этот запрос на маршрут и other равны.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/archives/qt-5.11/qgeorouterequest.html