matchingscript.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2019 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_SIMULATION_MATCHINGSCRIPT_H
#define SWIFT_MISC_SIMULATION_MATCHINGSCRIPT_H
 
#include <QObject>
#include <QString>
 
#include "misc/aviation/aircrafticaocode.h"
#include "misc/aviation/airlineicaocode.h"
#include "misc/aviation/livery.h"
#include "misc/simulation/aircraftmodellist.h"
#include "misc/swiftmiscexport.h"
 
namespace swift::misc::simulation
{
    class SWIFT_MISC_EXPORT MSInOutValues : public QObject
    {
        Q_OBJECT
 
        Q_PROPERTY(QString callsign READ getCallsign WRITE setCallsign NOTIFY callsignChanged)
        Q_PROPERTY(QString callsignAsSet READ getCallsignAsSet)
        Q_PROPERTY(QString flightNumber READ getFlightNumber)
        Q_PROPERTY(
            int dbAircraftIcaoId READ getDbAircraftIcaoId WRITE setDbAircraftIcaoId NOTIFY dbAircraftIcaoIdChanged)
        Q_PROPERTY(int dbAirlineIcaoId READ getDbAirlineIcaoId WRITE setDbAirlineIcaoId NOTIFY dbAirlineIcaoIdChanged)
        Q_PROPERTY(int dbLiveryId READ getDbLiveryId WRITE setDbLiveryId NOTIFY dbLiveryIdChanged)
        Q_PROPERTY(int dbModelId READ getDbModelId WRITE setDbModelId NOTIFY dbModelIdChanged)
        Q_PROPERTY(QString aircraftIcao READ getAircraftIcao WRITE setAircraftIcao NOTIFY aircraftIcaoChanged)
        Q_PROPERTY(QString aircraftFamily READ getAircraftFamily)
        Q_PROPERTY(QString airlineIcao READ getAirlineIcao WRITE setAirlineIcao NOTIFY airlineIcaoChanged)
        Q_PROPERTY(QString virtualAirlineIcao READ getVirtualAirlineIcao WRITE setVirtualAirlineIcao NOTIFY
                       virtualAirlineIcaoChanged)
        Q_PROPERTY(QString livery READ getLivery WRITE setLivery NOTIFY liveryChanged)
        Q_PROPERTY(QString modelString READ getModelString WRITE setModelString NOTIFY modelStringChanged)
        Q_PROPERTY(QString combinedType READ getCombinedType WRITE setCombinedType NOTIFY combinedTypeChanged)
        Q_PROPERTY(QString logMessage READ getLogMessage WRITE setLogMessage NOTIFY logMessageChanged)
        Q_PROPERTY(bool hasAircraftFamily READ hasAircraftFamily)
        Q_PROPERTY(bool modified READ isModified WRITE setModified NOTIFY modifiedChanged)
        Q_PROPERTY(bool rerun READ isRerun WRITE setRerun NOTIFY rerunChanged)
        // ----- status values -------
        Q_PROPERTY(bool hasAirlineIcao READ hasAirlineIcao)
        Q_PROPERTY(bool hasAircraftIcao READ hasAircraftIcao)
        Q_PROPERTY(bool hasModifiedAircraftIcaoDesignator READ hasModifiedAircraftIcaoDesignator)
        Q_PROPERTY(bool hasModifiedAircraftFamily READ hasModifiedAircraftFamily)
        Q_PROPERTY(bool hasModifiedAirlineIcaoDesignator READ hasModifiedAirlineIcaoDesignator)
        Q_PROPERTY(bool hasUnmodifiedDesignators READ hasUnmodifiedDesignators)
 
    public:
        Q_INVOKABLE MSInOutValues() {}
 
        Q_INVOKABLE MSInOutValues(const QString &cs, const QString &csAsSet, const QString &flightNumber,
                                  const QString &aircraftIcao, const QString &aircraftFamily,
                                  const QString &combinedType, int idAircraftIcao, const QString &airlineIcao,
                                  const QString &virtualAirlineIcao, int idAirlineIcao, const QString &livery,
                                  int liveryId, const QString &logMsg = {}, bool modified = false, bool rerun = false)
            : m_callsign(cs.trimmed().toUpper()), m_callsignAsSet(csAsSet), m_flightNumber(flightNumber),
              m_aircraftIcao(aircraftIcao.trimmed().toUpper()), m_aircraftFamily(aircraftFamily.trimmed().toUpper()),
              m_combinedType(combinedType.trimmed().toUpper()), m_airlineIcao(airlineIcao.trimmed().toUpper()),
              m_vAirlineIcao(virtualAirlineIcao), m_livery(livery.trimmed().toUpper()),
              m_dbAircraftIcaoId(idAircraftIcao), m_dbAirlineIcaoId(idAirlineIcao), m_dbLiveryId(liveryId),
              m_logMessage(logMsg), m_modified(modified), m_rerun(rerun)
        {}
 
        MSInOutValues(const swift::misc::aviation::CCallsign &cs,
                      const swift::misc::aviation::CAircraftIcaoCode &aircraftIcao,
                      const swift::misc::aviation::CAirlineIcaoCode &airlineIcao, const QString &livery, int liveryId);
 
        MSInOutValues(const swift::misc::aviation::CCallsign &cs,
                      const swift::misc::aviation::CAircraftIcaoCode &aircraftIcao,
                      const swift::misc::aviation::CLivery &livery);
 
        MSInOutValues(const swift::misc::simulation::CAircraftModel &model);
 
        MSInOutValues(const MSInOutValues &sv);
 
        const QString &getCallsign() const { return m_callsign; }
        const QString &getCallsignAsSet() const { return m_callsignAsSet; }
        const QString &getFlightNumber() const { return m_flightNumber; }
        void setCallsign(const QString &callsign);
 
        bool isFoundDbAircraftIcao() const { return m_dbAircraftIcaoId >= 0; }
        bool isFoundDbAirlineIcao() const { return m_dbAirlineIcaoId >= 0; }
        bool isFoundDbLivery() const { return m_dbLiveryId >= 0; }
        bool isFoundDbModel() const { return m_dbModelId >= 0; }
        int getDbAircraftIcaoId() const { return m_dbAircraftIcaoId; }
        int getDbAirlineIcaoId() const { return m_dbAirlineIcaoId; }
        int getDbLiveryId() const { return m_dbLiveryId; }
        int getDbModelId() const { return m_dbModelId; }
        void setDbAircraftIcaoId(int id);
        void setDbAirlineIcaoId(int id);
        void setDbLiveryId(int id);
        void setDbModelId(int id);
 
        const QString &getAircraftIcao() const { return m_aircraftIcao; }
        const QString &getAircraftFamily() const { return m_aircraftFamily; }
        const QString &getAirlineIcao() const { return m_airlineIcao; }
        const QString &getVirtualAirlineIcao() const { return m_vAirlineIcao; }
        const QString &getLivery() const { return m_livery; }
        const QString &getModelString() const { return m_modelString; }
        const QString &getCombinedType() const { return m_combinedType; }
        void setAircraftIcao(const QString &aircraftIcao);
        void setAirlineIcao(const QString &airlineIcao);
        void setVirtualAirlineIcao(const QString &virtualAirlineIcao);
        void setLivery(const QString &livery);
        void setModelString(const QString &modelString);
        void setCombinedType(const QString &type);
        bool hasAircraftIcao() const { return !m_aircraftIcao.isEmpty(); }
        bool hasAirlineIcao() const { return !m_airlineIcao.isEmpty(); }
        bool hasAircraftFamily() const { return !m_aircraftFamily.isEmpty(); }
 
        const QString &getLogMessage() const { return m_logMessage; }
        void setLogMessage(const QString &msg);
 
        bool isModified() const { return m_modified; }
        void setModified(bool modified);
 
        bool isRerun() const { return m_rerun; }
        void setRerun(bool rerun);
 
        void evaluateChanges(const swift::misc::aviation::CAircraftIcaoCode &aircraft,
                             const swift::misc::aviation::CAirlineIcaoCode &airline);
 
        bool hasModifiedAircraftIcaoDesignator() const { return m_modifiedAircraftDesignator; }
        bool hasModifiedAirlineIcaoDesignator() const { return m_modifiedAirlineDesignator; }
        bool hasModifiedAircraftFamily() const { return m_modifiedAircraftFamily; }
        bool hasUnmodifiedDesignators() const
        {
            return !this->hasModifiedAirlineIcaoDesignator() && !this->hasModifiedAircraftIcaoDesignator();
        }
        bool hasChangedAircraftIcao(const swift::misc::aviation::CAircraftIcaoCode &aircraftIcao) const;
        bool hasChangedAircraftIcaoId(const swift::misc::aviation::CAircraftIcaoCode &aircraftIcao) const;
        bool hasChangedAirlineIcao(const swift::misc::aviation::CAirlineIcaoCode &airlineIcao) const;
        bool hasChangedAirlineIcaoId(const swift::misc::aviation::CAirlineIcaoCode &airlineIcao) const;
        bool hasChangedModelString(const QString &modelString) const;
        bool hasChangedLiveryId(const swift::misc::aviation::CLivery &livery) const;
        bool hasChangedModelId(const swift::misc::simulation::CAircraftModel &model) const;
        bool hasChangedModel(const swift::misc::simulation::CAircraftModel &model) const;
 
    signals:
        void callsignChanged();
 
        void aircraftIcaoChanged();
        void airlineIcaoChanged();
        void virtualAirlineIcaoChanged();
        void liveryChanged();
        void modelStringChanged();
        void combinedTypeChanged();
 
        void dbAircraftIcaoIdChanged();
        void dbAirlineIcaoIdChanged();
        void dbLiveryIdChanged();
        void dbModelIdChanged();
 
        void logMessageChanged();
 
        void modifiedChanged();
 
        void rerunChanged();
 
    private:
        QString m_callsign;
        QString m_callsignAsSet;
        QString m_flightNumber;
        QString m_aircraftIcao;
        QString m_aircraftFamily;
        QString m_combinedType;
        QString m_airlineIcao;
        QString m_vAirlineIcao;
        QString m_livery;
        QString m_modelString;
        int m_dbAircraftIcaoId = -1;
        int m_dbAirlineIcaoId = -1;
        int m_dbLiveryId = -1;
        int m_dbModelId = -1;
        QString m_logMessage;
        bool m_modifiedAircraftDesignator = false;
        bool m_modifiedAircraftFamily = false;
        bool m_modifiedAirlineDesignator = false;
        bool m_modified = false;
        bool m_rerun = false;
    };
 
    class SWIFT_MISC_EXPORT MSModelSet : public QObject
    {
        Q_OBJECT
 
        Q_PROPERTY(QString simulator READ getSimulator WRITE setSimulator NOTIFY simulatorChanged)
        Q_PROPERTY(bool available READ isAvailable WRITE setAvailable NOTIFY availabilityChanged)
        Q_PROPERTY(int inputAircraftAndAirlineCount READ getInputAircraftAndAirlineCount WRITE
                       setInputAircraftAndAirlineCount NOTIFY inputAircraftAndAirlineCountChanged)
        Q_PROPERTY(int modelSetSize READ getModelSetSize)
        Q_PROPERTY(int countDifferentAirlines READ countVtolAircraft)
        Q_PROPERTY(int countVtolAircraft READ countCivilianAircraft)
        Q_PROPERTY(int countCivilianAircraft READ countCivilianAircraft)
        Q_PROPERTY(int countMilitaryAircraft READ countMilitaryAircraft)
        Q_PROPERTY(int countModelsWithColorLivery READ countModelsWithColorLivery)
        Q_PROPERTY(int countModelsWithAirlineLivery READ countModelsWithAirlineLivery)
 
    public:
        Q_INVOKABLE MSModelSet() {}
 
        const QString &getSimulator() const { return m_simulator; }
 
        void setSimulator(const QString &simulator);
 
        bool isAvailable() const { return m_available; }
        void setAvailable(bool available);
 
        int getInputAircraftAndAirlineCount() const { return m_inputAircraftAndAirlineCount; }
        void setInputAircraftAndAirlineCount(int count);
 
        int getModelSetSize() const { return m_modelSet.size(); }
        int countDifferentAirlines() const { return m_modelSet.countDifferentAirlines(); }
        int countVtolAircraft() const { return m_modelSet.countVtolAircraft(); }
        int countCivilianAircraft() const { return m_modelSet.countCivilianAircraft(); }
        int countMilitaryAircraft() const { return m_modelSet.countMilitaryAircraft(); }
        int countModelsWithColorLivery() const { return m_modelSet.countModelsWithColorLivery(); }
        int countModelsWithAirlineLivery() const { return m_modelSet.countModelsWithAirlineLivery(); }
 
        Q_INVOKABLE bool containsModelString(const QString &modelString) const
        {
            return m_modelSet.containsModelString(modelString, Qt::CaseInsensitive);
        }
        Q_INVOKABLE bool containsDbKey(int dbKey) const { return m_modelSet.containsDbKey(dbKey); }
        Q_INVOKABLE bool containsCombinedType(const QString &ct) const { return m_modelSet.containsCombinedType(ct); }
 
        Q_INVOKABLE QString findCombinedTypeWithClosestColorLivery(const QString &combinedType,
                                                                   const QString &rgbColor) const;
 
        Q_INVOKABLE QString findClosestCombinedTypeWithClosestColorLivery(const QString &combinedType,
                                                                          const QString &rgbColor) const;
 
        Q_INVOKABLE QString findAircraftFamilyWithClosestColorLivery(const QString &family,
                                                                     const QString &rgbColor) const;
 
        // ------- NOT EXPOSED TO JAVASCRIPT -------
 
        MSModelSet(const swift::misc::simulation::CAircraftModelList &modelSet);
 
        void initByModelSet(const swift::misc::simulation::CAircraftModelList &modelSet);
 
        void initByAircraftAndAirline(const swift::misc::aviation::CAircraftIcaoCode &aircraft,
                                      const swift::misc::aviation::CAirlineIcaoCode &airline);
 
        // ------- NOT EXPOSED TO JAVASCRIPT -------
 
    signals:
        void simulatorChanged();
 
        void availabilityChanged();
 
        void inputAircraftAndAirlineCountChanged();
 
    private:
        QString m_simulator;
        bool m_available = false;
        int m_inputAircraftAndAirlineCount; 
        swift::misc::simulation::CAircraftModelList m_modelSet;
    };
 
} // namespace swift::misc::simulation
 
#endif // SWIFT_MISC_SIMULATION_MATCHINGSCRIPT_H