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

37
#ifdef QGC_RTLAB_ENABLED
38
39
#include "OpalLink.h"
#endif
Don Gagne's avatar
Don Gagne committed
40

Don Gagne's avatar
Don Gagne committed
41
42
43
// Work around circular header includes
class QGCSingleton;
class MainWindow;
Don Gagne's avatar
Don Gagne committed
44

pixhawk's avatar
pixhawk committed
45
46
47
48
49
50
51
/**
 * @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
52
class QGCApplication : public QApplication
pixhawk's avatar
pixhawk committed
53
{
54
    Q_OBJECT
Don Gagne's avatar
Don Gagne committed
55
    
pixhawk's avatar
pixhawk committed
56
public:
Don Gagne's avatar
Don Gagne committed
57
    QGCApplication(int &argc, char* argv[], bool unitTesting);
Don Gagne's avatar
Don Gagne committed
58
    ~QGCApplication();
Don Gagne's avatar
Don Gagne committed
59
    
Don Gagne's avatar
Don Gagne committed
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
    /// @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);
Don Gagne's avatar
Don Gagne committed
86

Don Gagne's avatar
Don Gagne committed
87
88
89
    /// @brief Returns truee if unit test are being run
    bool runningUnitTests(void) { return _runningUnitTests; }
    
90
91
92
93
94
95
    /// @return true: dark ui style, false: light ui style
    bool styleIsDark(void) { return _styleIsDark; }
    
    /// Set the current UI style
    void setStyle(bool styleIsDark);
    
96
97
98
99
100
101
102
103
104
105
106
107
108
109
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:
110
111
112
113
    /// Signals that the style has changed
    ///     @param darkStyle true: dark style, false: light style
    void styleChanged(bool darkStyle);
    
114
115
116
117
    /// This is connected to MAVLinkProtocol::checkForLostLogFiles. We signal this to ourselves to call the slot
    /// on the MAVLinkProtocol thread;
    void checkForLostLogFiles(void);
    
Don Gagne's avatar
Don Gagne committed
118
public:
119
120
    // Although public, these methods are internal and should only be called by UnitTest code
    
Don Gagne's avatar
Don Gagne committed
121
122
123
124
125
126
127
    /// @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
128
    
Don Gagne's avatar
Don Gagne committed
129
130
131
    /// @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
132
    
Don Gagne's avatar
Don Gagne committed
133
    static QGCApplication*  _app;   ///< Our own singleton. Should be reference directly by qgcApp
Don Gagne's avatar
Don Gagne committed
134
    
pixhawk's avatar
pixhawk committed
135
private:
Don Gagne's avatar
Don Gagne committed
136
    void _createSingletons(void);
Don Gagne's avatar
Don Gagne committed
137
    void _destroySingletons(void);
138
    void _loadCurrentStyle(void);
Don Gagne's avatar
Don Gagne committed
139
140
141
142
143
    
    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
144
    static const char* _styleKey;                       ///< Settings key for UI style
Don Gagne's avatar
Don Gagne committed
145
146
147
148
    
    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
Don Gagne's avatar
Don Gagne committed
149
    
Don Gagne's avatar
Don Gagne committed
150
    bool _runningUnitTests; ///< true: running unit tests, false: normal app
Don Gagne's avatar
Don Gagne committed
151
    
152
153
154
155
    static const char*  _darkStyleFile;
    static const char*  _lightStyleFile;
    bool                _styleIsDark;      ///< true: dark style, false: light style
    
Don Gagne's avatar
Don Gagne committed
156
157
    /// Unit Test have access to creating and destroying singletons
    friend class UnitTest;
pixhawk's avatar
pixhawk committed
158
159
};

Don Gagne's avatar
Don Gagne committed
160
161
162
163
/// @brief Returns the QGCApplication object singleton.
QGCApplication* qgcApp(void);

#endif