QGCApplication.h 8.13 KB
Newer Older
1 2 3 4 5 6 7 8
/****************************************************************************
 *
 *   (c) 2009-2016 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/
dogmaphobic's avatar
dogmaphobic committed
9

pixhawk's avatar
pixhawk committed
10 11 12

/**
 * @file
13
 *   @brief Definition of main class
pixhawk's avatar
pixhawk committed
14 15 16 17 18
 *
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */

Don Gagne's avatar
Don Gagne committed
19 20
#ifndef QGCAPPLICATION_H
#define QGCAPPLICATION_H
pixhawk's avatar
pixhawk committed
21 22

#include <QApplication>
23
#include <QTimer>
Don Gagne's avatar
Don Gagne committed
24
#include <QQmlApplicationEngine>
25
#include <QElapsedTimer>
pixhawk's avatar
pixhawk committed
26

Don Gagne's avatar
Don Gagne committed
27
#include "LinkConfiguration.h"
28 29 30 31 32 33
#include "LinkManager.h"
#include "MAVLinkProtocol.h"
#include "FlightMapSettings.h"
#include "FirmwarePluginManager.h"
#include "MultiVehicleManager.h"
#include "JoystickManager.h"
34
#include "AudioOutput.h"
35 36
#include "UASMessageHandler.h"
#include "FactSystem.h"
37
#include "GPSRTKFactGroup.h"
Don Gagne's avatar
Don Gagne committed
38

39
#ifdef QGC_RTLAB_ENABLED
40 41
#include "OpalLink.h"
#endif
42

43 44
// Work around circular header includes
class QGCSingleton;
45
class QGCToolbox;
Don Gagne's avatar
Don Gagne committed
46
class QGCFileDownload;
Don Gagne's avatar
Don Gagne committed
47

pixhawk's avatar
pixhawk committed
48 49 50 51 52 53
/**
 * @brief The main application and management class.
 *
 * This class is started by the main method and provides
 * the central management unit of the groundstation application.
 *
54 55 56 57 58 59 60 61 62
 * Needs QApplication base to support QtCharts drawing module and
 * avoid application crashing on 5.12. Enforce no widget on mobile
**/
class QGCApplication :
      #if defined(__mobile__)
        public QGuiApplication
      #else
        public QApplication
      #endif
pixhawk's avatar
pixhawk committed
63
{
64
    Q_OBJECT
dogmaphobic's avatar
dogmaphobic committed
65

pixhawk's avatar
pixhawk committed
66
public:
DonLakeFlyer's avatar
DonLakeFlyer committed
67
    QGCApplication(int &argc, char* argv[], bool unitTesting);
Don Gagne's avatar
Don Gagne committed
68
    ~QGCApplication();
dogmaphobic's avatar
dogmaphobic committed
69

Don Gagne's avatar
Don Gagne committed
70 71
    /// @brief Sets the persistent flag to delete all settings the next time QGroundControl is started.
    void deleteAllSettingsNextBoot(void);
dogmaphobic's avatar
dogmaphobic committed
72

Don Gagne's avatar
Don Gagne committed
73 74
    /// @brief Clears the persistent flag to delete all settings the next time QGroundControl is started.
    void clearDeleteAllSettingsNextBoot(void);
dogmaphobic's avatar
dogmaphobic committed
75

76
    /// @brief Returns true if unit tests are being run
Don Gagne's avatar
Don Gagne committed
77
    bool runningUnitTests(void) { return _runningUnitTests; }
dogmaphobic's avatar
dogmaphobic committed
78

79 80 81
    /// @brief Returns true if Qt debug output should be logged to a file
    bool logOutput(void) { return _logOutput; }

Don Gagne's avatar
Don Gagne committed
82
    /// Used to report a missing Parameter. Warning will be displayed to user. Method may be called
83
    /// multiple times.
Don Gagne's avatar
Don Gagne committed
84
    void reportMissingParameter(int componentId, const QString& name);
85

Don Gagne's avatar
Don Gagne committed
86
    /// Show a non-modal message to the user
87
    void showMessage(const QString& message);
88

dogmaphobic's avatar
dogmaphobic committed
89
    /// @return true: Fake ui into showing mobile interface
90
    bool fakeMobile(void) const { return _fakeMobile; }
dogmaphobic's avatar
dogmaphobic committed
91

92 93
    // Still working on getting rid of this and using dependency injection instead for everything
    QGCToolbox* toolbox(void) { return _toolbox; }
dogmaphobic's avatar
dogmaphobic committed
94 95 96 97

    /// Do we have Bluetooth Support?
    bool isBluetoothAvailable() { return _bluetoothAvailable; }

98 99 100
    /// Is Internet available?
    bool isInternetAvailable();

101 102
    FactGroup* gpsRtkFactGroup(void)  { return _gpsRtkFactGroup; }

103 104 105
    static QString cachedParameterMetaDataFile(void);
    static QString cachedAirframeMetaDataFile(void);

106
    void            setLanguage();
107
    QQuickItem*     mainRootWindow();
108

109 110
    uint64_t        msecsSinceBoot(void) { return _msecsElapsedTime.elapsed(); }

111 112 113
public slots:
    /// You can connect to this slot to show an information message box from a different thread.
    void informationMessageBoxOnMainThread(const QString& title, const QString& msg);
dogmaphobic's avatar
dogmaphobic committed
114

115 116
    /// You can connect to this slot to show a warning message box from a different thread.
    void warningMessageBoxOnMainThread(const QString& title, const QString& msg);
dogmaphobic's avatar
dogmaphobic committed
117

118 119
    /// You can connect to this slot to show a critical message box from a different thread.
    void criticalMessageBoxOnMainThread(const QString& title, const QString& msg);
dogmaphobic's avatar
dogmaphobic committed
120

121
    void showSetupView();
Don Gagne's avatar
Don Gagne committed
122

123
    void qmlAttemptWindowClose();
Don Gagne's avatar
Don Gagne committed
124

125 126 127 128
    /// Save the specified telemetry Log
    void saveTelemetryLogOnMainThread(QString tempLogfile);

    /// Check that the telemetry save path is set correctly
129
    void checkTelemetrySavePathOnMainThread();
130

131 132 133
    /// Get current language
    const QLocale getCurrentLanguage() { return _locale; }

134 135 136
signals:
    /// This is connected to MAVLinkProtocol::checkForLostLogFiles. We signal this to ourselves to call the slot
    /// on the MAVLinkProtocol thread;
137 138 139
    void checkForLostLogFiles   ();

    void languageChanged        (const QLocale locale);
dogmaphobic's avatar
dogmaphobic committed
140

141
public:
142
    // Although public, these methods are internal and should only be called by UnitTest code
dogmaphobic's avatar
dogmaphobic committed
143

144 145
    /// @brief Perform initialize which is common to both normal application running and unit tests.
    ///         Although public should only be called by main.
146
    void _initCommon();
147

Patrick José Pereira's avatar
Patrick José Pereira committed
148
    /// @brief Initialize the application for normal application boot. Or in other words we are not going to run
149
    ///         unit tests. Although public should only be called by main.
150
    bool _initForNormalAppBoot();
dogmaphobic's avatar
dogmaphobic committed
151

Patrick José Pereira's avatar
Patrick José Pereira committed
152
    /// @brief Initialize the application for normal application boot. Or in other words we are not going to run
153
    ///         unit tests. Although public should only be called by main.
154
    bool _initForUnitTests();
Don Gagne's avatar
Don Gagne committed
155

156
    static QGCApplication*  _app;   ///< Our own singleton. Should be reference directly by qgcApp
dogmaphobic's avatar
dogmaphobic committed
157

158 159
    bool    isErrorState()  { return _error; }

Don Gagne's avatar
Don Gagne committed
160 161 162 163
public:
    // Although public, these methods are internal and should only be called by UnitTest code

    /// Shutdown the application object
164
    void _shutdown();
Don Gagne's avatar
Don Gagne committed
165

166 167
    bool _checkTelemetrySavePath(bool useMessageBox);

Don Gagne's avatar
Don Gagne committed
168
private slots:
Don Gagne's avatar
Don Gagne committed
169
    void _missingParamsDisplay(void);
Don Gagne's avatar
Don Gagne committed
170 171 172
    void _currentVersionDownloadFinished(QString remoteFile, QString localFile);
    void _currentVersionDownloadError(QString errorMsg);
    bool _parseVersionText(const QString& versionString, int& majorVersion, int& minorVersion, int& buildVersion);
173 174 175 176
    void _onGPSConnect();
    void _onGPSDisconnect();
    void _gpsSurveyInStatus(float duration, float accuracyMM,  double latitude, double longitude, float altitude, bool valid, bool active);
    void _gpsNumSatellites(int numSatellites);
dogmaphobic's avatar
dogmaphobic committed
177

pixhawk's avatar
pixhawk committed
178
private:
179 180
    QObject*    _rootQmlObject          ();
    void        _checkForNewVersion     ();
181
    void        _exitWithError          (QString errorMessage);
Don Gagne's avatar
Don Gagne committed
182

dogmaphobic's avatar
dogmaphobic committed
183

184 185 186 187
    bool                        _runningUnitTests;                                  ///< true: running unit tests, false: normal app
    static const int            _missingParamsDelayedDisplayTimerTimeout = 1000;    ///< Timeout to wait for next missing fact to come in before display
    QTimer                      _missingParamsDelayedDisplayTimer;                  ///< Timer use to delay missing fact display
    QList<QPair<int,QString>>   _missingParams;                                     ///< List of missing parameter component id:name
188

189 190 191 192 193 194 195 196 197 198
    QQmlApplicationEngine* _qmlAppEngine        = nullptr;
    bool                _logOutput              = false;                    ///< true: Log Qt debug output to file
    bool				_fakeMobile             = false;                    ///< true: Fake ui into displaying mobile interface
    bool                _settingsUpgraded       = false;                    ///< true: Settings format has been upgrade to new version
    int                 _majorVersion           = 0;
    int                 _minorVersion           = 0;
    int                 _buildVersion           = 0;
    QGCFileDownload*    _currentVersionDownload = nullptr;
    GPSRTKFactGroup*    _gpsRtkFactGroup        = nullptr;
    QGCToolbox*         _toolbox                = nullptr;
199
    QQuickItem*         _mainRootWindow         = nullptr;
200 201
    bool                _bluetoothAvailable     = false;
    QTranslator         _QGCTranslator;
202
    QTranslator         _QGCTranslatorQt;
203
    QLocale             _locale;
204
    bool                _error                  = false;
205
    QElapsedTimer       _msecsElapsedTime;
dogmaphobic's avatar
dogmaphobic committed
206

Don Gagne's avatar
Don Gagne committed
207 208 209
    static const char* _settingsVersionKey;             ///< Settings key which hold settings version
    static const char* _deleteAllSettingsKey;           ///< If this settings key is set on boot, all settings will be deleted

Don Gagne's avatar
Don Gagne committed
210 211
    /// Unit Test have access to creating and destroying singletons
    friend class UnitTest;
Gus Grubba's avatar
Gus Grubba committed
212

pixhawk's avatar
pixhawk committed
213 214
};

Don Gagne's avatar
Don Gagne committed
215 216 217 218
/// @brief Returns the QGCApplication object singleton.
QGCApplication* qgcApp(void);

#endif