airlineicaocode.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_AVIATION_AIRLINEICAOCODE_H
#define SWIFT_MISC_AVIATION_AIRLINEICAOCODE_H
 
#include <QJsonObject>
#include <QMap>
#include <QMetaType>
#include <QSet>
#include <QString>
 
#include "misc/country.h"
#include "misc/db/datastore.h"
#include "misc/metaclass.h"
#include "misc/propertyindexref.h"
#include "misc/statusmessagelist.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::aviation, CAirlineIcaoCode)
 
namespace swift::misc::aviation
{
    class CCallsign;
 
    class SWIFT_MISC_EXPORT CAirlineIcaoCode :
        public CValueObject<CAirlineIcaoCode>,
        public db::IDatastoreObjectWithIntegerKey
    {
    public:
        enum ColumnIndex
        {
            IndexAirlineDesignator = CPropertyIndexRef::GlobalIndexCAirlineIcaoCode,
            IndexIataCode,
            IndexAirlineName,
            IndexAirlineCountryIso,
            IndexAirlineCountry,
            IndexTelephonyDesignator,
            IndexGroupId,
            IndexGroupName,
            IndexGroupDesignator,
            IndexIsVirtualAirline,
            IndexIsOperating,
            IndexIsMilitary,
            IndexDesignatorNameCountry,
        };
 
        CAirlineIcaoCode() = default;
 
        CAirlineIcaoCode(const QString &airlineDesignator);
 
        CAirlineIcaoCode(const QString &airlineDesignator, const QString &airlineName, const CCountry &country,
                         const QString &telephony, bool virtualAirline, bool operating);
 
        const QString &getDesignator() const { return m_designator; }
 
        QString getVDesignator() const;
 
        QString getVDesignatorDbKey() const;
 
        void setDesignator(const QString &icaoDesignator);
 
        const QString &getIataCode() const { return m_iataCode; }
 
        void setIataCode(const QString &iataCode) { m_iataCode = iataCode.trimmed().toUpper(); }
 
        const QString &getCountryIso() const { return m_country.getIsoCode(); }
 
        const CCountry &getCountry() const { return m_country; }
 
        QString getDesignatorDbKey() const;
 
        QString getDesignatorNameCountry() const;
 
        void setCountry(const CCountry &country) { m_country = country; }
 
        const QString &getName() const { return m_name; }
 
        QString getSimplifiedName() const;
 
        QString getNameWithKey() const;
 
        void setName(const QString &name) { m_name = name.trimmed(); }
 
        const QString &getTelephonyDesignator() const { return m_telephonyDesignator; }
 
        void setTelephonyDesignator(const QString &telephony) { m_telephonyDesignator = telephony.trimmed().toUpper(); }
 
        const QString &getGroupDesignator() const { return m_groupDesignator; }
 
        void setGroupDesignator(const QString &designator) { m_groupDesignator = designator.trimmed().toUpper(); }
 
        const QString &getGroupName() const { return m_groupName; }
 
        void setGroupName(const QString &name) { m_groupName = name.trimmed(); }
 
        int getGroupId() const { return m_groupId; }
 
        void setGroupId(int id) { m_groupId = id; }
 
        bool hasGroupMembership() const { return m_groupId >= 0 && !m_groupDesignator.isEmpty(); }
 
        bool isVirtualAirline() const { return m_isVa; }
 
        void setVirtualAirline(bool va) { m_isVa = va; }
 
        bool isOperating() const { return m_isOperating; }
 
        void setOperating(bool operating) { m_isOperating = operating; }
 
        bool isMilitary() const { return m_isMilitary; }
 
        void setMilitary(bool military) { m_isMilitary = military; }
 
        bool hasValidCountry() const;
 
        bool hasValidDesignator() const;
 
        bool hasIataCode() const;
 
        bool matchesDesignator(const QString &designator) const;
 
        bool matchesVDesignator(const QString &designator) const;
 
        bool matchesIataCode(const QString &iata) const;
 
        bool matchesDesignatorOrIataCode(const QString &candidate) const;
 
        bool matchesVDesignatorOrIataCode(const QString &candidate) const;
 
        bool matchesTelephonyDesignator(const QString &candidate) const;
 
        bool matchesNamesOrTelephonyDesignator(const QString &candidate) const;
 
        bool isContainedInSimplifiedName(const QString &candidate) const;
 
        bool hasTelephonyDesignator() const { return !m_telephonyDesignator.isEmpty(); }
 
        bool hasName() const { return !m_name.isEmpty(); }
 
        bool hasSimplifiedName() const;
 
        bool hasCompleteData() const;
 
        QString getCombinedStringWithKey() const;
 
        CAirlineIcaoCode thisOrCallsignCode(const CCallsign &callsign) const;
 
        CIcons::IconIndex toIcon() const;
 
        QString convertToQString(bool i18n = false) const;
 
        QVariant propertyByIndex(CPropertyIndexRef index) const;
 
        void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
 
        int comparePropertyByIndex(CPropertyIndexRef index, const CAirlineIcaoCode &compareValue) const;
 
        CStatusMessageList validate() const;
 
        void updateMissingParts(const CAirlineIcaoCode &otherIcaoCode);
 
        QString asHtmlSummary() const;
 
        int calculateScore(const CAirlineIcaoCode &otherCode, CStatusMessageList *log = nullptr) const;
 
        bool isNull() const;
 
        static const CAirlineIcaoCode &null();
 
        static bool isValidAirlineDesignator(const QString &airline);
 
        static bool isValidIataCode(const QString &iataCode);
 
        static QSet<QString> specialValidDesignators();
 
        static QString normalizeDesignator(const QString &candidate);
 
        static CStatusMessage logMessage(const CAirlineIcaoCode &icaoCode, const QString &message,
                                         const QStringList &extraCategories = {},
                                         CStatusMessage::StatusSeverity s = CStatusMessage::SeverityInfo);
 
        static void addLogDetailsToList(CStatusMessageList *log, const CAirlineIcaoCode &icao, const QString &message,
                                        const QStringList &extraCategories = {},
                                        CStatusMessage::StatusSeverity s = CStatusMessage::SeverityInfo);
 
        static CAirlineIcaoCode fromDatabaseJson(const QJsonObject &json, const QString &prefix = QString());
 
        static const QSet<int> &iconIds();
 
    private:
        QString m_designator; 
        QString m_iataCode; 
        QString m_name; 
        QString m_telephonyDesignator; 
        QString m_groupDesignator; 
        QString m_groupName; 
        CCountry m_country; 
        int m_groupId = -1; 
        bool m_isVa = false; 
        bool m_isOperating = true; 
        bool m_isMilitary = false; 
 
        SWIFT_METACLASS(
            CAirlineIcaoCode,
            SWIFT_METAMEMBER(dbKey),
            SWIFT_METAMEMBER(timestampMSecsSinceEpoch),
            SWIFT_METAMEMBER(designator),
            SWIFT_METAMEMBER(name),
            SWIFT_METAMEMBER(country),
            SWIFT_METAMEMBER(telephonyDesignator),
            SWIFT_METAMEMBER(groupDesignator),
            SWIFT_METAMEMBER(groupName),
            SWIFT_METAMEMBER(groupId),
            SWIFT_METAMEMBER(isVa),
            SWIFT_METAMEMBER(isOperating),
            SWIFT_METAMEMBER(isMilitary));
    };
 
    using AirlineIcaoIdMap = QMap<int, CAirlineIcaoCode>;
 
} // namespace swift::misc::aviation
 
Q_DECLARE_METATYPE(swift::misc::aviation::CAirlineIcaoCode)
 
#endif // SWIFT_MISC_AVIATION_AIRLINEICAOCODE_H