Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QGeoRoutingManagerEngineMapbox Class Reference

#include <qgeoroutingmanagerenginemapbox.h>

+ Inheritance diagram for QGeoRoutingManagerEngineMapbox:
+ Collaboration diagram for QGeoRoutingManagerEngineMapbox:

Public Member Functions

 QGeoRoutingManagerEngineMapbox (const QVariantMap &parameters, QGeoServiceProvider::Error *error, QString *errorString)
 
 ~QGeoRoutingManagerEngineMapbox ()
 
QGeoRouteReply * calculateRoute (const QGeoRouteRequest &request) override
 
const QGeoRouteParser * routeParser () const
 
- Public Member Functions inherited from QGeoRoutingManagerEngine
 QGeoRoutingManagerEngine (const QVariantMap &parameters, QObject *parent=nullptr)
 Constructs a new engine with the specified parent, using parameters to pass any implementation specific data to the engine.
 
virtual ~QGeoRoutingManagerEngine ()
 Destroys this engine.
 
QString managerName () const
 Returns the name which this engine implementation uses to distinguish itself from the implementations provided by other plugins.
 
int managerVersion () const
 Returns the version of this engine implementation.
 
virtual QGeoRouteReply * updateRoute (const QGeoRoute &route, const QGeoCoordinate &position)
 Begins the process of updating route based on the current position position.
 
QGeoRouteRequest::TravelModes supportedTravelModes () const
 Returns the travel modes supported by this engine.
 
QGeoRouteRequest::FeatureTypes supportedFeatureTypes () const
 Returns the types of features that this engine can take into account during route planning.
 
QGeoRouteRequest::FeatureWeights supportedFeatureWeights () const
 Returns the weightings which this engine can apply to different features during route planning.
 
QGeoRouteRequest::RouteOptimizations supportedRouteOptimizations () const
 Returns the route optimizations supported by this engine.
 
QGeoRouteRequest::SegmentDetails supportedSegmentDetails () const
 Returns the levels of detail for routing segments which can be requested by this engine.
 
QGeoRouteRequest::ManeuverDetails supportedManeuverDetails () const
 Returns the levels of detail for navigation maneuvers which can be requested by this engine.
 
void setLocale (const QLocale &locale)
 Sets the locale to be used by this manager to locale.
 
QLocale locale () const
 Returns the locale used to hint to this routing manager about what language to use for addresses and instructions.
 
void setMeasurementSystem (QLocale::MeasurementSystem system)
 Sets the measurement system used by this manager to system.
 
QLocale::MeasurementSystem measurementSystem () const
 Returns the measurement system used by this manager.
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QString > bindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThread * thread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
T findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
T findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectList & children () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArray > dynamicPropertyNames () const
 
QBindingStorage * bindingStorage ()
 
const QBindingStorage * bindingStorage () const
 
QObject * parent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QGeoRoutingManagerEngine
void finished (QGeoRouteReply *reply)
 This signal is emitted when reply has finished processing.
 
void errorOccurred (QGeoRouteReply *reply, QGeoRouteReply::Error error, const QString &errorString=QString())
 This signal is emitted when an error has been detected in the processing of reply.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QGeoRoutingManagerEngine
void setSupportedTravelModes (QGeoRouteRequest::TravelModes travelModes)
 Sets the travel modes supported by this engine to travelModes.
 
void setSupportedFeatureTypes (QGeoRouteRequest::FeatureTypes featureTypes)
 Sets the types of features that this engine can take into account during route planning to featureTypes.
 
void setSupportedFeatureWeights (QGeoRouteRequest::FeatureWeights featureWeights)
 Sets the weightings which this engine can apply to different features during route planning to featureWeights.
 
void setSupportedRouteOptimizations (QGeoRouteRequest::RouteOptimizations optimizations)
 Sets the route optimizations supported by this engine to optimizations.
 
void setSupportedSegmentDetails (QGeoRouteRequest::SegmentDetails segmentDetails)
 Sets the levels of detail for routing segments which can be requested by this engine to segmentDetails.
 
void setSupportedManeuverDetails (QGeoRouteRequest::ManeuverDetails maneuverDetails)
 Sets the levels of detail for navigation maneuvers which can be requested by this engine to maneuverDetails.
 
- Protected Member Functions inherited from QObject
QObject * sender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 16 of file qgeoroutingmanagerenginemapbox.h.

Constructor & Destructor Documentation

◆ QGeoRoutingManagerEngineMapbox()

QGeoRoutingManagerEngineMapbox::QGeoRoutingManagerEngineMapbox ( const QVariantMap & parameters,
QGeoServiceProvider::Error * error,
QString * errorString )

Definition at line 183 of file qgeoroutingmanagerenginemapbox.cpp.

References QMap< Key, T >::contains(), error, QGeoRouteParser::LeftHandTraffic, QGeoServiceProvider::NoError, QStringLiteral, QGeoRouteParser::RightHandTraffic, QGeoRouteParserOsrmV5::setExtension(), QGeoRouteParser::setTrafficSide(), QVariant::toBool(), QString::toLatin1(), QVariant::toString(), and QMap< Key, T >::value().

+ Here is the call graph for this function:

◆ ~QGeoRoutingManagerEngineMapbox()

QGeoRoutingManagerEngineMapbox::~QGeoRoutingManagerEngineMapbox ( )

Definition at line 218 of file qgeoroutingmanagerenginemapbox.cpp.

Member Function Documentation

◆ calculateRoute()

QGeoRouteReply * QGeoRoutingManagerEngineMapbox::calculateRoute ( const QGeoRouteRequest & request)
overridevirtual 
Begins the calculation of the route specified by \a request.

A QGeoRouteReply object will be returned, which can be used to manage the
routing operation and to return the results of the operation.

This engine and the returned QGeoRouteReply object will emit signals
indicating if the operation completes or if errors occur.

Once the operation has completed, QGeoRouteReply::routes can be used to
retrieve the calculated route or routes.

If \a request includes features which are not supported by this engine, as
reported by the methods in this engine, then a
QGeoRouteReply::UnsupportedOptionError will occur.

The user is responsible for deleting the returned reply object, although
this can be done in the slot connected to QGeoRoutingManagerEngine::finished(),
QGeoRoutingManagerEngine::errorOccurred(), QGeoRouteReply::finished() or
QGeoRouteReply::errorOccurred() with deleteLater().

Implements QGeoRoutingManagerEngine.

Definition at line 222 of file qgeoroutingmanagerenginemapbox.cpp.

References QGeoRouteRequest::AvoidFeatureWeight, QGeoRouteRequest::BicycleTravel, QGeoRouteRequest::CarTravel, QObject::connect(), QGeoRouteRequest::DisallowFeatureWeight, QGeoRouteReply::errorOccurred(), QGeoRouteReply::finished(), QNetworkAccessManager::get(), mapboxDirectionsApiPath, QGeoRouteRequest::PedestrianTravel, QStringLiteral, reply, request, QGeoRouteParser::requestUrl(), QNetworkRequest::setHeader(), QGeoRouteRequest::TrafficFeature, url, and QNetworkRequest::UserAgentHeader.

+ Here is the call graph for this function:

◆ routeParser()

const QGeoRouteParser * QGeoRoutingManagerEngineMapbox::routeParser ( ) const

Definition at line 260 of file qgeoroutingmanagerenginemapbox.cpp.

The documentation for this class was generated from the following files: