interpolator.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2014 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1

 
#ifndef SWIFT_MISC_SIMULATION_INTERPOLATION_INTERPOLATOR_H
#define SWIFT_MISC_SIMULATION_INTERPOLATION_INTERPOLATOR_H
 
#include <QString>
#include <QStringList>
#include <QTimer>
#include <QtGlobal>
 
#include "misc/aviation/aircraftpartslist.h"
#include "misc/aviation/aircraftsituation.h"
#include "misc/aviation/aircraftsituationchange.h"
#include "misc/aviation/callsign.h"
#include "misc/simulation/aircraftmodel.h"
#include "misc/simulation/interpolation/interpolant.h"
#include "misc/simulation/interpolation/interpolationlogger.h"
#include "misc/simulation/interpolation/interpolationrenderingsetup.h"
#include "misc/simulation/interpolation/interpolationresult.h"
#include "misc/simulation/interpolation/interpolationsetupprovider.h"
#include "misc/simulation/interpolation/interpolationstatus.h"
#include "misc/simulation/partsstatus.h"
#include "misc/simulation/remoteaircraftprovider.h"
#include "misc/simulation/simulationenvironmentprovider.h"
#include "misc/statusmessagelist.h"
#include "misc/swiftmiscexport.h"
 
namespace swift::misc::simulation
{
    class CInterpolationLogger;
    class CInterpolatorLinear;
    class CInterpolatorSpline;

    class SWIFT_MISC_EXPORT CInterpolator :
        protected CSimulationEnvironmentAware,
        protected CInterpolationSetupAware,
        protected CRemoteAircraftAware
    {
    public:
        static const QStringList &getLogCategories();

        const aviation::CAircraftSituation &getLastInterpolatedSituation() const { return m_lastSituation; }

        CInterpolationResult getInterpolation(qint64 currentTimeSinceEpoch,
                                              const CInterpolationAndRenderingSetupPerCallsign &setup,
                                              uint32_t aircraftNumber);

        void attachLogger(CInterpolationLogger *logger) { m_logger = logger; }

        bool hasAttachedLogger() const { return m_logger; }

        QString getInterpolatorInfo() const;

        void resetLastInterpolation();

        void initCorrespondingModel(const CAircraftModel &model = {});

        void markAsUnitTest();

        int getInvalidSituationsCount() const { return m_invalidSituations; }

        const CStatusMessageList &getInterpolationMessages() const { return m_interpolationMessages; }

        bool hasInterpolationMessages() const { return !m_interpolationMessages.isEmpty(); }
 
    protected:
        CInterpolator(const aviation::CCallsign &callsign, ISimulationEnvironmentProvider *simEnvProvider,
                      IInterpolationSetupProvider *setupProvider, IRemoteAircraftProvider *remoteProvider,
                      CInterpolationLogger *logger);

        const physical_quantities::CLength &getModelCG() const { return m_model.getCG(); }

        bool doLogging() const;
 
        const aviation::CCallsign m_callsign; 
        CAircraftModel m_model; 
 
        // values for current interpolation step
        qint64 m_currentTimeMsSinceEpoch = -1; 
        qint64 m_lastInvalidLogTs = -1; 
        aviation::CAircraftSituationList
            m_currentSituations; 
        aviation::CAircraftSituationChange
            m_pastSituationsChange; 
        CInterpolationAndRenderingSetupPerCallsign m_currentSetup; 
        CInterpolationStatus m_currentInterpolationStatus; 
        CPartsStatus m_currentPartsStatus; 
        CPartsStatus m_lastPartsStatus; 
        int m_partsToSituationInterpolationRatio =
            2; 
        int m_partsToSituationGuessingRatio = 5; 
        int m_invalidSituations = 0; 
        CStatusMessageList m_interpolationMessages; 
 
        aviation::CAircraftSituation m_lastSituation { aviation::CAircraftSituation::null() }; 
        aviation::CAircraftParts m_lastParts { aviation::CAircraftParts::null() }; 
        physical_quantities::CLength m_currentSceneryOffset {
            physical_quantities::CLength::null()
        }; 
 
        qint64 m_situationsLastModified { -1 }; 
        qint64 m_situationsLastModifiedUsed { -1 }; 
        int m_interpolatedSituationsCounter {
            0
        }; 
 
    private:
        CInterpolationLogger *m_logger = nullptr; 
        QTimer m_initTimer; 
        bool m_unitTest = false; 

        bool initIniterpolationStepData(qint64 currentTimeSinceEpoch,
                                        const CInterpolationAndRenderingSetupPerCallsign &setup, int aircraftNumber);

        aviation::CAircraftSituation initInterpolatedSituation(const aviation::CAircraftSituation &oldSituation,
                                                               const aviation::CAircraftSituation &newSituation) const;

        aviation::CAircraftSituation getInterpolatedSituation();

        aviation::CAircraftParts getInterpolatedParts();

        aviation::CAircraftParts getInterpolatedOrGuessedParts(int aircraftNumber);

        static aviation::CAircraftParts guessParts(const aviation::CAircraftSituation &situation,
                                                   const aviation::CAircraftSituationChange &change,
                                                   const simulation::CAircraftModel &model);

        void logParts(const aviation::CAircraftParts &parts, int partsNo, bool empty) const;

        aviation::CAircraftSituationList
        remoteAircraftSituationsAndChange(const CInterpolationAndRenderingSetupPerCallsign &setup);

        physical_quantities::CLength getAndFetchModelCG(const physical_quantities::CLength &dbCG);

        static bool presetGroundElevation(aviation::CAircraftSituation &situationToPreset,
                                          const aviation::CAircraftSituation &oldSituation,
                                          const aviation::CAircraftSituation &newSituation,
                                          const aviation::CAircraftSituationChange &change);

        void deferredInit();

        const swift::misc::aviation::CAircraftParts &logAndReturnNullParts(const QString &info, bool log);

        virtual const IInterpolant &getInterpolant(SituationLog &log) = 0;
    };
} // namespace swift::misc::simulation
// namespace
#endif // SWIFT_MISC_SIMULATION_INTERPOLATION_INTERPOLATOR_H