1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qgeoroutereply.h"
#include "qgeoroutereply_p.h"
QT_BEGIN_NAMESPACE
/*!
\class QGeoRouteReply
\inmodule QtLocation
\ingroup QtLocation-routing
\since 5.6
\brief 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 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.
\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.
*/
/*!
Constructs a route reply object based on \a request, with the specified \a parent.
*/
QGeoRouteReply::QGeoRouteReply(const QGeoRouteRequest &request, QObject *parent)
: QObject(parent),
d_ptr(new QGeoRouteReplyPrivate(request))
{
}
/*!
Constructs a route reply with a given \a error and \a errorString and the specified \a parent.
*/
QGeoRouteReply::QGeoRouteReply(Error error, const QString &errorString, QObject *parent)
: QObject(parent),
d_ptr(new QGeoRouteReplyPrivate(error, errorString)) {}
/*!
Destroys this route reply object.
*/
QGeoRouteReply::~QGeoRouteReply()
{
delete d_ptr;
}
/*!
Sets whether or not this reply has finished to \a finished.
If \a 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.
*/
void QGeoRouteReply::setFinished(bool finished)
{
d_ptr->isFinished = finished;
if (d_ptr->isFinished)
emit this->finished();
}
/*!
Return true if the operation completed successfully or encountered an
error which cause the operation to come to a halt.
*/
bool QGeoRouteReply::isFinished() const
{
return d_ptr->isFinished;
}
/*!
Sets the error state of this reply to \a error and the textual
representation of the error to \a errorString.
This will also cause error() and finished() signals to be emitted, in that
order.
*/
void QGeoRouteReply::setError(QGeoRouteReply::Error error, const QString &errorString)
{
d_ptr->error = error;
d_ptr->errorString = errorString;
emit this->error(error, errorString);
setFinished(true);
}
/*!
Returns the error state of this reply.
If the result is QGeoRouteReply::NoError then no error has occurred.
*/
QGeoRouteReply::Error QGeoRouteReply::error() const
{
return d_ptr->error;
}
/*!
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.
*/
QString QGeoRouteReply::errorString() const
{
return d_ptr->errorString;
}
/*!
Returns the route request which specified the route.
*/
QGeoRouteRequest QGeoRouteReply::request() const
{
return d_ptr->request;
}
/*!
Returns the list of routes which were requested.
*/
QList<QGeoRoute> QGeoRouteReply::routes() const
{
return d_ptr->routes;
}
/*!
Sets the list of routes in the reply to \a routes.
*/
void QGeoRouteReply::setRoutes(const QList<QGeoRoute> &routes)
{
d_ptr->routes = routes;
}
/*!
Appends the list of \a routes to the existing list.
*/
void QGeoRouteReply::addRoutes(const QList<QGeoRoute> &routes)
{
d_ptr->routes.append(routes);
}
/*!
\fn void QGeoRouteReply::aborted()
\since 5.9
This signal is emitted when the operation has been cancelled.
\sa abort()
*/
/*!
Cancels the operation immediately.
This will do nothing if the reply is finished.
*/
void QGeoRouteReply::abort()
{
emit aborted();
}
/*!
\fn void QGeoRouteReply::finished()
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.
*/
/*!
\fn void QGeoRouteReply::error(QGeoRouteReply::Error error, const QString &errorString)
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 \a error. If \a 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.
\note Do not delete this reply object in the slot connected to this
signal. Use deleteLater() instead.
*/
/*******************************************************************************
*******************************************************************************/
QGeoRouteReplyPrivate::QGeoRouteReplyPrivate(const QGeoRouteRequest &request)
: error(QGeoRouteReply::NoError),
isFinished(false),
request(request) {}
QGeoRouteReplyPrivate::QGeoRouteReplyPrivate(QGeoRouteReply::Error error, QString errorString)
: error(error),
errorString(errorString),
isFinished(true) {}
QGeoRouteReplyPrivate::~QGeoRouteReplyPrivate() {}
QT_END_NAMESPACE
|
