QGeoRouteReply Class

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

头：	#include <QGeoRouteReply>
qmake:	QT += location
Since:	Qt 5.6
继承：	QObject

该类在 Qt 5.6 引入。

所有成员列表，包括继承成员

公共类型

enum	Error { NoError, EngineNotSetError, CommunicationError, ParseError, UnsupportedOptionError, UnknownError }

公共函数

	QGeoRouteReply (QGeoRouteReply::Error error , const QString & errorString , QObject * parent = nullptr)
virtual	~QGeoRouteReply ()
virtual void	abort ()
QGeoRouteReply::Error	error () const
QString	errorString () const
bool	isFinished () const
QGeoRouteRequest	request () const
QList<QGeoRoute>	routes () const

信号

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

保护函数

	QGeoRouteReply (const QGeoRouteRequest & request , QObject * parent = nullptr)
void	addRoutes (const QList<QGeoRoute> & routes )
void	setError (QGeoRouteReply::Error error , const QString & errorString )
void	setFinished (bool finished )
void	setRoutes (const QList<QGeoRoute> & routes )

详细描述

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

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

The finished () and error( 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 error( 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 ().

成员类型文档编制

enum QGeoRouteReply:: Error

Describes an error which prevented the completion of the operation.

常量	值	描述
`QGeoRouteReply::NoError`	`0`	没有出现错误。
`QGeoRouteReply::EngineNotSetError`	`1`	The routing manager that was used did not have a QGeoRoutingManagerEngine instance associated with it.
`QGeoRouteReply::CommunicationError`	`2`	An error occurred while communicating with the service provider.
`QGeoRouteReply::ParseError`	`3`	The response from the service provider was in an unrecognizable format.
`QGeoRouteReply::UnsupportedOptionError`	`4`	The requested operation or one of the options for the operation are not supported by the service provider.
`QGeoRouteReply::UnknownError`	`5`	An error occurred which does not fit into any of the other categories.

成员函数文档编制

`[protected]` QGeoRouteReply:: QGeoRouteReply (const QGeoRouteRequest & request , QObject * parent = nullptr)

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

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

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

`[signal]` void QGeoRouteReply:: aborted ()

This signal is emitted when the operation has been cancelled.

该函数在 Qt 5.9 引入。

另请参阅 abort ().

`[signal]` void QGeoRouteReply:: error ( QGeoRouteReply::Error error , const QString & errorString = QString())

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 。若 errorString is not empty it will contain a textual description of the error.

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

注意： Do not delete this reply object in the slot connected to this signal. Use deleteLater () 代替。

注意： 信号 error 在此类中被重载。通过使用函数指针句法连接到此信号，Qt 提供用于获得如此范例展示的函数指针的方便帮助程序：

connect(geoRouteReply, QOverload<QGeoRouteReply::Error, const QString &>::of(&QGeoRouteReply::error),
    [=](QGeoRouteReply::Error error, const QString &errorString){ /* ... */ });

`[signal]` void QGeoRouteReply:: finished ()

This signal is emitted when this reply has finished processing.

若 error () 等于 QGeoRouteReply::NoError then the processing finished successfully.

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

注意： Do not delete this reply object in the slot connected to this signal. Use deleteLater () 代替。

另请参阅 setFinished ().

`[虚拟]` QGeoRouteReply:: ~QGeoRouteReply ()

Destroys this route reply object.

`[虚拟]` void QGeoRouteReply:: abort ()

Cancels the operation immediately.

This will do nothing if the reply is finished.

`[protected]` void QGeoRouteReply:: addRoutes (const QList < QGeoRoute > & routes )

追加列表 routes to the existing list.

QGeoRouteReply::Error QGeoRouteReply:: error () const

Returns the error state of this reply.

若结果为 QGeoRouteReply::NoError then no error has occurred.

另请参阅 setError ().

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 .

bool QGeoRouteReply:: isFinished () const

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

QGeoRouteRequest QGeoRouteReply:: request () const

Returns the route request which specified the route.

QList < QGeoRoute > QGeoRouteReply:: routes () const

Returns the list of routes which were requested.

另请参阅 setRoutes ().

`[protected]` void QGeoRouteReply:: setError ( QGeoRouteReply::Error error , const QString & errorString )

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

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

另请参阅 error ().

`[protected]` void QGeoRouteReply:: setFinished ( bool finished )

Sets whether or not this reply has finished to finished .

若 finished is true, this will cause the finished () 信号发射。

If the operation completed successfully, QGeoRouteReply::setRoutes () should be called before this function. If an error occurred, QGeoRouteReply::setError () 应该被使用以取而代之。

另请参阅 finished ().

`[protected]` void QGeoRouteReply:: setRoutes (const QList < QGeoRoute > & routes )

Sets the list of routes in the reply to routes .

另请参阅 routes ().