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 QGEOSATELLITEINFOSOURCE_H
40#define QGEOSATELLITEINFOSOURCE_H
41
42#include <QtPositioning/QGeoSatelliteInfo>
43
44#include <QtCore/QObject>
45#include <QtCore/QList>
46
47QT_BEGIN_NAMESPACE
48
49class QGeoSatelliteInfoSourcePrivate;
50class Q_POSITIONING_EXPORT QGeoSatelliteInfoSource : public QObject
51{
52 Q_OBJECT
53 Q_PROPERTY(int updateInterval READ updateInterval WRITE setUpdateInterval)
54 Q_PROPERTY(int minimumUpdateInterval READ minimumUpdateInterval)
55
56public:
57 enum Error {
58 AccessError = 0,
59 ClosedError = 1,
60 NoError = 2,
61 UnknownSourceError = -1
62 };
63 Q_ENUMS(Error)
64
65 explicit QGeoSatelliteInfoSource(QObject *parent);
66 virtual ~QGeoSatelliteInfoSource();
67
68 static QGeoSatelliteInfoSource *createDefaultSource(QObject *parent);
69 static QGeoSatelliteInfoSource *createSource(const QString &sourceName, QObject *parent);
70 static QGeoSatelliteInfoSource *createDefaultSource(const QVariantMap &parameters, QObject *parent);
71 static QGeoSatelliteInfoSource *createSource(const QString &sourceName, const QVariantMap &parameters, QObject *parent);
72 static QStringList availableSources();
73
74 QString sourceName() const;
75
76 virtual void setUpdateInterval(int msec);
77 int updateInterval() const;
78 virtual int minimumUpdateInterval() const = 0;
79 virtual Error error() const = 0;
80
81public Q_SLOTS:
82 virtual void startUpdates() = 0;
83 virtual void stopUpdates() = 0;
84
85 virtual void requestUpdate(int timeout = 0) = 0;
86
87Q_SIGNALS:
88 void satellitesInViewUpdated(const QList<QGeoSatelliteInfo> &satellites);
89 void satellitesInUseUpdated(const QList<QGeoSatelliteInfo> &satellites);
90 void requestTimeout();
91 void error(QGeoSatelliteInfoSource::Error);
92
93protected:
94 explicit QGeoSatelliteInfoSource(QGeoSatelliteInfoSourcePrivate &dd, QObject *parent);
95
96private:
97 Q_DISABLE_COPY(QGeoSatelliteInfoSource)
98 QGeoSatelliteInfoSourcePrivate *d;
99 friend class QGeoSatelliteInfoSourcePrivate;
100};
101
102QT_END_NAMESPACE
103
104#endif
105

source code of qtlocation/src/positioning/qgeosatelliteinfosource.h