ground/gcs/src/plugins/logging/loggingplugin.h

   1 /**
   2  ******************************************************************************
   3  * @file       loggingplugin.h
   4  * @author     The LibrePilot Project, http://www.librepilot.org Copyright (C) 2017.
   5  *             The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  * @see        The GNU Public License (GPL) Version 3
   7  * @addtogroup GCSPlugins GCS Plugins
   8  * @{
   9  * @addtogroup loggingplugin
  10  * @{
  11  *****************************************************************************/
  12 /*
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 3 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful, but
  19  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  20  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  21  * for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  26  */
  27
  28 #ifndef LOGGINGPLUGIN_H_
  29 #define LOGGINGPLUGIN_H_
  30
  31 #include <coreplugin/icore.h>
  32 #include <coreplugin/coreconstants.h>
  33 #include <coreplugin/iconnection.h>
  34 #include <extensionsystem/iplugin.h>
  35 #include <utils/logfile.h>
  36
  37 #include <QThread>
  38 #include <QQueue>
  39 #include <QReadWriteLock>
  40
  41 class UAVObject;
  42 class UAVDataObject;
  43 class UAVTalk;
  44 class LoggingPlugin;
  45 class LoggingGadgetFactory;
  46
  47 namespace Core {
  48 class Command;
  49 }
  50
  51 /**
  52  *   Define a connection via the IConnection interface
  53  *   Plugin will add a instance of this class to the pool,
  54  *   so the connection manager can use it.
  55  */
  56 class LoggingConnection : public Core::IConnection {
  57     Q_OBJECT
  58 public:
  59     LoggingConnection();
  60     virtual ~LoggingConnection();
  61
  62     virtual QList <Core::IConnection::device> availableDevices();
  63
  64     virtual QIODevice *openDevice(const QString &deviceName);
  65     virtual void closeDevice(const QString &deviceName);
  66
  67     virtual QString connectionName();
  68     virtual QString shortName();
  69
  70     bool deviceOpened()
  71     {
  72         return m_deviceOpened;
  73     }
  74     LogFile *getLogfile()
  75     {
  76         return &logFile;
  77     }
  78
  79 private:
  80     bool m_deviceOpened;
  81     LogFile logFile;
  82 };
  83
  84 class LoggingThread : public QThread {
  85     Q_OBJECT
  86 public:
  87     LoggingThread();
  88     virtual ~LoggingThread();
  89
  90     bool openFile(QString file);
  91
  92 public slots:
  93     void startLogging();
  94     void stopLogging();
  95
  96 protected:
  97     void run();
  98
  99 private slots:
 100     void objectUpdated(UAVObject *obj);
 101     void transactionCompleted(UAVObject *obj, bool success);
 102
 103 private:
 104     QReadWriteLock lock;
 105     QQueue<UAVDataObject *> queue;
 106     LogFile logFile;
 107     UAVTalk *uavTalk;
 108
 109     void retrieveSettings();
 110     void retrieveNextObject();
 111 };
 112
 113 class LoggingPlugin : public ExtensionSystem::IPlugin {
 114     Q_OBJECT
 115                                               Q_PLUGIN_METADATA(IID "OpenPilot.Logging")
 116
 117     friend class LoggingConnection;
 118
 119 public:
 120     enum State { IDLE, LOGGING, REPLAY };
 121
 122     LoggingPlugin();
 123     ~LoggingPlugin();
 124
 125     void extensionsInitialized();
 126     bool initialize(const QStringList & arguments, QString *errorString);
 127     void shutdown();
 128
 129     LogFile *getLogfile()
 130     {
 131         return logConnection->getLogfile();
 132     }
 133
 134     State getState()
 135     {
 136         return state;
 137     }
 138
 139 signals:
 140     void stateChanged(State);
 141
 142 private slots:
 143     void toggleLogging();
 144     void startLogging(QString file);
 145     void stopLogging();
 146     void loggingStarted();
 147     void loggingStopped();
 148     void replayStarted();
 149     void replayStopped();
 150
 151 private:
 152     Core::Command *loggingCommand;
 153     State state;
 154     // These are used for replay, logging in its own thread
 155     LoggingThread *loggingThread;
 156     LoggingConnection *logConnection;
 157 };
 158 #endif /* LoggingPLUGIN_H_ */
 159 /**
 160  * @}
 161  * @}
 162  */