aircraftmatcher_8h_source.html

// 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_CORE_AIRCRAFTMATCHER_H

#define SWIFT_CORE_AIRCRAFTMATCHER_H


#include <QObject>

#include <QString>


#include "core/swiftcoreexport.h"

#include "misc/simulation/aircraftmatchersetup.h"

#include "misc/simulation/aircraftmodellist.h"

#include "misc/simulation/aircraftmodelsetprovider.h"

#include "misc/simulation/categorymatcher.h"

#include "misc/simulation/matchinglog.h"

#include "misc/simulation/matchingscriptmisc.h"

#include "misc/simulation/matchingstatistics.h"


namespace swift::misc

{

    class CLogCategoryList;

    class CStatusMessageList;

    namespace aviation

    {

        class CCallsign;

    }

    namespace simulation

    {

        class CSimulatedAircraft;

    }

} // namespace swift::misc


namespace swift::core

{


    class SWIFT_CORE_EXPORT CAircraftMatcher : public QObject, public swift::misc::simulation::IAircraftModelSetProvider

    {

        Q_OBJECT

        Q_INTERFACES(swift::misc::simulation::IAircraftModelSetProvider)


    public:

        static const QStringList &getLogCategories();


        CAircraftMatcher(const swift::misc::simulation::CAircraftMatcherSetup &setup, QObject *parent = nullptr);


        CAircraftMatcher(QObject *parent = nullptr);


        ~CAircraftMatcher() override;


        CAircraftMatcher(const CAircraftMatcher &) = delete;


        CAircraftMatcher &operator=(const CAircraftMatcher &) = delete;


        bool setSetup(const swift::misc::simulation::CAircraftMatcherSetup &setup);


        swift::misc::simulation::CAircraftMatcherSetup getSetup() const { return m_setup; }


        swift::misc::simulation::CAircraftModel

        getClosestMatch(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                        swift::misc::simulation::MatchingLog whatToLog, swift::misc::CStatusMessageList *log,

                        bool useMatchingScript) const;


        static swift::misc::aviation::CAirlineIcaoCode

        failoverValidAirlineIcaoDesignator(const swift::misc::aviation::CCallsign &callsign, const QString &primaryIcao,

                                           const QString &secondaryIcao, bool airlineFromCallsign,

                                           const QString &airlineName, const QString &airlineTelephony,

                                           bool useWebServices, swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::aviation::CAirlineIcaoCode failoverValidAirlineIcaoDesignator(

            const swift::misc::aviation::CCallsign &callsign, const QString &primaryIcao, const QString &secondaryIcao,

            bool airlineFromCallsign, const QString &airlineName, const QString &airlineTelephony,

            const swift::misc::simulation::CAircraftModelList &models, swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::aviation::CAirlineIcaoCode failoverValidAirlineIcaoDesignatorModelsFirst(

            const swift::misc::aviation::CCallsign &callsign, const QString &primaryIcao, const QString &secondaryIcao,

            bool airlineFromCallsign, const QString &airlineName, const QString &airlineTelephony,

            const swift::misc::simulation::CAircraftModelList &models, swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::simulation::MatchingScriptReturnValues

        reverseLookupScript(const swift::misc::simulation::CAircraftModel &inModel,

                            const swift::misc::simulation::CAircraftMatcherSetup &setup,

                            const swift::misc::simulation::CAircraftModelList &modelSet,

                            swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::MatchingScriptReturnValues

        matchingStageScript(const swift::misc::simulation::CAircraftModel &inModel,

                            const swift::misc::simulation::CAircraftModel &matchedModel,

                            const swift::misc::simulation::CAircraftMatcherSetup &setup,

                            const swift::misc::simulation::CAircraftModelList &modelSet,

                            swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::MatchingScriptReturnValues

        matchingScript(const QString &js, const swift::misc::simulation::CAircraftModel &inModel,

                       const swift::misc::simulation::CAircraftModel &matchedModel,

                       const swift::misc::simulation::CAircraftMatcherSetup &setup,

                       const swift::misc::simulation::CAircraftModelList &modelSet,

                       swift::misc::simulation::MatchingScript ms, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModel reverseLookupModel(

            const swift::misc::aviation::CCallsign &callsign,

            const swift::misc::aviation::CAircraftIcaoCode &networkAircraftIcao,

            const swift::misc::aviation::CAirlineIcaoCode &networkAirlineIcao, const QString &networkLiveryInfo,

            const QString &networkModelString, const swift::misc::simulation::CAircraftMatcherSetup &setup,

            const swift::misc::simulation::CAircraftModelList &modelSet,

            swift::misc::simulation::CAircraftModel::ModelType type, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModel reverseLookupModel(

            const swift::misc::simulation::CAircraftModel &modelToLookup, const QString &networkLiveryInfo,

            const swift::misc::simulation::CAircraftMatcherSetup &setup,

            const swift::misc::simulation::CAircraftModelList &modelSet, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModel reverseLookupModelMs(

            const swift::misc::simulation::CAircraftModel &modelToLookup, const QString &networkLiveryInfo,

            const swift::misc::simulation::CAircraftMatcherSetup &setup,

            const swift::misc::simulation::CAircraftModelList &modelSet, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModel

        reverseLookupModelStringInDB(const QString &modelString, const swift::misc::aviation::CCallsign &callsign,

                                     bool doLookupString, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModel

        reverseLookupModelStringInSet(const QString &modelString, const swift::misc::aviation::CCallsign &callsign,

                                      const swift::misc::simulation::CAircraftModelList &modelSet, bool useNonDbEntries,

                                      swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModel

        reverseLookupModelId(int id, const swift::misc::aviation::CCallsign &callsign,

                             swift::misc::CStatusMessageList *log);


        static swift::misc::aviation::CAircraftIcaoCode

        reverseLookupAircraftIcao(const swift::misc::aviation::CAircraftIcaoCode &icaoDesignator,

                                  const swift::misc::aviation::CCallsign &logCallsign = {},

                                  swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::aviation::CAircraftIcaoCode

        reverseLookupAircraftIcaoId(int id, const swift::misc::aviation::CCallsign &logCallsign,

                                    swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::aviation::CAirlineIcaoCode

        reverseLookupAirlineIcao(const swift::misc::aviation::CAirlineIcaoCode &icaoPattern,

                                 const swift::misc::aviation::CCallsign &callsign = {},

                                 swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::aviation::CLivery

        reverseLookupStandardLivery(const swift::misc::aviation::CAirlineIcaoCode &airline,

                                    const swift::misc::aviation::CCallsign &callsign,

                                    swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::aviation::CLivery reverseLookupLiveryId(int id,

                                                                    const swift::misc::aviation::CCallsign &logCallsign,

                                                                    swift::misc::CStatusMessageList *log = nullptr);


        static int reverseLookupByIds(const swift::misc::simulation::DBTripleIds &ids,

                                      swift::misc::aviation::CAircraftIcaoCode &aircraftIcao,

                                      swift::misc::aviation::CLivery &livery,

                                      const swift::misc::aviation::CCallsign &logCallsign,

                                      swift::misc::CStatusMessageList *log = nullptr);


        static QString reverseLookupAirlineName(const QString &candidate,

                                                const swift::misc::aviation::CCallsign &callsign = {},

                                                swift::misc::CStatusMessageList *log = nullptr);


        static QString reverseLookupTelephonyDesignator(const QString &candidate,

                                                        const swift::misc::aviation::CCallsign &callsign = {},

                                                        swift::misc::CStatusMessageList *log = nullptr);


        static bool isKnownAircraftDesignator(const QString &candidate,

                                              const swift::misc::aviation::CCallsign &callsign = {},

                                              swift::misc::CStatusMessageList *log = nullptr);


        static bool isKnownModelString(const QString &candidate, const swift::misc::aviation::CCallsign &callsign = {},

                                       swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::aviation::CAircraftIcaoCode

        searchAmongAirlineAircraft(const QString &icaoString, const swift::misc::aviation::CAirlineIcaoCode &airline,

                                   const swift::misc::aviation::CCallsign &callsign = {},

                                   swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::aviation::CAirlineIcaoCode

        callsignToAirline(const swift::misc::aviation::CCallsign &callsign,

                          swift::misc::CStatusMessageList *log = nullptr);


        swift::misc::simulation::CAircraftModelList getModelSet() const override { return m_modelSet; }


        virtual const swift::misc::simulation::CAircraftModelList &getModelSetRef() const { return m_modelSet; }


        int getModelSetCount() const override { return m_modelSet.sizeInt(); }


        bool hasModels() const { return !m_modelSet.isEmpty(); }


        int setModelSet(const swift::misc::simulation::CAircraftModelList &models,

                        const swift::misc::simulation::CSimulatorInfo &simulator, bool forced);


        void disableModelsForMatching(const swift::misc::simulation::CAircraftModelList &removedModels,

                                      bool incremental);


        swift::misc::simulation::CAircraftModelList getDisabledModelsForMatching() const { return m_disabledModels; }


        void restoreDisabledModels();


        const swift::misc::simulation::CAircraftModel &getDefaultModel() const { return m_defaultModel; }


        void setDefaultModel(const swift::misc::simulation::CAircraftModel &defaultModel);


        const swift::misc::simulation::CMatchingStatistics &getCurrentStatistics() const { return m_statistics; }


        void clearMatchingStatistics() { m_statistics.clear(); }


        void evaluateStatisticsEntry(const QString &sessionId, const swift::misc::aviation::CCallsign &callsign,

                                     const QString &aircraftIcao, const QString &airlineIcao, const QString &livery);


        void addingRemoteModelFailed(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft);


    signals:

        void setupChanged();


    private:

        bool saveDisabledForMatchingModels();


        static swift::misc::simulation::CAircraftModelList

        getClosestMatchStepwiseReduceImplementation(const swift::misc::simulation::CAircraftModelList &modelSet,

                                                    const swift::misc::simulation::CAircraftMatcherSetup &setup,

                                                    const swift::misc::simulation::CCategoryMatcher &categoryMatcher,

                                                    const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                                    swift::misc::simulation::MatchingLog whatToLog,

                                                    swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::simulation::CAircraftModelList

        getClosestMatchScoreImplementation(const swift::misc::simulation::CAircraftModelList &modelSet,

                                           const swift::misc::simulation::CAircraftMatcherSetup &setup,

                                           const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                           int &maxScore, swift::misc::simulation::MatchingLog whatToLog,

                                           swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::simulation::CAircraftModel

        getCombinedTypeDefaultModel(const swift::misc::simulation::CAircraftModelList &modelSet,

                                    const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                    const swift::misc::simulation::CAircraftModel &defaultModel,

                                    swift::misc::simulation::MatchingLog whatToLog,

                                    swift::misc::CStatusMessageList *log = nullptr);


        static swift::misc::simulation::CAircraftModel

        matchByExactModelString(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                const swift::misc::simulation::CAircraftModelList &models,

                                swift::misc::simulation::MatchingLog whatToLog, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByIcaoData(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                   const swift::misc::simulation::CAircraftModelList &models,

                                   const swift::misc::simulation::CAircraftMatcherSetup &setup, bool &reduced,

                                   swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByFamily(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                 bool allowPseudoFamily, const swift::misc::simulation::CAircraftModelList &inList,

                                 bool &reduced, QString &usedFamily, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByFamily(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                 const QString &family, bool allowPseudoFamily,

                                 const swift::misc::simulation::CAircraftModelList &inList, const QString &hint,

                                 bool &reduced, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByLiveryAndAircraftIcaoCode(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                                    const swift::misc::simulation::CAircraftModelList &inList,

                                                    bool &reduced, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByManufacturer(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                       const swift::misc::simulation::CAircraftModelList &inList, const QString &info,

                                       bool &reduced, swift::misc::CStatusMessageList *log);


        static swift::misc::aviation::CAircraftIcaoCodeList ifPossibleReduceAircraftIcaoByManufacturer(

            const swift::misc::aviation::CAircraftIcaoCode &icaoCode,

            const swift::misc::aviation::CAircraftIcaoCodeList &inList, const QString &info, bool &reduced,

            const swift::misc::aviation::CCallsign &logCallsign, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByAircraft(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                   const swift::misc::simulation::CAircraftModelList &inList, const QString &info,

                                   bool &reduced, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByAircraftOrFamily(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                           bool allowPseudoFamily,

                                           const swift::misc::simulation::CAircraftModelList &inList,

                                           const swift::misc::simulation::CAircraftMatcherSetup &setup,

                                           const QString &info, bool &reduced, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByAirline(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                  const swift::misc::simulation::CAircraftModelList &inList,

                                  const swift::misc::simulation::CAircraftMatcherSetup &setup, const QString &info,

                                  bool &reduced, swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList ifPossibleReduceModelsByAirlineNameTelephonyDesignator(

            const swift::misc::aviation::CCallsign &cs, const QString &airlineName, const QString &telephony,

            const swift::misc::simulation::CAircraftModelList &inList, const QString &info, bool &reduced,

            swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByCombinedType(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                       const swift::misc::simulation::CAircraftModelList &inList,

                                       const swift::misc::simulation::CAircraftMatcherSetup &setup, bool &reduced,

                                       swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByMilitaryFlag(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                       const swift::misc::simulation::CAircraftModelList &inList, bool &reduced,

                                       swift::misc::CStatusMessageList *log);


        static swift::misc::simulation::CAircraftModelList

        ifPossibleReduceByVTOLFlag(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft,

                                   const swift::misc::simulation::CAircraftModelList &inList, bool &reduced,

                                   swift::misc::CStatusMessageList *log);


        static QString scoresToString(const swift::misc::simulation::ScoredModels &scores, int lastElements = 5);


        static swift::misc::aviation::CAirlineIcaoCode

        stringToAirlineIcaoObject(const swift::misc::aviation::CCallsign &cs, const QString &designator,

                                  const QString &airlineName, const QString &airlineTelephony, bool useSwiftDbData,

                                  swift::misc::CStatusMessageList *log);


        static bool isValidAirlineIcaoDesignator(const QString &designator, bool checkAgainstSwiftDb);


        static bool constexpr UsePseudoFamily = true;


        swift::misc::simulation::CAircraftMatcherSetup m_setup;

        swift::misc::simulation::CAircraftModel m_defaultModel;

        swift::misc::simulation::CAircraftModelList m_modelSet;

        swift::misc::simulation::CAircraftModelList m_disabledModels;

        swift::misc::simulation::CSimulatorInfo m_simulator;

        swift::misc::simulation::CMatchingStatistics m_statistics;

        swift::misc::simulation::CCategoryMatcher m_categoryMatcher;

        QString m_modelSetInfo;

    };


} // namespace swift::core


#endif // SWIFT_CORE_AIRCRAFTMATCHER_H

aircraftmatchersetup.h

aircraftmodellist.h

swift::misc::simulation::ScoredModels
QMultiMap< int, CAircraftModel > ScoredModels
Individual (matching) score for each model.
Definition aircraftmodellist.h:51

aircraftmodelsetprovider.h

categorymatcher.h

swift::core::CAircraftMatcher::setupChanged
void setupChanged()
Setup changed.

swift::core::CAircraftMatcher::getCurrentStatistics
const swift::misc::simulation::CMatchingStatistics & getCurrentStatistics() const
The current statistics.
Definition aircraftmatcher.h:305

swift::core::CAircraftMatcher::getModelSetCount
int getModelSetCount() const
Model set count.
Definition aircraftmatcher.h:277

swift::core::CAircraftMatcher::clearMatchingStatistics
void clearMatchingStatistics()
Clear the statistics.
Definition aircraftmatcher.h:308

swift::core::CAircraftMatcher::getModelSet
swift::misc::simulation::CAircraftModelList getModelSet() const
Get the model set models.
Definition aircraftmatcher.h:271

swift::core::CAircraftMatcher::getSetup
swift::misc::simulation::CAircraftMatcherSetup getSetup() const
Get the setup.
Definition aircraftmatcher.h:69

swift::core::CAircraftMatcher::operator=
CAircraftMatcher & operator=(const CAircraftMatcher &)=delete
Copy assignment operator.

swift::core::CAircraftMatcher::getDefaultModel
const swift::misc::simulation::CAircraftModel & getDefaultModel() const
Default model.
Definition aircraftmatcher.h:299

swift::core::CAircraftMatcher::getModelSetRef
virtual const swift::misc::simulation::CAircraftModelList & getModelSetRef() const
Model set as reference.
Definition aircraftmatcher.h:274

swift::core::CAircraftMatcher::CAircraftMatcher
CAircraftMatcher(const CAircraftMatcher &)=delete
Copy constructor.

swift::core::CAircraftMatcher::getDisabledModelsForMatching
swift::misc::simulation::CAircraftModelList getDisabledModelsForMatching() const
The disabled models for matching.
Definition aircraftmatcher.h:293

swift::core::CAircraftMatcher::CAircraftMatcher
CAircraftMatcher(const swift::misc::simulation::CAircraftMatcherSetup &setup, QObject *parent=nullptr)
Constructor.
Definition aircraftmatcher.cpp:42

swift::core::CAircraftMatcher::setSetup
bool setSetup(const swift::misc::simulation::CAircraftMatcherSetup &setup)
Set the setup.
Definition aircraftmatcher.cpp:57

swift::core::CAircraftMatcher::hasModels
bool hasModels() const
Models.
Definition aircraftmatcher.h:280

swift::core::CAircraftMatcher::getLogCategories
static const QStringList & getLogCategories()
Log categories.
Definition aircraftmatcher.cpp:36

swift::misc::CLogCategoryList
A sequence of log categories.
Definition logcategorylist.h:35

swift::misc::CStatusMessageList
Status messages, e.g. from Core -> GUI.
Definition statusmessagelist.h:33

swift::misc::aviation::CAircraftIcaoCode
Value object for ICAO classification.
Definition aircrafticaocode.h:32

swift::misc::aviation::CAircraftIcaoCodeList
Value object encapsulating a list of ICAO codes.
Definition aircrafticaocodelist.h:32

swift::misc::aviation::CAirlineIcaoCode
Value object for ICAO classification.
Definition airlineicaocode.h:33

swift::misc::aviation::CCallsign
Value object encapsulating information of a callsign.
Definition callsign.h:30

swift::misc::aviation::CLivery
Value object encapsulating information about an airpot.
Definition livery.h:29

swift::misc::simulation::CAircraftMatcherSetup
Matcher settings.
Definition aircraftmatchersetup.h:18

swift::misc::simulation::CAircraftModel
Aircraft model (used by another pilot, my models on disk).
Definition aircraftmodel.h:71

swift::misc::simulation::CAircraftModel::ModelType
ModelType
Model type.
Definition aircraftmodel.h:75

swift::misc::simulation::CAircraftModelList
Value object encapsulating a list of aircraft models.
Definition aircraftmodellist.h:60

swift::misc::simulation::CCategoryMatcher
Category matcher, uses the DB categories.
Definition categorymatcher.h:24

swift::misc::simulation::CMatchingStatistics
Value object for matching statistics.
Definition matchingstatistics.h:25

swift::misc::simulation::CSimulatedAircraft
Comprehensive information of an aircraft.
Definition simulatedaircraft.h:60

swift::misc::simulation::CSimulatorInfo
Simple hardcoded info about the corresponding simulator.
Definition simulatorinfo.h:41

swift::misc::simulation::IAircraftModelSetProvider
Value object encapsulating a list of aircraft models.
Definition aircraftmodelsetprovider.h:17

matchinglog.h

matchingscriptmisc.h

swift::misc::simulation::MatchingScript
MatchingScript
Matching script type.
Definition matchingscriptmisc.h:16

matchingstatistics.h

swift::core
Backend services of the swift project, like dealing with the network or the simulators.
Definition actionbind.cpp:7

swift::misc
Free functions in swift::misc.
Definition aircraftmatcher.h:22

QObject::QObject
QObject(QObject *parent)

QObject::Q_INTERFACES
Q_INTERFACES(...)

QObject::Q_OBJECT
Q_OBJECTQ_OBJECT

QObject::parent
QObject * parent() const const

QString

QStringList

swift::misc::simulation::DBTripleIds
DB ids.
Definition aircraftmodel.h:50

swift::misc::simulation::MatchingScriptReturnValues
Return values.
Definition matchingscriptmisc.h:26

swiftcoreexport.h

SWIFT_CORE_EXPORT
#define SWIFT_CORE_EXPORT
Export a class or function from the library.
Definition swiftcoreexport.h:20