Reflecting discussed changes for interpolation performance refs #386

(based on FSX testing)
* Only send changed situation to SIM
* Split sending of parts / situations
* Only send parts with a reduced frequency (means slower as positions)
* Mark geodetic height as null for default values (the value is usually unavailable)
* Fixed altitude to MSL for network data
* Trace which aircrafts support aircraft parts via network
* Renamed insert_fron push_front (as proposed by Roland)

Status quo / lessons learnt
* On slower PCs jitter is still noticed for interpolated aircraft.
* Running interpolation in an independent process (aka core, not in GUI) reduced load dependencies
  => it seems to make sense to run driver in own thread
* The onGround flag in parts seems clumsy as it required to retrieve parts for position updates
* In interpolation performance really matters

src/blackcore/interpolator.h

@@ -29,45 +29,72 @@ namespace BlackCore
         Q_OBJECT
 
     public:
+        //! Situations per callsign
+        typedef QHash<BlackMisc::Aviation::CCallsign, BlackMisc::Aviation::CAircraftSituationList> CSituationsPerCallsign;
+
+        //! Parts per callsign
+        typedef QHash<BlackMisc::Aviation::CCallsign, BlackMisc::Aviation::CAircraftPartsList> CPartsPerCallsign;
+
         //! Virtual destructor
         virtual ~IInterpolator() {}
 
         //! Log category
         static QString getMessageCategory() { return "swift.iinterpolator"; }
 
-        //! Has situations?
-        //! \deprecated Try not to use, it would be more efficient to directly getting the values and decide then
-        //! \threadsafe
-        virtual bool hasEnoughAircraftSituations(const BlackMisc::Aviation::CCallsign &callsign) const;
+        //! Status of interpolation
+        struct InterpolationStatus
+        {
+        public:
+            bool changedPosition = false;        //!< position was changed
+            bool interpolationSucceeded = false; //!< interpolation succeeded (means enough values, etc.)
+
+            //! all OK
+            bool allTrue() const;
+
+            //! Reset to default values
+            void reset();
+        };
+
+        //! Status regarding parts
+        struct PartsStatus
+        {
+            bool supportsParts = false;   //!< supports parts for given callsign
+
+            //! all OK
+            bool allTrue() const;
+
+            //! Reset to default values
+            void reset();
+        };
 
         //! Current interpolated situation
         //! \threadsafe
-        virtual BlackMisc::Aviation::CAircraftSituation getCurrentInterpolatedSituation(const QHash<BlackMisc::Aviation::CCallsign, BlackMisc::Aviation::CAircraftSituationList> &allSituations, const BlackMisc::Aviation::CCallsign &callsign, qint64 currentTimeSinceEpoc = -1, bool *ok = nullptr) const = 0;
+        virtual BlackMisc::Aviation::CAircraftSituation getInterpolatedSituation(
+            const BlackMisc::Aviation::CCallsign &callsign, qint64 currentTimeSinceEpoc,
+            InterpolationStatus &status, const CSituationsPerCallsign *situationsPerCallsign = nullptr) const = 0;
 
-        //! Latest parts before time - offset
+        //! Do a complete calculation for all know callsigns.
+        //! \param currentTimeMsSinceEpoch if no value is passed current time is used
         //! \threadsafe
-        BlackMisc::Aviation::CAircraftParts getLatestPartsBeforeOffset(const BlackMisc::Aviation::CCallsign &callsign, qint64 timeOffset = TimeOffsetMs, bool *ok = nullptr) const;
+        //!
+        virtual BlackMisc::Aviation::CAircraftSituationList getInterpolatedSituations(qint64 currentTimeMsSinceEpoch = -1);
 
         //! The situations per callsign
         //! \threadsafe
-        QHash<BlackMisc::Aviation::CCallsign, BlackMisc::Aviation::CAircraftSituationList> getSituationsByCallsign() const;
+        CSituationsPerCallsign getSituationsByCallsign() const;
+
+        //! Parts before given offset time (aka pending parts)
+        //! \threadsafe
+        virtual BlackMisc::Aviation::CAircraftPartsList getAndRemovePartsBeforeOffset(const BlackMisc::Aviation::CCallsign &callsign, qint64 timeOffset, PartsStatus &partsStatus);
+
+        //! Clear all data
+        //! \threadsafe
+        virtual void clear();
 
         //! Situations for given callsign
         //! \threadsafe
         BlackMisc::Aviation::CAircraftSituationList getSituationsForCallsign(const BlackMisc::Aviation::CCallsign &callsign) const;
 
-        //! Last finished request id, -1 means none
-        //! \threadsafe
-        int latestFinishedRequestId() const;
-
-        //! Latest calculation
-        //! \threadsafe
-        BlackMisc::Aviation::CAircraftSituationList latestFinishedRequest() const;
-
-        //! Calculation by id
-        //! \threadsafe
-        BlackMisc::Aviation::CAircraftSituationList getRequest(int requestId, bool *ok = nullptr) const;
-
         //! Enable debug messages
         void enableDebugMessages(bool enabled);
 
@@ -76,20 +103,6 @@ namespace BlackCore
         static const int MaxPartsPerCallsign = 3;          //!< How many parts per callsign
         static const int MaxKeptInterpolationRequests = 3; //!< How many requests are stored
 
-    public slots:
-        //! Do a complete calculation for all know callsigns in background.
-        //! Only use positive numbers.
-        //! \param requestId
-        //! \param currentTimeMsSinceEpoch if no value is passed current time is used
-        //! \threadsafe
-        //!
-        void syncRequestSituationsCalculationsForAllCallsigns(int requestId, qint64 currentTimeMsSinceEpoch = -1);
-
-        //! Do a complete calculation for all know callsigns in background.
-        //! Non blocking call of \sa syncRequestSituationsCalculationsForAllCallsigns
-        //! \threadsafe
-        void asyncRequestSituationsCalculationsForAllCallsigns(int requestId, qint64 currentTimeMsSinceEpoch = -1);
-
     private slots:
         //! New situation got added
         //! \threadsafe
@@ -107,23 +120,17 @@ namespace BlackCore
         //! Constructor
         IInterpolator(BlackMisc::Simulation::IRemoteAircraftProviderReadOnly *provider, const QString &workerName, QObject *parent = nullptr);
 
-        //! Situations for times before / after
-        //! \sa ITimestampObjectList::splitByTime
-        //! \threadsafe
-        //! \deprecated For first version
-        QList<BlackMisc::Aviation::CAircraftSituationList> getSituationsTimeSplit(const BlackMisc::Aviation::CCallsign &callsign, qint64 splitTimeMsSinceEpoch) const;
-
         bool m_withDebugMsg = false; //!< allows to disable debug messages
-
-    private:
-        mutable QReadWriteLock m_situationsLock;
-        mutable QReadWriteLock m_partsLock;
-        mutable QReadWriteLock m_requestedInterpolationsLock;
+        BlackMisc::Aviation::CCallsignList m_aircraftSupportingParts; //!< aircraft supporting parts
 
         // hashs, because not sorted by key but keeping order
-        QHash<BlackMisc::Aviation::CCallsign, BlackMisc::Aviation::CAircraftSituationList> m_situationsByCallsign;
-        QHash<BlackMisc::Aviation::CCallsign, BlackMisc::Aviation::CAircraftPartsList> m_partsByCallsign;
-        QHash<int, BlackMisc::Aviation::CAircraftSituationList> m_requestedInterpolations;
+        CSituationsPerCallsign m_situationsByCallsign; //!< situations
+        CPartsPerCallsign      m_partsByCallsign;      //!< parts
+
+        // locks
+        mutable QReadWriteLock m_lockSituations; //!< lock for situations
+        mutable QReadWriteLock m_lockParts;      //!< lock for parts
+
     };
 
 } // namespace