UASMessageHandler.h 4.83 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
/*=====================================================================

QGroundControl Open Source Ground Control Station

(c) 2009 - 2011 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/>.

======================================================================*/

/*!
 * @file
 *   @brief Message Handler
 *   @author Gus Grubba <mavlink@grubba.com>
 */

#ifndef QGCMESSAGEHANDLER_H
#define QGCMESSAGEHANDLER_H

#include <QObject>
#include <QVector>
#include <QMutex>

37
#include "Vehicle.h"
38
#include "QGCToolbox.h"
39

dogmaphobic's avatar
dogmaphobic committed
40
class Vehicle;
41
class UASInterface;
42
class UASMessageHandler;
43
class QGCApplication;
44 45

/*!
46
 * @class UASMessage
47 48
 * @brief Message element
 */
49
class UASMessage
50
{
51
    friend class UASMessageHandler;
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
public:
    /**
     * @brief Get message source component ID
     */
    int getComponentID()        { return _compId; }
    /**
     * @brief Get message severity (from MAV_SEVERITY_XXX enum)
     */
    int getSeverity()           { return _severity; }
    /**
     * @brief Get message text (e.g. "[pm] sending list")
     */
    QString getText()           { return _text; }
    /**
     * @brief Get (html) formatted text (in the form: "[11:44:21.137 - COMP:50] Info: [pm] sending list")
     */
    QString getFormatedText()   { return _formatedText; }
69 70 71 72
    /**
     * @return true: This message is a of a severity which is considered an error
     */
    bool severityIsError();
73

74
private:
75
    UASMessage(int componentid, int severity, QString text);
76 77 78 79 80 81 82
    void _setFormatedText(const QString formatedText) { _formatedText = formatedText; }
    int _compId;
    int _severity;
    QString _text;
    QString _formatedText;
};

83
class UASMessageHandler : public QGCTool
84 85
{
    Q_OBJECT
dogmaphobic's avatar
dogmaphobic committed
86

87
public:
88
    explicit UASMessageHandler(QGCApplication* app);
89
    ~UASMessageHandler();
90

91 92 93 94 95 96 97 98 99 100 101
    /**
     * @brief Locks access to the message list
     */
    void lockAccess()   {_mutex.lock(); }
    /**
     * @brief Unlocks access to the message list
     */
    void unlockAccess() {_mutex.unlock(); }
    /**
     * @brief Access to the message list
     */
102
    const QVector<UASMessage*>& messages() { return _messages; }
103 104 105 106
    /**
     * @brief Clear messages
     */
    void clearMessages();
dogmaphobic's avatar
dogmaphobic committed
107 108 109 110
    /**
     * @brief Get error message count (Resets count once read)
     */
    int getErrorCount();
111 112 113 114
    /**
     * @brief Get error message count (never reset)
     */
    int getErrorCountTotal();
dogmaphobic's avatar
dogmaphobic committed
115 116 117 118 119 120 121 122
    /**
     * @brief Get warning message count (Resets count once read)
     */
    int getWarningCount();
    /**
     * @brief Get normal message count (Resets count once read)
     */
    int getNormalCount();
123 124 125 126
    /**
     * @brief Get latest error message
     */
    QString getLatestError()   { return _latestError; }
dogmaphobic's avatar
dogmaphobic committed
127

128 129
    /// Begin to show message which are errors in the toolbar
    void showErrorsInToolbar(void) { _showErrorsInToolbar = true; }
dogmaphobic's avatar
dogmaphobic committed
130

131 132 133
    // Override from QGCTool
    virtual void setToolbox(QGCToolbox *toolbox);

134 135 136 137 138 139 140 141 142
public slots:
    /**
     * @brief Handle text message from current active UAS
     * @param uasid UAS Id
     * @param componentid Component Id
     * @param severity Message severity
     * @param text Message Text
     */
    void handleTextMessage(int uasid, int componentid, int severity, QString text);
dogmaphobic's avatar
dogmaphobic committed
143

144 145 146 147 148
signals:
    /**
     * @brief Sent out when new message arrives
     * @param message A pointer to the message. NULL if resetting (new UAS assigned)
     */
149
    void textMessageReceived(UASMessage* message);
dogmaphobic's avatar
dogmaphobic committed
150 151 152 153 154
    /**
     * @brief Sent out when the message count changes
     * @param count The new message count
     */
    void textMessageCountChanged(int count);
dogmaphobic's avatar
dogmaphobic committed
155

156 157
private slots:
    void _activeVehicleChanged(Vehicle* vehicle);
dogmaphobic's avatar
dogmaphobic committed
158

159
private:
160
    UASInterface*           _activeUAS;
Lorenz Meier's avatar
Lorenz Meier committed
161 162
    int                     _activeComponent;
    bool                    _multiComp;
163 164 165 166 167 168 169 170 171
    QVector<UASMessage*>    _messages;
    QMutex                  _mutex;
    int                     _errorCount;
    int                     _errorCountTotal;
    int                     _warningCount;
    int                     _normalCount;
    QString                 _latestError;
    bool                    _showErrorsInToolbar;
    MultiVehicleManager*    _multiVehicleManager;
172 173 174
};

#endif // QGCMESSAGEHANDLER_H