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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtPositioning module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include <QGeoAreaMonitorInfo>
#include <QDateTime>
#include <QSharedData>
#include <QUuid>
#include <QDataStream>
#ifndef QT_NO_DEBUG_STREAM
#include <QDebug>
#endif
QT_BEGIN_NAMESPACE
/*!
\class QGeoAreaMonitorInfo
\inmodule QtPositioning
\since 5.2
\ingroup QtPositioning-positioning
\brief The QGeoAreaMonitorInfo class describes the parameters of an area or region
to be monitored for proximity.
The purpose of area monitoring is to inform a user when he/she comes close to an area of
interest. In general such an area is described by a \l QGeoCircle. The circle's center
represents the place of interest and the area around it identifies the geographical region
within which notifications are sent.
A QGeoAreaMonitorInfo object is valid if it has a non-empty name and a valid \l area().
Such objects must be registered with a \l QGeoAreaMonitorSource to start and stop the
monitoring process. Note that extensive monitoring can be very resource consuming
because the positioning engine must remain active and has to match the current position
with each QGeoAreaMonitorInfo instance.
To further reduce the burden on the system there are optional attributes which can
set. Each monitored area can have an expiry date which automatically removes the
to-be-monitored area from the monitoring source once the expiry date has been reached.
Another option is to adjust the persistence of a monitored area. A QGeoAreaMonitorInfo
that \l isPersistent() will remain active beyond
the current applications lifetime. If an area is entered while the monitoring
application is not running the application will be started. Note that this feature is
not available on all platforms. Its availability can be checked via
\l QGeoAreaMonitorSource::supportedAreaMonitorFeatures().
\sa QGeoAreaMonitorSource
*/
class QGeoAreaMonitorInfoPrivate : public QSharedData
{
public:
QGeoAreaMonitorInfoPrivate() : QSharedData(), persistent(false) {}
QGeoAreaMonitorInfoPrivate(const QGeoAreaMonitorInfoPrivate &other)
: QSharedData(other)
{
uid = other.uid;
name = other.name;
shape = other.shape;
persistent = other.persistent;
notificationParameters = other.notificationParameters;
expiry = other.expiry;
}
~QGeoAreaMonitorInfoPrivate() {}
QUuid uid;
QString name;
QGeoShape shape;
bool persistent;
QVariantMap notificationParameters;
QDateTime expiry;
};
/*!
Constructs a QGeoAreaMonitorInfo object with the specified \a name.
\sa name()
*/
QGeoAreaMonitorInfo::QGeoAreaMonitorInfo(const QString &name)
{
d = new QGeoAreaMonitorInfoPrivate;
d->name = name;
d->uid = QUuid::createUuid();
}
/*!
Constructs a QGeoAreaMonitorInfo object as a copy of \a other.
*/
QGeoAreaMonitorInfo::QGeoAreaMonitorInfo(const QGeoAreaMonitorInfo &other)
: d(other.d)
{
}
/*!
Destructor
*/
QGeoAreaMonitorInfo::~QGeoAreaMonitorInfo()
{
}
/*!
Assigns \a other to this QGeoAreaMonitorInfo object and returns a reference
to this QGeoAreaMonitorInfo object.
*/
QGeoAreaMonitorInfo &QGeoAreaMonitorInfo::operator=(const QGeoAreaMonitorInfo &other)
{
d = other.d;
return *this;
}
/*!
Returns true if all of this object's values are the same as those of
\a other.
*/
bool QGeoAreaMonitorInfo::operator==(const QGeoAreaMonitorInfo &other) const
{
return (d->name == other.d->name &&
d->uid == other.d->uid &&
d->shape == other.d->shape &&
d->persistent == other.d->persistent &&
d->expiry == other.d->expiry &&
d->notificationParameters == other.d->notificationParameters);
}
/*!
Returns true if any of this object's values are not the same as those of
\a other.
*/
bool QGeoAreaMonitorInfo::operator!=(const QGeoAreaMonitorInfo &other) const
{
return !QGeoAreaMonitorInfo::operator ==(other);
}
/*!
Returns the name of the QGeoAreaMonitorInfo object. The name should be used to
for user-visibility purposes.
*/
QString QGeoAreaMonitorInfo::name() const
{
return d->name;
}
/*!
Sets the user visibile \a name.
*/
void QGeoAreaMonitorInfo::setName(const QString &name)
{
if (d->name != name)
d->name = name;
}
/*!
Returns the identifier of the QGeoAreaMonitorInfo object.
The identifier is automatically generated upon construction of a new
QGeoAreaMonitorInfo object.
*/
QString QGeoAreaMonitorInfo::identifier() const
{
return d->uid.toString();
}
/*!
Returns true, if the monitor is valid. A valid QGeoAreaMonitorInfo has a non-empty name()
and the monitored area is not \l {QGeoShape::isEmpty()}{empty()}.
Otherwise this function returns false.
*/
bool QGeoAreaMonitorInfo::isValid() const
{
return (!d->name.isEmpty() && !d->shape.isEmpty());
}
/*!
Returns the boundaries of the to-be-monitored area. This area must not be empty.
\sa setArea()
*/
QGeoShape QGeoAreaMonitorInfo::area() const
{
return d->shape;
}
/*!
Sets the to-be-monitored area to \a newShape.
\sa area()
*/
void QGeoAreaMonitorInfo::setArea(const QGeoShape &newShape)
{
d->shape = newShape;
}
/*!
Returns the expiry date.
After an active QGeoAreaMonitorInfo has expired the region is no longer monitored
and the QGeoAreaMonitorInfo object is removed from the list of
\l {QGeoAreaMonitorSource::activeMonitors()}{active monitors}.
If the expiry \l QDateTime is invalid the QGeoAreaMonitorInfo object is treated as not having
an expiry date. This implies an indefinite monitoring period if the object is persistent or
until the current application closes if the object is non-persistent.
\sa QGeoAreaMonitorSource::activeMonitors()
*/
QDateTime QGeoAreaMonitorInfo::expiration() const
{
return d->expiry;
}
/*!
Sets the expiry date and time to \a expiry.
*/
void QGeoAreaMonitorInfo::setExpiration(const QDateTime &expiry)
{
d->expiry = expiry;
}
/*!
Returns true if the QGeoAreaMonitorInfo is persistent.
The default value for this property is false.
A non-persistent QGeoAreaMonitorInfo will be removed by the system once
the application owning the monitor object stops. Persistent objects remain
active and can be retrieved once the application restarts.
If the system triggers an event associated to a persistent QGeoAreaMonitorInfo
the relevant application will be re-started and the appropriate signal emitted.
\sa setPersistent()
*/
bool QGeoAreaMonitorInfo::isPersistent() const
{
return d->persistent;
}
/*!
Sets the QGeoAreaMonitorInfo objects persistence to \a isPersistent.
Note that setting this flag does not imply that QGeoAreaMonitorInfoSource supports persistent
monitoring. \l QGeoAreaMonitorSource::supportedAreaMonitorFeatures() can be used to
check for this feature's availability.
\sa isPersistent()
*/
void QGeoAreaMonitorInfo::setPersistent(bool isPersistent)
{
d->persistent = isPersistent;
}
/*!
Returns the set of platform specific paraemters used by this QGeoAreaMonitorInfo.
\sa setNotificationParameters()
*/
QVariantMap QGeoAreaMonitorInfo::notificationParameters() const
{
return d->notificationParameters;
}
/*!
Sets the set of platform specific \a parameters used by QGeoAreaMonitorInfo.
\sa notificationParameters()
*/
void QGeoAreaMonitorInfo::setNotificationParameters(const QVariantMap ¶meters)
{
d->notificationParameters = parameters;
}
#ifndef QT_NO_DATASTREAM
/*!
\fn QDataStream &operator<<(QDataStream &stream, const QGeoAreaMonitorInfo &monitor)
\relates QGeoAreaMonitorInfo
Writes the given \a monitor to the specified \a stream.
\sa {Serializing Qt Data Types}
*/
QDataStream &operator<<(QDataStream &ds, const QGeoAreaMonitorInfo &monitor)
{
ds << monitor.name() << monitor.d->uid << monitor.area()
<< monitor.isPersistent() << monitor.notificationParameters() << monitor.expiration();
return ds;
}
/*!
\fn QDataStream &operator>>(QDataStream &stream, QGeoAreaMonitorInfo &monitor)
\relates QGeoAreaMonitorInfo
Reads a area monitoring data from the specified \a stream into the given
\a monitor.
\sa {Serializing Qt Data Types}
*/
QDataStream &operator>>(QDataStream &ds, QGeoAreaMonitorInfo &monitor)
{
QString s;
ds >> s;
monitor = QGeoAreaMonitorInfo(s);
QUuid id;
ds >> id;
monitor.d->uid = id;
QGeoShape shape;
ds >> shape;
monitor.setArea(shape);
bool persistent;
ds >> persistent;
monitor.setPersistent(persistent);
QVariantMap map;
ds >> map;
monitor.setNotificationParameters(map);
QDateTime dt;
ds >> dt;
monitor.setExpiration(dt);
return ds;
}
#endif
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QGeoAreaMonitorInfo &monitor)
{
QDebugStateSaver saver(dbg);
dbg.nospace() << "QGeoAreaMonitorInfo(\"" << qPrintable(monitor.name())
<< "\", " << monitor.area()
<< ", persistent: " << monitor.isPersistent()
<< ", expiry: " << monitor.expiration() << ")";
return dbg;
}
#endif
QT_END_NAMESPACE
|