remoteaircraftprovider.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_SIMULATION_REMOTEAIRCRAFTPROVIDER_H
#define SWIFT_MISC_SIMULATION_REMOTEAIRCRAFTPROVIDER_H
 
#include <functional>
 
#include <QHash>
#include <QJsonObject>
#include <QList>
#include <QMetaObject>
#include <QObject>
#include <QReadWriteLock>
#include <QtGlobal>
 
#include "misc/aviation/aircraftpartslist.h"
#include "misc/aviation/aircraftsituationchangelist.h"
#include "misc/aviation/aircraftsituationlist.h"
#include "misc/aviation/callsignset.h"
#include "misc/aviation/percallsign.h"
#include "misc/identifiable.h"
#include "misc/provider.h"
#include "misc/simulation/aircraftmodel.h"
#include "misc/simulation/airspaceaircraftsnapshot.h"
#include "misc/simulation/reverselookup.h"
#include "misc/simulation/simulatedaircraftlist.h"
#include "misc/swiftmiscexport.h"
 
namespace swift::misc
{
    namespace geo
    {
        class CElevationPlane;
    }
    namespace simulation
    {
        class SWIFT_MISC_EXPORT IRemoteAircraftProvider : public IProvider
        {
        public:
            static constexpr int MaxSituationsPerCallsign = 50; 
            static constexpr int MaxPartsPerCallsign = 50; 
            static constexpr int MaxPartsAgePerCallsignSecs = 60; 
 
            ~IRemoteAircraftProvider() override = default;
 
            IRemoteAircraftProvider(const IRemoteAircraftProvider &) = delete;
 
            IRemoteAircraftProvider &operator=(const IRemoteAircraftProvider &) = delete;
 
            virtual CSimulatedAircraftList getAircraftInRange() const = 0;
 
            virtual int getAircraftInRangeCount() const = 0;
 
            virtual aviation::CCallsignSet getAircraftInRangeCallsigns() const = 0;
 
            virtual bool isAircraftInRange(const aviation::CCallsign &callsign) const = 0;
 
            virtual bool isVtolAircraft(const aviation::CCallsign &callsign) const = 0;
 
            virtual CAirspaceAircraftSnapshot getLatestAirspaceAircraftSnapshot() const = 0;
 
            virtual CSimulatedAircraft getAircraftInRangeForCallsign(const aviation::CCallsign &callsign) const = 0;
 
            virtual CAircraftModel getAircraftInRangeModelForCallsign(const aviation::CCallsign &callsign) const = 0;
 
            virtual aviation::CAircraftSituationList
            remoteAircraftSituations(const aviation::CCallsign &callsign) const = 0;
 
            virtual MillisecondsMinMaxMean
            remoteAircraftSituationsTimestampDifferenceMinMaxMean(const aviation::CCallsign &callsign) const = 0;
 
            virtual aviation::CAircraftSituation remoteAircraftSituation(const aviation::CCallsign &callsign,
                                                                         int index) const = 0;
 
            virtual aviation::CAircraftSituationList latestRemoteAircraftSituations() const = 0;
 
            virtual aviation::CAircraftSituationList latestOnGroundProviderElevations() const = 0;
 
            virtual int remoteAircraftSituationsCount(const aviation::CCallsign &callsign) const = 0;
 
            virtual aviation::CAircraftPartsList remoteAircraftParts(const aviation::CCallsign &callsign) const = 0;
 
            virtual int remoteAircraftPartsCount(const aviation::CCallsign &callsign) const = 0;
 
            virtual bool isRemoteAircraftSupportingParts(const aviation::CCallsign &callsign) const = 0;
 
            aviation::CAircraftParts getLatestAircraftParts(const aviation::CCallsign &callsign) const;
 
            virtual int getRemoteAircraftSupportingPartsCount() const = 0;
 
            virtual aviation::CCallsignSet remoteAircraftSupportingParts() const = 0;
 
            virtual aviation::CAircraftSituationChangeList
            remoteAircraftSituationChanges(const aviation::CCallsign &callsign) const = 0;
 
            virtual int remoteAircraftSituationChangesCount(const aviation::CCallsign &callsign) const = 0;
 
            virtual bool updateAircraftEnabled(const aviation::CCallsign &callsign, bool enabledForRendering) = 0;
 
            virtual bool setAircraftEnabledFlag(const swift::misc::aviation::CCallsign &callsign,
                                                bool enabledForRendering) = 0;
 
            virtual int updateMultipleAircraftEnabled(const aviation::CCallsignSet &callsigns,
                                                      bool enabledForRendering) = 0;
 
            virtual bool updateAircraftRendered(const aviation::CCallsign &callsign, bool rendered) = 0;
 
            virtual int updateMultipleAircraftRendered(const aviation::CCallsignSet &callsigns, bool rendered) = 0;
 
            virtual void updateMarkAllAsNotRendered() = 0;
 
            virtual bool updateAircraftModel(const aviation::CCallsign &callsign, const CAircraftModel &model,
                                             const CIdentifier &originator) = 0;
 
            virtual bool updateAircraftNetworkModel(const aviation::CCallsign &callsign, const CAircraftModel &model,
                                                    const CIdentifier &originator) = 0;
 
            virtual bool updateFastPositionEnabled(const aviation::CCallsign &callsign,
                                                   bool enableFastPositonUpdates) = 0;
 
            virtual int updateAircraftGroundElevation(const aviation::CCallsign &callsign,
                                                      const geo::CElevationPlane &elevation,
                                                      aviation::CAircraftSituation::GndElevationInfo info,
                                                      bool *updateAircraftGroundElevation) = 0;
 
            virtual bool updateCG(const aviation::CCallsign &callsign, const physical_quantities::CLength &cg) = 0;
 
            virtual aviation::CCallsignSet updateCGForModel(const QString &modelString,
                                                            const physical_quantities::CLength &cg) = 0;
 
            virtual bool updateCGAndModelString(const aviation::CCallsign &callsign,
                                                const physical_quantities::CLength &cg, const QString &modelString) = 0;
 
            virtual physical_quantities::CLength getCGFromDB(const aviation::CCallsign &callsign) const = 0;
            virtual physical_quantities::CLength getCGFromDB(const QString &modelString) const = 0;
            virtual void rememberCGFromDB(const physical_quantities::CLength &cgFromDB,
                                          const aviation::CCallsign &callsign) = 0;
            virtual void rememberCGFromDB(const physical_quantities::CLength &cgFromDB, const QString &modelString) = 0;
 
            virtual CStatusMessageList getReverseLookupMessages(const aviation::CCallsign &callsign) const = 0;
 
            virtual ReverseLookupLogging isReverseLookupMessagesEnabled() const = 0;
 
            virtual void enableReverseLookupMessages(ReverseLookupLogging enable) = 0;
 
            virtual CStatusMessageList getAircraftPartsHistory(const aviation::CCallsign &callsign) const = 0;
 
            virtual bool isAircraftPartsHistoryEnabled() const = 0;
 
            virtual void enableAircraftPartsHistory(bool enabled) = 0;
 
            virtual int aircraftSituationsAdded() const = 0;
 
            virtual int aircraftPartsAdded() const = 0;
 
            virtual qint64 situationsLastModified(const aviation::CCallsign &callsign) const = 0;
 
            virtual qint64 partsLastModified(const aviation::CCallsign &callsign) const = 0;
 
            virtual geo::CElevationPlane
            averageElevationOfNonMovingAircraft(const aviation::CAircraftSituation &reference,
                                                const physical_quantities::CLength &range, int minValues = 1,
                                                int sufficientValues = 2) const = 0;
 
            virtual QList<QMetaObject::Connection> connectRemoteAircraftProviderSignals(
                QObject *receiver, std::function<void(const aviation::CAircraftSituation &)> addedSituationSlot,
                std::function<void(const aviation::CCallsign &, const aviation::CAircraftParts &)> addedPartsSlot,
                std::function<void(const aviation::CCallsign &)> removedAircraftSlot,
                std::function<void(const CAirspaceAircraftSnapshot &)> aircraftSnapshot) = 0;
 
            static void removeOutdatedParts(aviation::CAircraftPartsList &partsList);
 
            static const aviation::CCallsign &testAltitudeOffsetCallsign();
 
        protected:
            IRemoteAircraftProvider() = default;
        };
    } // namespace simulation
} // namespace swift::misc
 
Q_DECLARE_INTERFACE(swift::misc::simulation::IRemoteAircraftProvider, "org.swift-project.iremoteaircraftprovider")
 
namespace swift::misc::simulation
{
    class SWIFT_MISC_EXPORT CRemoteAircraftProvider :
        public QObject,
        public IRemoteAircraftProvider,
        public CIdentifiable
    {
        Q_OBJECT
        Q_INTERFACES(swift::misc::simulation::IRemoteAircraftProvider)
 
    public:
        static const QStringList &getLogCategories();
 
        CRemoteAircraftProvider(QObject *parent);
 
        // remoteaircraftprovider
        CSimulatedAircraftList getAircraftInRange() const override;
        aviation::CCallsignSet getAircraftInRangeCallsigns() const override;
        CSimulatedAircraft getAircraftInRangeForCallsign(const aviation::CCallsign &callsign) const override;
        CAircraftModel getAircraftInRangeModelForCallsign(const aviation::CCallsign &callsign) const override;
        int getAircraftInRangeCount() const override;
        bool isAircraftInRange(const aviation::CCallsign &callsign) const override;
        bool isVtolAircraft(const aviation::CCallsign &callsign) const override;
        aviation::CAircraftSituationList remoteAircraftSituations(const aviation::CCallsign &callsign) const override;
        aviation::CAircraftSituation remoteAircraftSituation(const aviation::CCallsign &callsign,
                                                             int index) const override;
        MillisecondsMinMaxMean
        remoteAircraftSituationsTimestampDifferenceMinMaxMean(const aviation::CCallsign &callsign) const override;
        aviation::CAircraftSituationList latestRemoteAircraftSituations() const override;
        aviation::CAircraftSituationList latestOnGroundProviderElevations() const override;
        int remoteAircraftSituationsCount(const aviation::CCallsign &callsign) const override;
        aviation::CAircraftPartsList remoteAircraftParts(const aviation::CCallsign &callsign) const override;
        int remoteAircraftPartsCount(const aviation::CCallsign &callsign) const override;
        bool isRemoteAircraftSupportingParts(const aviation::CCallsign &callsign) const override;
        int getRemoteAircraftSupportingPartsCount() const override;
        aviation::CCallsignSet remoteAircraftSupportingParts() const override;
        aviation::CAircraftSituationChangeList
        remoteAircraftSituationChanges(const aviation::CCallsign &callsign) const override;
        int remoteAircraftSituationChangesCount(const aviation::CCallsign &callsign) const override;
        bool updateAircraftEnabled(const aviation::CCallsign &callsign, bool enabledForRendering) override;
        bool setAircraftEnabledFlag(const swift::misc::aviation::CCallsign &callsign,
                                    bool enabledForRendering) override;
        int updateMultipleAircraftEnabled(const aviation::CCallsignSet &callsigns, bool enabledForRendering) override;
        bool updateAircraftModel(const aviation::CCallsign &callsign, const CAircraftModel &model,
                                 const CIdentifier &originator) override;
        bool updateAircraftNetworkModel(const aviation::CCallsign &callsign, const CAircraftModel &model,
                                        const CIdentifier &originator) override;
        bool updateFastPositionEnabled(const aviation::CCallsign &callsign, bool enableFastPositonUpdates) override;
        bool updateAircraftRendered(const aviation::CCallsign &callsign, bool rendered) override;
        int updateMultipleAircraftRendered(const aviation::CCallsignSet &callsigns, bool rendered) override;
        int updateAircraftGroundElevation(const aviation::CCallsign &callsign, const geo::CElevationPlane &elevation,
                                          aviation::CAircraftSituation::GndElevationInfo info,
                                          bool *setForOnGroundPosition) override;
        bool updateCG(const aviation::CCallsign &callsign, const physical_quantities::CLength &cg) override;
        bool updateCGAndModelString(const aviation::CCallsign &callsign, const physical_quantities::CLength &cg,
                                    const QString &modelString) override;
        aviation::CCallsignSet updateCGForModel(const QString &modelString,
                                                const physical_quantities::CLength &cg) override;
        physical_quantities::CLength getCGFromDB(const aviation::CCallsign &callsign) const override;
        physical_quantities::CLength getCGFromDB(const QString &modelString) const override;
        void rememberCGFromDB(const physical_quantities::CLength &cgFromDB,
                              const aviation::CCallsign &callsign) override;
        void rememberCGFromDB(const physical_quantities::CLength &cgFromDB, const QString &modelString) override;
        void updateMarkAllAsNotRendered() override;
        CStatusMessageList getAircraftPartsHistory(const aviation::CCallsign &callsign) const override;
        bool isAircraftPartsHistoryEnabled() const override;
        void enableAircraftPartsHistory(bool enabled) override;
        int aircraftSituationsAdded() const override;
        int aircraftPartsAdded() const override;
        qint64 situationsLastModified(const aviation::CCallsign &callsign) const override;
        qint64 partsLastModified(const aviation::CCallsign &callsign) const override;
        geo::CElevationPlane averageElevationOfNonMovingAircraft(const aviation::CAircraftSituation &reference,
                                                                 const physical_quantities::CLength &range,
                                                                 int minValues = 1,
                                                                 int sufficientValues = 2) const override;
        QList<QMetaObject::Connection> connectRemoteAircraftProviderSignals(
            QObject *receiver, std::function<void(const aviation::CAircraftSituation &)> addedSituationSlot,
            std::function<void(const aviation::CCallsign &, const aviation::CAircraftParts &)> addedPartsSlot,
            std::function<void(const aviation::CCallsign &)> removedAircraftSlot,
            std::function<void(const CAirspaceAircraftSnapshot &)> aircraftSnapshotSlot) override;
 
        void enableReverseLookupMessages(ReverseLookupLogging enable) override;
        ReverseLookupLogging isReverseLookupMessagesEnabled() const override;
        swift::misc::CStatusMessageList
        getReverseLookupMessages(const swift::misc::aviation::CCallsign &callsign) const override;
 
        void addReverseLookupMessages(const aviation::CCallsign &callsign, const CStatusMessageList &messages);
        void addReverseLookupMessage(const aviation::CCallsign &callsign, const CStatusMessage &message);
        void addReverseLookupMessage(const aviation::CCallsign &callsign, const QString &message,
                                     CStatusMessage::StatusSeverity severity = CStatusMessage::SeverityInfo);
 
        QObject *asQObject() override { return this; }
 
        void clear();
 
        // ------------------- testing ---------------
 
        bool hasTestAltitudeOffset(const aviation::CCallsign &callsign) const;
 
        bool hasTestAltitudeOffsetGlobalValue() const;
 
        bool testAddAltitudeOffset(const aviation::CCallsign &callsign, const physical_quantities::CLength &offset);
 
    signals:
        void addedAircraft(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft);
 
        void addedAircraftParts(const swift::misc::aviation::CCallsign &callsign,
                                const swift::misc::aviation::CAircraftParts &parts);
 
        void addedAircraftSituation(const swift::misc::aviation::CAircraftSituation &situation);
 
        void changedAircraftInRange();
 
        void removedAircraft(const swift::misc::aviation::CCallsign &callsign);
 
        void airspaceAircraftSnapshot(const swift::misc::simulation::CAirspaceAircraftSnapshot &snapshot);
 
    protected:
        bool removeAircraft(const aviation::CCallsign &callsign);
 
        void removeAllAircraft();
 
        void removeReverseLookupMessages(const aviation::CCallsign &callsign);
 
        bool addNewAircraftInRange(const CSimulatedAircraft &aircraft);
 
        CSimulatedAircraft addOrUpdateAircraftInRange(const aviation::CCallsign &callsign, const QString &aircraftIcao,
                                                      const QString &airlineIcao, const QString &livery,
                                                      const QString &modelString, CAircraftModel::ModelType modelType,
                                                      CStatusMessageList *log = nullptr);
 
        int updateAircraftInRange(const aviation::CCallsign &callsign, const CPropertyIndexVariantMap &vm,
                                  bool skipEqualValues = true);
 
        bool updateAircraftInRangeDistanceBearing(const aviation::CCallsign &callsign,
                                                  const aviation::CAircraftSituation &situation,
                                                  const physical_quantities::CLength &distance,
                                                  const physical_quantities::CAngle &bearing);
 
        virtual aviation::CAircraftSituation storeAircraftSituation(const aviation::CAircraftSituation &situation,
                                                                    bool allowTestAltitudeOffset = true);
 
        void storeAircraftParts(const aviation::CCallsign &callsign, const aviation::CAircraftParts &parts,
                                bool removeOutdated);
        void storeAircraftParts(const aviation::CCallsign &callsign, const QJsonObject &jsonObject,
                                qint64 currentOffsetMs);
 
        bool guessOnGroundAndUpdateModelCG(aviation::CAircraftSituation &situation,
                                           const aviation::CAircraftSituationChange &change,
                                           const CAircraftModel &aircraftModel);
 
        aviation::CAircraftSituation
        addTestAltitudeOffsetToSituation(const aviation::CAircraftSituation &situation) const;
 
        ReverseLookupLogging whatToReverseLog() const;
 
        static int setGroundElevationCheckedAndGuessGround(aviation::CAircraftSituationList &situations,
                                                           const geo::CElevationPlane &elevationPlane,
                                                           aviation::CAircraftSituation::GndElevationInfo info,
                                                           const simulation::CAircraftModel &model,
                                                           aviation::CAircraftSituationChange *changeOut,
                                                           bool *setForOnGroundPosition);
 
    private:
        void storeChange(const aviation::CAircraftSituationChange &change);
 
        aviation::CAircraftSituationListPerCallsign
            m_situationsByCallsign; 
        aviation::CAircraftSituationPerCallsign
            m_latestSituationByCallsign; 
        aviation::CAircraftSituationPerCallsign
            m_latestOnGroundProviderElevation; 
        aviation::CAircraftPartsListPerCallsign
            m_partsByCallsign; 
        aviation::CAircraftSituationChangeListPerCallsign
            m_changesByCallsign; 
        aviation::CCallsignSet m_aircraftWithParts; 
        int m_situationsAdded = 0; 
        int m_partsAdded = 0; 
 
        ReverseLookupLogging m_enableReverseLookupMsgs =
            RevLogSimplifiedInfo; 
        simulation::CSimulatedAircraftPerCallsign m_aircraftInRange; 
        aviation::CStatusMessageListPerCallsign m_reverseLookupMessages; 
        aviation::CStatusMessageListPerCallsign m_aircraftPartsMessages; 
        aviation::CTimestampPerCallsign m_situationsLastModified; 
        aviation::CTimestampPerCallsign m_partsLastModified; 
        aviation::CLengthPerCallsign m_testOffset; 
        aviation::CLengthPerCallsign m_dbCGPerCallsign; 
        QHash<QString, physical_quantities::CLength> m_dbCGPerModelString; 
 
        bool m_enableAircraftPartsHistory = true; 
 
        // locks
        mutable QReadWriteLock m_lockSituations; 
        mutable QReadWriteLock m_lockParts; 
        mutable QReadWriteLock m_lockChanges; 
        mutable QReadWriteLock m_lockAircraft; 
        mutable QReadWriteLock m_lockMessages; 
        mutable QReadWriteLock m_lockPartsHistory; 
    };
 
    class SWIFT_MISC_EXPORT CRemoteAircraftAware : public IProviderAware<IRemoteAircraftProvider>
    {
    public:
        ~CRemoteAircraftAware() override = default;
 
        CSimulatedAircraftList getAircraftInRange() const;
 
        bool isAircraftInRange(const aviation::CCallsign &callsign) const;
 
        bool isVtolAircraft(const aviation::CCallsign &callsign) const;
 
        int getAircraftInRangeCount() const;
 
        aviation::CCallsignSet getAircraftInRangeCallsigns() const;
 
        CSimulatedAircraft getAircraftInRangeForCallsign(const aviation::CCallsign &callsign) const;
 
        CAircraftModel getAircraftInRangeModelForCallsign(const aviation::CCallsign &callsign) const;
 
        CAirspaceAircraftSnapshot getLatestAirspaceAircraftSnapshot() const;
 
        aviation::CAircraftSituationList remoteAircraftSituations(const aviation::CCallsign &callsign) const;
 
        aviation::CAircraftSituation remoteAircraftSituation(const aviation::CCallsign &callsign, int index) const;
 
        aviation::CAircraftSituationList latestRemoteAircraftSituations() const;
 
        aviation::CAircraftSituationList latestOnGroundProviderElevations() const;
 
        int remoteAircraftSituationsCount(const aviation::CCallsign &callsign) const;
 
        aviation::CAircraftPartsList remoteAircraftParts(const aviation::CCallsign &callsign) const;
 
        int remoteAircraftPartsCount(const aviation::CCallsign &callsign) const;
 
        aviation::CAircraftSituationChangeList
        remoteAircraftSituationChanges(const aviation::CCallsign &callsign) const;
 
        aviation::CCallsignSet remoteAircraftSupportingParts() const;
 
        bool isRemoteAircraftSupportingParts(const aviation::CCallsign &callsign) const;
 
        int getRemoteAircraftSupportingPartsCount() const;
 
        bool updateAircraftEnabled(const aviation::CCallsign &callsign, bool enabledForRendering);
 
        bool setAircraftEnabledFlag(const aviation::CCallsign &callsign, bool enabledForRendering);
 
        bool updateMultipleAircraftEnabled(const aviation::CCallsignSet &callsigns, bool enabledForRendering);
 
        bool updateAircraftModel(const aviation::CCallsign &callsign, const CAircraftModel &model,
                                 const CIdentifier &originator);
 
        bool updateAircraftNetworkModel(const aviation::CCallsign &callsign, const CAircraftModel &model,
                                        const CIdentifier &originator);
 
        bool updateAircraftRendered(const aviation::CCallsign &callsign, bool rendered);
 
        bool updateMultipleAircraftRendered(const aviation::CCallsignSet &callsigns, bool rendered);
 
        int updateAircraftGroundElevation(const aviation::CCallsign &callsign, const geo::CElevationPlane &elevation,
                                          aviation::CAircraftSituation::GndElevationInfo info,
                                          bool *updateAircraftGroundElevation);
 
        bool updateCG(const aviation::CCallsign &callsign, const physical_quantities::CLength &cg);
 
        aviation::CCallsignSet updateCGForModel(const QString &modelString, const physical_quantities::CLength &cg);
 
        bool updateCGAndModelString(const aviation::CCallsign &callsign, const physical_quantities::CLength &cg,
                                    const QString &modelString);
 
        void updateMarkAllAsNotRendered();
 
        int aircraftSituationsAdded() const;
 
        int aircraftPartsAdded() const;
 
        qint64 situationsLastModified(const aviation::CCallsign &callsign) const;
 
        qint64 partsLastModified(const aviation::CCallsign &callsign) const;
 
        geo::CElevationPlane averageElevationOfNonMovingAircraft(const aviation::CAircraftSituation &reference,
                                                                 const physical_quantities::CLength &range,
                                                                 int minValues = 1) const;
 
        void setRemoteAircraftProvider(IRemoteAircraftProvider *remoteAircraftProvider)
        {
            this->setProvider(remoteAircraftProvider);
        }
 
        IRemoteAircraftProvider *getRemoteAircraftProvider() const { return this->getProvider(); }
 
    protected:
        CRemoteAircraftAware() {} // NOLINT(modernize-use-equals-default)
 
        CRemoteAircraftAware(IRemoteAircraftProvider *remoteAircraftProvider) : IProviderAware(remoteAircraftProvider)
        {
            Q_ASSERT(remoteAircraftProvider);
        }
    };
} // namespace swift::misc::simulation
 
#endif // SWIFT_MISC_SIMULATION_REMOTEAIRCRAFTPROVIDER_H