QGCApplication.h 7.72 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>
pixhawk's avatar
pixhawk committed
25

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

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

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

pixhawk's avatar
pixhawk committed
47 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.
 *
 **/
Gus Grubba's avatar
Gus Grubba committed
54
class QGCApplication : public QGuiApplication
pixhawk's avatar
pixhawk committed
55
{
56
    Q_OBJECT
dogmaphobic's avatar
dogmaphobic committed
57

pixhawk's avatar
pixhawk committed
58
public:
DonLakeFlyer's avatar
DonLakeFlyer committed
59
    QGCApplication(int &argc, char* argv[], bool unitTesting);
Don Gagne's avatar
Don Gagne committed
60
    ~QGCApplication();
dogmaphobic's avatar
dogmaphobic committed
61

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

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

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

71 72 73
    /// @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
74
    /// Used to report a missing Parameter. Warning will be displayed to user. Method may be called
75
    /// multiple times.
Don Gagne's avatar
Don Gagne committed
76
    void reportMissingParameter(int componentId, const QString& name);
77

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

dogmaphobic's avatar
dogmaphobic committed
81 82 83
    /// @return true: Fake ui into showing mobile interface
    bool fakeMobile(void) { return _fakeMobile; }

84 85
    // Still working on getting rid of this and using dependency injection instead for everything
    QGCToolbox* toolbox(void) { return _toolbox; }
dogmaphobic's avatar
dogmaphobic committed
86 87 88 89

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

90 91 92
    /// Is Internet available?
    bool isInternetAvailable();

93 94
    FactGroup* gpsRtkFactGroup(void)  { return _gpsRtkFactGroup; }

95 96 97
    static QString cachedParameterMetaDataFile(void);
    static QString cachedAirframeMetaDataFile(void);

98
    void            setLanguage();
99
    QQuickItem*     mainRootWindow();
100

101 102 103
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
104

105 106
    /// 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
107

108 109
    /// 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
110

111
    void showSetupView();
Don Gagne's avatar
Don Gagne committed
112

113
    void qmlAttemptWindowClose();
Don Gagne's avatar
Don Gagne committed
114

115 116 117 118
    /// Save the specified telemetry Log
    void saveTelemetryLogOnMainThread(QString tempLogfile);

    /// Check that the telemetry save path is set correctly
119
    void checkTelemetrySavePathOnMainThread();
120

121 122 123
    /// Get current language
    const QLocale getCurrentLanguage() { return _locale; }

124 125 126
signals:
    /// This is connected to MAVLinkProtocol::checkForLostLogFiles. We signal this to ourselves to call the slot
    /// on the MAVLinkProtocol thread;
127 128 129
    void checkForLostLogFiles   ();

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

131
public:
132
    // Although public, these methods are internal and should only be called by UnitTest code
dogmaphobic's avatar
dogmaphobic committed
133

134 135
    /// @brief Perform initialize which is common to both normal application running and unit tests.
    ///         Although public should only be called by main.
136
    void _initCommon();
137

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

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

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

148 149
    bool    isErrorState()  { return _error; }

Don Gagne's avatar
Don Gagne committed
150 151 152 153
public:
    // Although public, these methods are internal and should only be called by UnitTest code

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

156 157
    bool _checkTelemetrySavePath(bool useMessageBox);

Don Gagne's avatar
Don Gagne committed
158
private slots:
Don Gagne's avatar
Don Gagne committed
159
    void _missingParamsDisplay(void);
Don Gagne's avatar
Don Gagne committed
160 161 162
    void _currentVersionDownloadFinished(QString remoteFile, QString localFile);
    void _currentVersionDownloadError(QString errorMsg);
    bool _parseVersionText(const QString& versionString, int& majorVersion, int& minorVersion, int& buildVersion);
163 164 165 166
    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
167

pixhawk's avatar
pixhawk committed
168
private:
169 170
    QObject*    _rootQmlObject          ();
    void        _checkForNewVersion     ();
171
    void        _exitWithError          (QString errorMessage);
Don Gagne's avatar
Don Gagne committed
172

dogmaphobic's avatar
dogmaphobic committed
173

Gus Grubba's avatar
Gus Grubba committed
174
    bool                _runningUnitTests;                                  ///< true: running unit tests, false: normal app
175 176 177
    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
    QStringList         _missingParams;                                     ///< List of missing facts to be displayed
178

179 180 181 182 183 184 185 186 187 188
    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;
189
    QQuickItem*         _mainRootWindow         = nullptr;
190 191
    bool                _bluetoothAvailable     = false;
    QTranslator         _QGCTranslator;
192
    QTranslator         _QGCTranslatorQt;
193
    QLocale             _locale;
194
    bool                _error                  = false;
dogmaphobic's avatar
dogmaphobic committed
195

Don Gagne's avatar
Don Gagne committed
196 197 198
    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
199 200
    /// Unit Test have access to creating and destroying singletons
    friend class UnitTest;
Gus Grubba's avatar
Gus Grubba committed
201

pixhawk's avatar
pixhawk committed
202 203
};

Don Gagne's avatar
Don Gagne committed
204 205 206 207
/// @brief Returns the QGCApplication object singleton.
QGCApplication* qgcApp(void);

#endif