refs #863 Move interpolator logging into a separate class.

A single logger instance can be shared between multiple interpolator instances.

src/blackmisc/simulation/interpolationlogger.h

@@ -0,0 +1,118 @@
+/* Copyright (C) 2014
+ * swift project Community / Contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+//! \file
+
+#ifndef BLACKMISC_SIMULATION_INTERPOLATIONLOGGER_H
+#define BLACKMISC_SIMULATION_INTERPOLATIONLOGGER_H
+
+#include "interpolationrenderingsetup.h"
+#include "blackmisc/aviation/aircraftpartslist.h"
+#include "blackmisc/aviation/aircraftsituation.h"
+#include "blackmisc/aviation/aircraftpartslist.h"
+#include "blackmisc/simulation/remoteaircraftprovider.h"
+
+#include <QObject>
+#include <QString>
+#include <QtGlobal>
+
+namespace BlackMisc
+{
+    class CWorker;
+    namespace Aviation { class CCallsign; }
+    namespace Simulation
+    {
+        class CInterpolationHints;
+        class CInterpolatorLinear;
+        class CInterpolatorSpline;
+        struct CInterpolationStatus;
+        struct CPartsStatus;
+
+        //! Record internal state of interpolator for debugging
+        class BLACKMISC_EXPORT CInterpolationLogger : public QObject
+        {
+            Q_OBJECT
+
+        public:
+            //! Constructor
+            CInterpolationLogger(QObject *parent = nullptr);
+
+            //! Log category
+            static QString getLogCategory() { return "swift.interpolationlogger"; }
+
+            //! Write a log in background
+            BlackMisc::CWorker *writeLogInBackground();
+
+            //! Clear log file
+            void clearLog();
+
+            //! Latest log files: 0: Interpolation / 1: Parts
+            static QStringList getLatestLogFiles();
+
+            //! Log entry for situation interpolation
+            struct SituationLog
+            {
+                qint64 timestamp = -1;       //!< current timestamp
+                double groundFactor = -1;    //!< current ground factor
+                double vtolAircraft = false; //!< VTOL aircraft
+                double deltaTimeMs = 0;      //!< delta time to last situation
+                double simulationTimeFraction = -1;        //!< time fraction, normally 0..1
+                double deltaTimeFractionMs = -1;           //!< delta time fraction
+                bool useParts = false;                     //!< supporting aircraft parts
+                BlackMisc::Aviation::CCallsign callsign;   //!< current callsign
+                BlackMisc::Aviation::CAircraftParts parts; //!< corresponding parts used in interpolator
+                BlackMisc::Aviation::CAircraftSituation oldSituation;     //!< old situation
+                BlackMisc::Aviation::CAircraftSituation newSituation;     //!< new situation
+                BlackMisc::Aviation::CAircraftSituation currentSituation; //!< interpolated situation
+            };
+
+            //! Log entry for parts interpolation
+            struct PartsLog
+            {
+                qint64 timestamp = -1; //!< current timestamp
+                BlackMisc::Aviation::CCallsign callsign;   //!< current callsign
+                BlackMisc::Aviation::CAircraftParts parts; //!< parts to be logged
+            };
+
+            //! Log current interpolation cycle, only stores in memory, for performance reasons
+            //! \remark const to allow const interpolator functions
+            //! \threadsafe
+            void logInterpolation(const SituationLog &log);
+
+            //! Log current parts cycle, only stores in memory, for performance reasons
+            //! \remark const to allow const interpolator functions
+            //! \threadsafe
+            void logParts(const PartsLog &parts);
+
+        private:
+            //! Get log as HTML table
+            static QString getHtmlInterpolationLog(const QList<SituationLog> &logs);
+
+            //! Get log as HTML table
+            static QString getHtmlPartsLog(const QList<PartsLog> &logs);
+
+            //! Write log to file
+            static CStatusMessageList writeLogFile(const QList<SituationLog> &interpolation, const QList<PartsLog> &parts);
+
+            //! Status of file operation
+            static CStatusMessage logStatusFileWriting(bool success, const QString &fileName);
+
+            //! Create readable time
+            static QString msSinceEpochToTime(qint64 ms);
+
+            //! Create readable time
+            static QString msSinceEpochToTime(qint64 t1, qint64 t2, qint64 t3 = -1);
+
+            mutable QReadWriteLock  m_lockLogs;  //!< lock logging
+            QList<PartsLog> m_partsLogs;         //!< logs of parts
+            QList<SituationLog> m_situationLogs; //!< logs of interpolation
+        };
+    } // namespace
+} // namespace
+#endif // guard