QGCApplication.h 6.87 KB
Newer Older
pixhawk's avatar
pixhawk committed
1
/*=====================================================================
Don Gagne's avatar
Don Gagne committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 
 QGroundControl Open Source Ground Control Station
 
 (c) 2009 - 2015 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
 
 This file is part of the QGROUNDCONTROL project
 
 QGROUNDCONTROL is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.
 
 QGROUNDCONTROL is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
 
 ======================================================================*/
pixhawk's avatar
pixhawk committed
23 24 25

/**
 * @file
26
 *   @brief Definition of main class
pixhawk's avatar
pixhawk committed
27 28 29 30 31
 *
 *   @author Lorenz Meier <mavteam@student.ethz.ch>
 *
 */

Don Gagne's avatar
Don Gagne committed
32 33
#ifndef QGCAPPLICATION_H
#define QGCAPPLICATION_H
pixhawk's avatar
pixhawk committed
34 35 36

#include <QApplication>

Don Gagne's avatar
Don Gagne committed
37 38
#include "LinkConfiguration.h"

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

43 44 45
// Work around circular header includes
class QGCSingleton;
class MainWindow;
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.
 *
 **/
Don Gagne's avatar
Don Gagne committed
54
class QGCApplication : public QApplication
pixhawk's avatar
pixhawk committed
55
{
56
    Q_OBJECT
Don Gagne's avatar
Don Gagne committed
57
    
pixhawk's avatar
pixhawk committed
58
public:
Don Gagne's avatar
Don Gagne committed
59
    QGCApplication(int &argc, char* argv[], bool unitTesting);
Don Gagne's avatar
Don Gagne committed
60
    ~QGCApplication();
61
    
Don Gagne's avatar
Don Gagne committed
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
    /// @brief Sets the persistent flag to delete all settings the next time QGroundControl is started.
    void deleteAllSettingsNextBoot(void);
    
    /// @brief Clears the persistent flag to delete all settings the next time QGroundControl is started.
    void clearDeleteAllSettingsNextBoot(void);
    
    /// @brief Returns the location of user visible saved file associated with QGroundControl
    QString savedFilesLocation(void);
    
    /// @brief Sets the location of user visible saved file associated with QGroundControl
    void setSavedFilesLocation(QString& location);
    
    /// @brief Location to save and load parameter files from.
    QString savedParameterFilesLocation(void);
    
    /// @brief Location to save and load mavlink log files from
    QString mavlinkLogFilesLocation(void);
    
    /// @brief Validates that the specified location will work for the saved files location.
    bool validatePossibleSavedFilesLocation(QString& location);
    
    /// @brief Returns true is all mavlink connections should be logged
    bool promptFlightDataSave(void);
    
    /// @brief Sets the flag to log all mavlink connections
    void setPromptFlightDataSave(bool promptForSave);
88

Don Gagne's avatar
Don Gagne committed
89 90 91
    /// @brief Returns truee if unit test are being run
    bool runningUnitTests(void) { return _runningUnitTests; }
    
92 93 94 95 96 97
    /// @return true: dark ui style, false: light ui style
    bool styleIsDark(void) { return _styleIsDark; }
    
    /// Set the current UI style
    void setStyle(bool styleIsDark);
    
Don Gagne's avatar
Don Gagne committed
98 99 100
    /// Disconnects the current link and waits for the specified number of seconds before reconnecting.
    void reconnectAfterWait(int waitSeconds);
    
101 102 103 104
    /// Used to shutdown the app if a fatal condition occurs from which it cannot recover
    ///     @param panicMessage Message to display to user
    void panicShutdown(const QString& panicMessage);
    
105 106 107 108 109 110 111 112 113 114 115 116 117 118
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);
    
    /// You can connect to this slot to show a warning message box from a different thread.
    void warningMessageBoxOnMainThread(const QString& title, const QString& msg);
    
    /// You can connect to this slot to show a critical message box from a different thread.
    void criticalMessageBoxOnMainThread(const QString& title, const QString& msg);
    
    /// Save the specified Flight Data Log
    void saveTempFlightDataLogOnMainThread(QString tempLogfile);
    
signals:
119 120 121 122
    /// Signals that the style has changed
    ///     @param darkStyle true: dark style, false: light style
    void styleChanged(bool darkStyle);
    
123 124 125 126
    /// This is connected to MAVLinkProtocol::checkForLostLogFiles. We signal this to ourselves to call the slot
    /// on the MAVLinkProtocol thread;
    void checkForLostLogFiles(void);
    
127
public:
128 129
    // Although public, these methods are internal and should only be called by UnitTest code
    
130 131 132 133 134 135 136
    /// @brief Perform initialize which is common to both normal application running and unit tests.
    ///         Although public should only be called by main.
    void _initCommon(void);

    /// @brief Intialize the application for normal application boot. Or in other words we are not going to run
    ///         unit tests. Although public should only be called by main.
    bool _initForNormalAppBoot(void);
Don Gagne's avatar
Don Gagne committed
137
    
138 139 140
    /// @brief Intialize the application for normal application boot. Or in other words we are not going to run
    ///         unit tests. Although public should only be called by main.
    bool _initForUnitTests(void);
Don Gagne's avatar
Don Gagne committed
141
    
142
    static QGCApplication*  _app;   ///< Our own singleton. Should be reference directly by qgcApp
Don Gagne's avatar
Don Gagne committed
143
    
Don Gagne's avatar
Don Gagne committed
144 145 146
private slots:
    void _reconnect(void);
    
pixhawk's avatar
pixhawk committed
147
private:
148
    void _createSingletons(void);
Don Gagne's avatar
Don Gagne committed
149
    void _destroySingletons(void);
150
    void _loadCurrentStyle(void);
Don Gagne's avatar
Don Gagne committed
151 152 153 154 155
    
    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
    static const char* _savedFilesLocationKey;          ///< Settings key for user visible saved files location
    static const char* _promptFlightDataSave;           ///< Settings key to prompt for saving Flight Data Log for all flights
156
    static const char* _styleKey;                       ///< Settings key for UI style
Don Gagne's avatar
Don Gagne committed
157 158 159 160
    
    static const char* _defaultSavedFileDirectoryName;      ///< Default name for user visible save file directory
    static const char* _savedFileMavlinkLogDirectoryName;   ///< Name of mavlink log subdirectory
    static const char* _savedFileParameterDirectoryName;    ///< Name of parameter subdirectory
161
    
Don Gagne's avatar
Don Gagne committed
162
    bool _runningUnitTests; ///< true: running unit tests, false: normal app
Don Gagne's avatar
Don Gagne committed
163
    
164 165 166 167
    static const char*  _darkStyleFile;
    static const char*  _lightStyleFile;
    bool                _styleIsDark;      ///< true: dark style, false: light style
    
Don Gagne's avatar
Don Gagne committed
168 169
    LinkConfiguration* _reconnectLinkConfig;    ///< Configuration to reconnect for reconnectAfterWai
    
Don Gagne's avatar
Don Gagne committed
170 171
    /// Unit Test have access to creating and destroying singletons
    friend class UnitTest;
pixhawk's avatar
pixhawk committed
172 173
};

Don Gagne's avatar
Don Gagne committed
174 175 176 177
/// @brief Returns the QGCApplication object singleton.
QGCApplication* qgcApp(void);

#endif