\inmodule QtLocation More...

#include <qgeoroutereply.h>

Inheritance diagram for QGeoRouteReply:

Collaboration diagram for QGeoRouteReply:

Public Types
enum	Error { NoError , EngineNotSetError , CommunicationError , ParseError , UnsupportedOptionError , UnknownError }
	Describes an error which prevented the completion of the operation. More...

Signals
void	finished ()
	This signal is emitted when this reply has finished processing.

void	aborted ()

void	errorOccurred (QGeoRouteReply::Error error, const QString &errorString=QString())
	This signal is emitted when an error has been detected in the processing of this 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.

Public Member Functions
	QGeoRouteReply (Error error, const QString &errorString, QObject *parent=nullptr)
	Constructs a route reply with a given error and errorString and the specified parent.

virtual	~QGeoRouteReply ()
	Destroys this route reply object.

bool	isFinished () const
	Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.

Error	error () const
	Returns the error state of this reply.

QString	errorString () const
	Returns the textual representation of the error state of this reply.

QGeoRouteRequest	request () const
	Returns the route request which specified the route.

QList< QGeoRoute >	routes () const
	Returns the list of routes which were requested.

virtual void	abort ()
	Cancels the operation immediately.

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`.

Protected Member Functions
	QGeoRouteReply (const QGeoRouteRequest &request, QObject *parent=nullptr)
	Constructs a route reply object based on request, with the specified parent.

void	setError (Error error, const QString &errorString)
	Sets the error state of this reply to error and the textual representation of the error to errorString.

void	setFinished (bool finished)
	Sets whether or not this reply has finished to finished.

void	setRoutes (const QList< QGeoRoute > &routes)
	Sets the list of routes in the reply to routes.

void	addRoutes (const QList< QGeoRoute > &routes)
	Appends the list of routes to the existing list.

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)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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 Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\inmodule QtLocation

Since: 5.6

The QGeoRouteReply class manages an operation started by an instance of QGeoRoutingManager.

Instances of QGeoRouteReply manage the state and results of these operations.

The isFinished(), error() and errorString() methods provide information on whether the operation has completed and if it completed successfully.

The finished() and errorOccurred(QGeoRouteReply::Error,QString) signals can be used to monitor the progress of the operation.

It is possible that a newly created QGeoRouteReply may be in a finished state, most commonly because an error has occurred. Since such an instance will never emit the finished() or errorOccurred(QGeoRouteReply::Error,QString) signals, it is important to check the result of isFinished() before making the connections to the signals. The documentation for QGeoRoutingManager demonstrates how this might be carried out.

If the operation completes successfully the results will be able to be accessed with routes().

Definition at line 17 of file qgeoroutereply.h.

Member Enumeration Documentation

◆ Error

enum QGeoRouteReply::Error

Describes an error which prevented the completion of the operation.

\value NoError No error has occurred. \value EngineNotSetError The routing manager that was used did not have a QGeoRoutingManagerEngine instance associated with it. \value CommunicationError An error occurred while communicating with the service provider. \value ParseError The response from the service provider was in an unrecognizable format. \value UnsupportedOptionError The requested operation or one of the options for the operation are not supported by the service provider. \value UnknownError An error occurred which does not fit into any of the other categories.

Enumerator
NoError
EngineNotSetError
CommunicationError
ParseError
UnsupportedOptionError
UnknownError

Definition at line 21 of file qgeoroutereply.h.

Constructor & Destructor Documentation

◆ QGeoRouteReply() [1/2]

QGeoRouteReply::QGeoRouteReply	(	Error	error,
		const QString &	errorString,
		QObject *	parent = nullptr )

explicit

Constructs a route reply with a given error and errorString and the specified parent.

Definition at line 71 of file qgeoroutereply.cpp.

◆ ~QGeoRouteReply()

QGeoRouteReply::~QGeoRouteReply ( )

virtual

Destroys this route reply object.

Definition at line 78 of file qgeoroutereply.cpp.

◆ QGeoRouteReply() [2/2]

QGeoRouteReply::QGeoRouteReply	(	const QGeoRouteRequest &	request,
		QObject *	parent = nullptr )

explicitprotected

Constructs a route reply object based on request, with the specified parent.

Definition at line 62 of file qgeoroutereply.cpp.

Member Function Documentation

◆ abort()

void QGeoRouteReply::abort ( )

virtual

Cancels the operation immediately.

This will do nothing if the reply is finished.

Definition at line 195 of file qgeoroutereply.cpp.

References aborted(), and emit.

Referenced by QDeclarativeGeoRouteModel::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ aborted

void QGeoRouteReply::aborted ( )

signal

Since: 5.9

This signal is emitted when the operation has been cancelled.

See also: abort()

Referenced by GeoRouteReplyEsri::GeoRouteReplyEsri(), QGeoRouteReplyMapbox::QGeoRouteReplyMapbox(), QGeoRouteReplyNokia::QGeoRouteReplyNokia(), QGeoRouteReplyOsm::QGeoRouteReplyOsm(), and abort().

Here is the caller graph for this function:

◆ addRoutes()

void QGeoRouteReply::addRoutes ( const QList< QGeoRoute > & routes )

protected

Appends the list of routes to the existing list.

Definition at line 176 of file qgeoroutereply.cpp.

References QList< T >::append(), routes(), and QGeoRouteReplyPrivate::routes.

Here is the call graph for this function:

◆ error()

QGeoRouteReply::Error QGeoRouteReply::error ( ) const

Returns the error state of this reply.

If the result is QGeoRouteReply::NoError then no error has occurred.

Definition at line 129 of file qgeoroutereply.cpp.

References QGeoRouteReplyPrivate::error.

Referenced by setError().

Here is the caller graph for this function:

◆ errorOccurred

void QGeoRouteReply::errorOccurred	(	QGeoRouteReply::Error	error,
		const QString &	errorString = QString() )

signal

This signal is emitted when an error has been detected in the processing of this reply.

The finished() signal will probably follow.

The error will be described by the error code error. If errorString is not empty it will contain a textual description of the error.

This signal and QGeoRoutingManager::errorOccurred() will be emitted at the same time.

Note: Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.

Referenced by GeoRoutingManagerEngineEsri::calculateRoute(), QGeoRoutingManagerEngineMapbox::calculateRoute(), QGeoRoutingManagerEngineNokia::calculateRoute(), QGeoRoutingManagerEngineOsm::calculateRoute(), setError(), and QGeoRoutingManagerEngineNokia::updateRoute().

Here is the caller graph for this function:

◆ errorString()

QString QGeoRouteReply::errorString ( ) const

Returns the textual representation of the error state of this reply.

If no error has occurred this will return an empty string. It is possible that an error occurred which has no associated textual representation, in which case this will also return an empty string.

To determine whether an error has occurred, check to see if QGeoRouteReply::error() is equal to QGeoRouteReply::NoError.

Definition at line 144 of file qgeoroutereply.cpp.

References QGeoRouteReplyPrivate::errorString.

Referenced by setError().

Here is the caller graph for this function:

◆ finished

void QGeoRouteReply::finished ( )

signal

This signal is emitted when this reply has finished processing.

If error() equals QGeoRouteReply::NoError then the processing finished successfully.

This signal and QGeoRoutingManager::finished() will be emitted at the same time.

Note: Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.

Referenced by GeoRoutingManagerEngineEsri::calculateRoute(), QGeoRoutingManagerEngineMapbox::calculateRoute(), QGeoRoutingManagerEngineNokia::calculateRoute(), QGeoRoutingManagerEngineOsm::calculateRoute(), setFinished(), and QGeoRoutingManagerEngineNokia::updateRoute().

Here is the caller graph for this function:

◆ isFinished()

bool QGeoRouteReply::isFinished ( ) const

Return true if the operation completed successfully or encountered an error which cause the operation to come to a halt.

Definition at line 104 of file qgeoroutereply.cpp.

References QGeoRouteReplyPrivate::isFinished.

◆ request()

QGeoRouteRequest QGeoRouteReply::request ( ) const

Returns the route request which specified the route.

Definition at line 152 of file qgeoroutereply.cpp.

References QGeoRouteReplyPrivate::request.

◆ routes()

QList< QGeoRoute > QGeoRouteReply::routes ( ) const

Returns the list of routes which were requested.

Definition at line 160 of file qgeoroutereply.cpp.

References QGeoRouteReplyPrivate::routes.

Referenced by addRoutes(), and setRoutes().

Here is the caller graph for this function:

◆ setError()

void QGeoRouteReply::setError	(	QGeoRouteReply::Error	error,
		const QString &	errorString )

protected

Sets the error state of this reply to error and the textual representation of the error to errorString.

This will also cause errorOccurred() and finished() signals to be emitted, in that order.

Definition at line 116 of file qgeoroutereply.cpp.

References emit, error(), QGeoRouteReplyPrivate::error, errorOccurred(), errorString(), QGeoRouteReplyPrivate::errorString, and setFinished().

Referenced by GeoRouteReplyEsri::GeoRouteReplyEsri(), QGeoRouteReplyMapbox::QGeoRouteReplyMapbox(), QGeoRouteReplyNokia::QGeoRouteReplyNokia(), and QGeoRouteReplyOsm::QGeoRouteReplyOsm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFinished()

void QGeoRouteReply::setFinished ( bool finished )

protected

Sets whether or not this reply has finished to finished.

If finished is true, this will cause the finished() signal to be emitted.

If the operation completed successfully, QGeoRouteReply::setRoutes() should be called before this function. If an error occurred, QGeoRouteReply::setError() should be used instead.

Definition at line 93 of file qgeoroutereply.cpp.

References emit, finished(), and QGeoRouteReplyPrivate::isFinished.

Referenced by setError().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRoutes()

void QGeoRouteReply::setRoutes ( const QList< QGeoRoute > & routes )

protected

Sets the list of routes in the reply to routes.

Definition at line 168 of file qgeoroutereply.cpp.

References routes(), and QGeoRouteReplyPrivate::routes.

Here is the call graph for this function:

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

qtlocation/src/location/maps/qgeoroutereply.h (8aaf46ce20d3d20a2678e30a4365b2d8db088c01)
qtlocation/src/location/maps/qgeoroutereply.cpp (cd4db512ae08836f5fa1d746000052215cf70a9c)

Public Types

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Error

Constructor & Destructor Documentation

◆ QGeoRouteReply() [1/2]

◆ ~QGeoRouteReply()

◆ QGeoRouteReply() [2/2]

Member Function Documentation

◆ abort()

◆ aborted

◆ addRoutes()

◆ error()

◆ errorOccurred

◆ errorString()

◆ finished

◆ isFinished()

◆ request()

◆ routes()

◆ setError()

◆ setFinished()

◆ setRoutes()