1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtPositioning module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 #ifndef QGEOPOSITIONINFO_H
40 #define QGEOPOSITIONINFO_H
41 
42 #include <QtPositioning/QGeoCoordinate>
43 
44 #include <QtCore/QDateTime>
45 
46 QT_BEGIN_NAMESPACE
47 
48 class QDebug;
49 class QDataStream;
50 
51 class QGeoPositionInfoPrivate;
52 class Q_POSITIONING_EXPORT QGeoPositionInfo
53 {
54 public:
55     enum Attribute {
56         Direction,
57         GroundSpeed,
58         VerticalSpeed,
59         MagneticVariation,
60         HorizontalAccuracy,
61         VerticalAccuracy
62     };
63 
64     QGeoPositionInfo();
65     QGeoPositionInfo(const QGeoCoordinate &coordinate, const QDateTime &updateTime);
66     QGeoPositionInfo(const QGeoPositionInfo &other);
67     QGeoPositionInfo(QGeoPositionInfoPrivate &dd);
68     ~QGeoPositionInfo();
69 
70     QGeoPositionInfo &operator=(const QGeoPositionInfo &other);
71 
72     bool operator==(const QGeoPositionInfo &other) const;
73     inline bool operator!=(const QGeoPositionInfo &other) const {
74         return !operator==(other);
75     }
76 
77     bool isValid() const;
78 
79     void setTimestamp(const QDateTime &timestamp);
80     QDateTime timestamp() const;
81 
82     void setCoordinate(const QGeoCoordinate &coordinate);
83     QGeoCoordinate coordinate() const;
84 
85     void setAttribute(Attribute attribute, qreal value);
86     qreal attribute(Attribute attribute) const;
87     void removeAttribute(Attribute attribute);
88     bool hasAttribute(Attribute attribute) const;
89 
90 private:
91 #ifndef QT_NO_DEBUG_STREAM
92     friend Q_POSITIONING_EXPORT QDebug operator<<(QDebug dbg, const QGeoPositionInfo &info);
93 #endif
94 #ifndef QT_NO_DATASTREAM
95     friend Q_POSITIONING_EXPORT QDataStream &operator<<(QDataStream &stream, const QGeoPositionInfo &info);
96     friend Q_POSITIONING_EXPORT QDataStream &operator>>(QDataStream &stream, QGeoPositionInfo &info);
97 #endif
98     QGeoPositionInfoPrivate *d;
99     friend class QGeoPositionInfoPrivate;
100 };
101 
102 #ifndef QT_NO_DEBUG_STREAM
103 Q_POSITIONING_EXPORT QDebug operator<<(QDebug dbg, const QGeoPositionInfo &info);
104 #endif
105 
106 #ifndef QT_NO_DATASTREAM
107 Q_POSITIONING_EXPORT QDataStream &operator<<(QDataStream &stream, QGeoPositionInfo::Attribute attr);
108 Q_POSITIONING_EXPORT QDataStream &operator>>(QDataStream &stream, QGeoPositionInfo::Attribute &attr);
109 Q_POSITIONING_EXPORT QDataStream &operator<<(QDataStream &stream, const QGeoPositionInfo &info);
110 Q_POSITIONING_EXPORT QDataStream &operator>>(QDataStream &stream, QGeoPositionInfo &info);
111 #endif
112 
113 QT_END_NAMESPACE
114 
115 Q_DECLARE_METATYPE(QGeoPositionInfo)
116 
117 #endif
118