aircraftmatchersetup.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2018 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_SIMULATION_AIRCRAFTMATCHERSETUP_H
#define SWIFT_MISC_SIMULATION_AIRCRAFTMATCHERSETUP_H
 
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::Simulation, CAircraftMatcherSetup)
 
namespace swift::misc::simulation
{
    class SWIFT_MISC_EXPORT CAircraftMatcherSetup : public CValueObject<CAircraftMatcherSetup>
    {
    public:
        enum MatchingAlgorithm
        {
            MatchingScoreBased,
            MatchingStepwiseReducePlusScoreBased,
            MatchingStepwiseReduce,
        };
 
        enum MatchingModeFlag
        {
            ByModelString = 1 << 0, 
            ByIcaoData = 1 << 1, 
            ByFamily = 1 << 2,
            ByLivery = 1 << 3,
            ByCombinedType = 1 << 4,
            ByManufacturer = 1 << 5,
            ByMilitary = 1 << 6, 
            ByCivilian = 1 << 7, 
            ByMilOrCivilian = ByCivilian | ByMilitary,
            ByVtol = 1 << 8,
            ByIcaoOrderAircraftFirst = (1 << 9) | ByIcaoData,
            ByIcaoOrderAirlineFirst = (1 << 10) | ByIcaoData,
            ByAirlineGroupSameAsAirline = (1 << 11) | ByIcaoData,
            ByAirlineGroupIfNoAirline = (1 << 12) | ByIcaoData,
 
            // --- exclusion ---
            ExcludeNoDbData = 1 << 13,
            ExcludeNoExcluded = 1 << 14,
            ExcludeDefault = ExcludeNoExcluded | ExcludeNoDbData,
 
            // --- model set ---
            ModelSetRemoveFailedModel = 1 << 15,
            ModelVerificationAtStartup = 1 << 16,
            ModelFailoverIfNoModelCanBeAdded = 1 << 17,
            ModelVerificationOnlyWarnError = 1 << 18, // later added, hence 18
 
            // --- categories ---
            ByCategoryGlider = 1 << 20,
            ByCategoryMilitary = 1 << 21,
            ByCategorySmallAircraft = 1 << 22,
 
            // --- reverse lookup ---
            ReverseLookupModelString = 1 << 25,
            ReverseLookupSwiftLiveryIds = 1 << 26,
            ReverseLookupDefault = ReverseLookupModelString | ReverseLookupSwiftLiveryIds,
 
            // --- score based matching ---
            ScoreIgnoreZeros = 1 << 28, 
            ScorePreferColorLiveries = 1 << 29, 
 
            // --- others ---
            ModeNone = 0,
            ModeByFLags = ByMilOrCivilian | ByVtol,
 
            // default mode for set handling
            ModeDefaultSet = ModelSetRemoveFailedModel | ModelVerificationAtStartup | ModelFailoverIfNoModelCanBeAdded,
 
            // default depending on algorithm
            ModeDefaultScore = ScoreIgnoreZeros | ScorePreferColorLiveries | ExcludeDefault | ReverseLookupDefault,
            ModeDefaultReduce = ModeByFLags | ByModelString | ByFamily | ByManufacturer | ByCombinedType |
                                ByIcaoOrderAircraftFirst | ByAirlineGroupIfNoAirline | ReverseLookupDefault |
                                ExcludeDefault | ByLivery,
            ModeDefaultReducePlusScore = ModeByFLags | ByModelString | ByFamily | ByManufacturer | ByCombinedType |
                                         ByIcaoOrderAircraftFirst | ByAirlineGroupIfNoAirline | ReverseLookupDefault |
                                         ExcludeDefault | ModeDefaultScore,
        };
        Q_DECLARE_FLAGS(MatchingMode, MatchingModeFlag)
 
        
        enum ForceModeFlag
        {
            ForceNothing = 0,
            ForceType = 1 << 0,
            ForceEnginecount = 1 << 1,
            ForceEngine = 1 << 2
        };
        Q_DECLARE_FLAGS(ForceMode, ForceModeFlag)
 
        
        enum PickSimilarStrategy
        {
            PickFirst,
            PickRandom,
            PickByOrder
        };
 
        enum ColumnIndex
        {
            IndexMatchingAlgorithm = CPropertyIndexRef::GlobalIndexCAircraftMatcherSetup,
            IndexMatchingMode,
            IndexForceMode,
            IndexPickStrategy,
            IndexMsNetworkEntryFile,
            IndexMsMatchingStageFile,
            IndexMsNetworkEnabled,
            IndexMsMatchingStageEnabled
        };
 
        CAircraftMatcherSetup();
 
        CAircraftMatcherSetup(MatchingAlgorithm algorithm);
 
        CAircraftMatcherSetup(MatchingAlgorithm algorithm, MatchingMode mode, PickSimilarStrategy pickStrategy);
 
        MatchingAlgorithm getMatchingAlgorithm() const { return static_cast<MatchingAlgorithm>(m_algorithm); }
 
        const QString &getMatchingAlgorithmAsString() const { return algorithmToString(this->getMatchingAlgorithm()); }
 
        bool setMatchingAlgorithm(MatchingAlgorithm algorithm, bool reset = true);
 
        MatchingMode getMatchingMode() const { return static_cast<MatchingMode>(m_mode); }
 
        ForceMode getForceMode() const { return static_cast<ForceMode>(m_force); }
 
        void setForceMode(ForceMode fm) { m_force = static_cast<int>(fm); }
 
        QString getForceModeAsString() const { return forceToString(this->getForceMode()); }
 
        bool isReverseLookupModelString() const;
        bool isReverseLookupSwiftLiveryIds() const;
        void resetReverseLookup();
 
        bool isDbDataOnly() const { return this->getMatchingMode().testFlag(ExcludeNoDbData); }
 
        const QString &getMsReverseLookupFile() const { return m_msReverseLookupFile; }
        const QString &getMsMatchingStageFile() const { return m_msMatchingStageFile; }
 
        void setMsReverseLookupFile(const QString &file) { m_msReverseLookupFile = file; }
        void setMsMatchingStageFile(const QString &file) { m_msMatchingStageFile = file; }
 
        bool isMsReverseLookupEnabled() const { return m_msReverseEnabled; }
        bool isMsMatchingStageEnabled() const { return m_msMatchingEnabled; }
 
        bool doRunMsReverseLookupScript() const;
        bool doRunMsMatchingStageScript() const;
 
        void setMsReverseLookupEnabled(bool enabled) { m_msReverseEnabled = enabled; }
        void setMsMatchingStageEnabled(bool enabled) { m_msMatchingEnabled = enabled; }
 
        bool doVerificationAtStartup() const { return this->getMatchingMode().testFlag(ModelVerificationAtStartup); }
 
        bool onlyShowVerificationWarningsAndErrors() const
        {
            return this->getMatchingMode().testFlag(ModelVerificationOnlyWarnError);
        }
 
        bool doModelAddFailover() const { return this->getMatchingMode().testFlag(ModelFailoverIfNoModelCanBeAdded); }
 
        void setVerificationAtStartup(bool verify);
 
        void setOnlyShowVerificationWarningsAndErrors(bool only);
 
        QString getMatchingModeAsString() const { return modeToString(this->getMatchingMode()); }
 
        void setMatchingMode(MatchingMode mode) { m_mode = static_cast<int>(mode); }
 
        bool removeFromSetIfFailed() const { return this->getMatchingMode().testFlag(ModelSetRemoveFailedModel); }
 
        PickSimilarStrategy getPickStrategy() const { return static_cast<PickSimilarStrategy>(m_strategy); }
 
        const QString &getPickStrategyAsString() const { return strategyToString(this->getPickStrategy()); }
 
        void setPickStrategy(PickSimilarStrategy strategy) { m_strategy = static_cast<int>(strategy); }
 
        void setAirlineGroupBehaviour(bool ifNoAirline, bool sameAsAirline);
 
        QString convertToQString(bool i18n = false) const;
 
        QVariant propertyByIndex(CPropertyIndexRef index) const;
 
        void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
 
        void reset();
 
        void reset(MatchingAlgorithm algorithm);
 
        bool useCategoryMatching() const;
 
        static const QString &algorithmToString(MatchingAlgorithm algorithm);
 
        static const QString &modeFlagToString(MatchingModeFlag modeFlag);
 
        static QString modeToString(MatchingMode mode);
 
        static const QString &forceFlagToString(ForceModeFlag forceFlag);
 
        static QString forceToString(ForceMode force);
 
        static const QString &strategyToString(PickSimilarStrategy strategy);
 
        static MatchingMode matchingMode(bool revModelString, bool revLiveryIds, bool byModelString,
                                         bool byIcaoDataAircraft1st, bool byIcaoDataAirline1st, bool byFamily,
                                         bool byLivery, bool byCombinedType, bool byForceMilitary, bool byForceCivilian,
                                         bool byVtol, bool byGliderCategory, bool byMilitaryCategory,
                                         bool bySmallAircraftCategory, bool scoreIgnoreZeros,
                                         bool scorePreferColorLiveries, bool excludeNoDbData, bool excludeNoExcluded,
                                         bool modelVerification, bool modelVerificationWarnError,
                                         bool modelSetRemoveFailedModel, bool modelFailover);
 
    private:
        int m_algorithm = static_cast<int>(MatchingStepwiseReducePlusScoreBased);
        int m_mode = static_cast<int>(ModeDefaultReducePlusScore);
        int m_strategy = static_cast<int>(PickByOrder);
        int m_force = static_cast<int>(ForceNothing);
        QString m_msReverseLookupFile; 
        QString m_msMatchingStageFile; 
        bool m_msReverseEnabled = false; 
        bool m_msMatchingEnabled = false; 
 
        SWIFT_METACLASS(
            CAircraftMatcherSetup,
            SWIFT_METAMEMBER(algorithm),
            SWIFT_METAMEMBER(mode),
            SWIFT_METAMEMBER(strategy),
            SWIFT_METAMEMBER(force),
            SWIFT_METAMEMBER(msReverseLookupFile),
            SWIFT_METAMEMBER(msMatchingStageFile),
            SWIFT_METAMEMBER(msReverseEnabled),
            SWIFT_METAMEMBER(msMatchingEnabled));
    };
} // namespace swift::misc::simulation
 
Q_DECLARE_METATYPE(swift::misc::simulation::CAircraftMatcherSetup)
Q_DECLARE_METATYPE(swift::misc::simulation::CAircraftMatcherSetup::MatchingAlgorithm)
Q_DECLARE_METATYPE(swift::misc::simulation::CAircraftMatcherSetup::MatchingMode)
Q_DECLARE_METATYPE(swift::misc::simulation::CAircraftMatcherSetup::MatchingModeFlag)
Q_DECLARE_METATYPE(swift::misc::simulation::CAircraftMatcherSetup::ForceMode)
Q_DECLARE_METATYPE(swift::misc::simulation::CAircraftMatcherSetup::ForceModeFlag)
Q_DECLARE_METATYPE(swift::misc::simulation::CAircraftMatcherSetup::PickSimilarStrategy)
Q_DECLARE_OPERATORS_FOR_FLAGS(swift::misc::simulation::CAircraftMatcherSetup::MatchingMode)
 
#endif // SWIFT_MISC_SIMULATION_AIRCRAFTMATCHERSETUP_H