livery.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_AVIATION_LIVERY_H
#define SWIFT_MISC_AVIATION_LIVERY_H
 
#include <QJsonObject>
#include <QMap>
#include <QMetaType>
#include <QString>
 
#include "misc/aviation/airlineicaocode.h"
#include "misc/db/datastore.h"
#include "misc/metaclass.h"
#include "misc/propertyindexref.h"
#include "misc/rgbcolor.h"
#include "misc/statusmessagelist.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::aviation, CLivery)
 
namespace swift::misc::aviation
{
    class SWIFT_MISC_EXPORT CLivery : public CValueObject<CLivery>, public db::IDatastoreObjectWithIntegerKey
    {
    public:
        enum ColumnIndex
        {
            IndexDescription = CPropertyIndexRef::GlobalIndexCLivery,
            IndexAirlineIcaoCode,
            IndexCombinedCode,
            IndexColorFuselage,
            IndexColorTail,
            IndexIsMilitary
        };
 
        CLivery();
 
        CLivery(const QString &combinedCode, const CAirlineIcaoCode &airline, const QString &description);
 
        CLivery(const QString &combinedCode, const CAirlineIcaoCode &airline, const QString &description,
                const QString &colorFuselage, const QString &colorTail, bool isMilitary);
 
        CLivery(const QString &combinedCode, const CAirlineIcaoCode &airline, const QString &description,
                const CRgbColor &colorFuselage, const CRgbColor &colorTail, bool isMilitary);
 
        CLivery(int dbKey, const QString &combinedCode, const CAirlineIcaoCode &airline, const QString &description,
                const QString &colorFuselage, const QString &colorTail, bool isMilitary);
 
        CLivery(int dbKey, const QString &combinedCode, const CAirlineIcaoCode &airline, const QString &description,
                const CRgbColor &colorFuselage, const CRgbColor &colorTail, bool isMilitary);
 
        const CAirlineIcaoCode &getAirlineIcaoCode() const { return m_airline; }
 
        const QString &getAirlineIcaoCodeDesignator() const { return m_airline.getDesignator(); }
 
        const QString &getCombinedCode() const { return m_combinedCode; }
 
        QString getCombinedCodePlusInfo() const;
 
        QString getCombinedCodePlusId() const;
 
        QString getCombinedCodePlusInfoAndId() const;
 
        const QString &getDescription() const { return m_description; }
 
        const QString &getAirlineName() const { return this->getAirlineIcaoCode().getName(); }
 
        bool isContainedInSimplifiedAirlineName(const QString &candidate) const;
 
        const CRgbColor &getColorFuselage() const { return m_colorFuselage; }
 
        const CRgbColor &getColorTail() const { return m_colorTail; }
 
        bool isMilitary() const { return m_military; }
 
        bool setAirlineIcaoCode(const CAirlineIcaoCode &airlineIcao);
 
        bool setAirlineIcaoCodeDesignator(const QString &airlineIcaoDesignator);
 
        void setCombinedCode(const QString &code) { m_combinedCode = code.trimmed().toUpper(); }
 
        void setColorFuselage(const CRgbColor &color) { m_colorFuselage = color; }
 
        void setColorTail(const CRgbColor &color) { m_colorTail = color; }
 
        bool hasColorFuselage() const;
 
        bool hasColorTail() const;
 
        bool hasValidColors() const;
 
        void setDescription(const QString &description) { m_description = description; }
 
        void setMilitary(bool isMilitary) { m_military = isMilitary; }
 
        bool matchesCombinedCode(const QString &candidate) const;
 
        bool matchesColors(const CRgbColor &fuselage, const CRgbColor &tail) const;
 
        QVariant propertyByIndex(CPropertyIndexRef index) const;
 
        void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
 
        int comparePropertyByIndex(CPropertyIndexRef index, const CLivery &compareValue) const;
 
        QString convertToQString(bool i18n = false) const;
 
        bool hasCompleteData() const;
 
        CStatusMessageList validate() const;
 
        bool hasValidAirlineDesignator() const;
 
        bool hasAirlineName() const;
 
        bool hasCombinedCode() const;
 
        bool isAirlineLivery() const;
 
        bool isAirlineOperating() const;
 
        bool isAirlineStandardLivery() const;
 
        bool isColorLivery() const;
 
        double getColorDistance(const CLivery &otherLivery) const;
 
        double getColorDistance(const CRgbColor &fuselage, const CRgbColor &tail) const;
 
        void updateMissingParts(const CLivery &otherLivery);
 
        QString asHtmlSummary(const QString &separator) const;
 
        int calculateScore(const CLivery &otherLivery, bool preferColorLiveries = false,
                           CStatusMessageList *log = nullptr) const;
 
        bool isNull() const;
 
        static const CLivery &null();
 
        static CLivery fromDatabaseJson(const QJsonObject &json, const QString &prefix = QString("liv_"));
 
        static CLivery fromDatabaseJsonCaching(const QJsonObject &json, AirlineIcaoIdMap &airlineIcaos,
                                               const QString &prefix = QString("liv_"));
 
        static bool isValidCombinedCode(const QString &candidate);
 
        static const QString &standardLiveryMarker();
 
        static QString getStandardCode(const aviation::CAirlineIcaoCode &airline);
 
        static const QString &colorLiveryMarker();
 
        static const QString &tempLiveryCode();
 
        static CStatusMessage logMessage(const CLivery &livery, const QString &message,
                                         const QStringList &extraCategories = {},
                                         CStatusMessage::StatusSeverity s = CStatusMessage::SeverityInfo);
 
        static void addLogDetailsToList(CStatusMessageList *log, const CLivery &livery, const QString &message,
                                        const QStringList &extraCategories = {},
                                        CStatusMessage::StatusSeverity s = CStatusMessage::SeverityInfo);
 
    private:
        CAirlineIcaoCode m_airline; 
        QString m_combinedCode; 
        QString m_description; 
        CRgbColor m_colorFuselage; 
        CRgbColor m_colorTail; 
        bool m_military = false; 
 
        SWIFT_METACLASS(
            CLivery,
            SWIFT_METAMEMBER(dbKey),
            SWIFT_METAMEMBER(timestampMSecsSinceEpoch),
            SWIFT_METAMEMBER(airline),
            SWIFT_METAMEMBER(combinedCode, 0, CaseInsensitiveComparison),
            SWIFT_METAMEMBER(description),
            SWIFT_METAMEMBER(colorFuselage),
            SWIFT_METAMEMBER(colorTail),
            SWIFT_METAMEMBER(military));
    };
 
    using LiveryIdMap = QMap<int, CLivery>;
 
} // namespace swift::misc::aviation
 
Q_DECLARE_METATYPE(swift::misc::aviation::CLivery)
 
#endif // SWIFT_MISC_AVIATION_LIVERY_H