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