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

10
#pragma once
11 12 13 14 15

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

16
#include "QGCToolbox.h"
17

dogmaphobic's avatar
dogmaphobic committed
18
class Vehicle;
19
class UASInterface;
20
class UASMessageHandler;
21
class QGCApplication;
22 23

/*!
24
 * @class UASMessage
25 26
 * @brief Message element
 */
27
class UASMessage
28
{
29
    friend class UASMessageHandler;
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
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; }
47 48 49 50
    /**
     * @return true: This message is a of a severity which is considered an error
     */
    bool severityIsError();
51

52
private:
53
    UASMessage(int componentid, int severity, QString text);
54 55 56 57 58 59 60
    void _setFormatedText(const QString formatedText) { _formatedText = formatedText; }
    int _compId;
    int _severity;
    QString _text;
    QString _formatedText;
};

61
class UASMessageHandler : public QGCTool
62 63
{
    Q_OBJECT
dogmaphobic's avatar
dogmaphobic committed
64

65
public:
66
    explicit UASMessageHandler(QGCApplication* app, QGCToolbox* toolbox);
67
    ~UASMessageHandler();
68

69 70 71 72 73 74 75 76 77 78 79
    /**
     * @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
     */
80
    const QVector<UASMessage*>& messages() { return _messages; }
81 82 83 84
    /**
     * @brief Clear messages
     */
    void clearMessages();
dogmaphobic's avatar
dogmaphobic committed
85 86 87 88
    /**
     * @brief Get error message count (Resets count once read)
     */
    int getErrorCount();
89 90 91 92
    /**
     * @brief Get error message count (never reset)
     */
    int getErrorCountTotal();
dogmaphobic's avatar
dogmaphobic committed
93 94 95 96 97 98 99 100
    /**
     * @brief Get warning message count (Resets count once read)
     */
    int getWarningCount();
    /**
     * @brief Get normal message count (Resets count once read)
     */
    int getNormalCount();
101 102 103 104
    /**
     * @brief Get latest error message
     */
    QString getLatestError()   { return _latestError; }
dogmaphobic's avatar
dogmaphobic committed
105

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

109 110 111
    // Override from QGCTool
    virtual void setToolbox(QGCToolbox *toolbox);

112 113 114 115 116 117 118 119 120
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
121

122 123 124 125 126
signals:
    /**
     * @brief Sent out when new message arrives
     * @param message A pointer to the message. NULL if resetting (new UAS assigned)
     */
127
    void textMessageReceived(UASMessage* message);
dogmaphobic's avatar
dogmaphobic committed
128 129 130 131 132
    /**
     * @brief Sent out when the message count changes
     * @param count The new message count
     */
    void textMessageCountChanged(int count);
dogmaphobic's avatar
dogmaphobic committed
133

134 135
private slots:
    void _activeVehicleChanged(Vehicle* vehicle);
dogmaphobic's avatar
dogmaphobic committed
136

137
private:
138
    Vehicle*                _activeVehicle;
Lorenz Meier's avatar
Lorenz Meier committed
139 140
    int                     _activeComponent;
    bool                    _multiComp;
141 142 143 144 145 146 147 148 149
    QVector<UASMessage*>    _messages;
    QMutex                  _mutex;
    int                     _errorCount;
    int                     _errorCountTotal;
    int                     _warningCount;
    int                     _normalCount;
    QString                 _latestError;
    bool                    _showErrorsInToolbar;
    MultiVehicleManager*    _multiVehicleManager;
150 151
};