callsign.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_CALLSIGN_H
#define SWIFT_MISC_AVIATION_CALLSIGN_H
 
#include <tuple>
 
#include <QMetaType>
#include <QString>
 
#include "misc/metaclass.h"
#include "misc/propertyindexref.h"
#include "misc/statusmessage.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::aviation, CCallsign)
 
namespace swift::misc
{
    class CStatusMessageList;
 
    namespace aviation
    {
        class SWIFT_MISC_EXPORT CCallsign : public CValueObject<CCallsign>
        {
        public:
            enum ColumnIndex
            {
                IndexCallsignString = CPropertyIndexRef::GlobalIndexCCallsign,
                IndexCallsignStringAsSet,
                IndexTelephonyDesignator,
                IndexSuffix,
                IndexSuffixSortOrder
            };
 
            enum TypeHint
            {
                NoHint,
                Aircraft,
                Atc
            };
 
            CCallsign() {}
 
            CCallsign(const QString &callsign, TypeHint hint = NoHint);
 
            CCallsign(const QString &callsign, const QString &telephonyDesignator, TypeHint hint = NoHint);
 
            CCallsign(const char *callsign, TypeHint hint = NoHint);
 
            bool isEmpty() const { return m_callsignAsSet.isEmpty(); }
 
            bool isAtcCallsign() const;
 
            bool isAtcAlikeCallsign() const;
 
            bool isObserverCallsign() const;
 
            bool isSupervisorCallsign() const;
 
            bool isBroadcastCallsign() const;
 
            void markAsBroadcastCallsign();
 
            void markAsWallopCallsign();
 
            bool isMaybeCopilotCallsign(const CCallsign &pilotCallsign) const;
 
            const QString &asString() const { return m_callsign; }
 
            const QString &getStringAsSet() const { return m_callsignAsSet; }
 
            QString getFsdCallsignString() const;
 
            bool isSameAsSet() const;
 
            const QString &getTelephonyDesignator() const { return m_telephonyDesignator; }
 
            TypeHint getTypeHint() const { return m_typeHint; }
 
            void setTypeHint(TypeHint hint) { m_typeHint = hint; }
 
            QString getIcaoCode() const;
 
            QString getAsObserverCallsignString() const;
 
            QString getSuffix() const;
 
            QString getAirlinePrefix() const;
            QString getAirlinePrefix(QString &flightNumber) const;
            QString getAirlinePrefix(QString &flightNumber, QString &flightIdentification) const;
 
            QString getFlightIndentification() const;
 
            QString getFlightNumber() const;
 
            int getFlightNumberInt() const;
 
            bool hasSuffix() const;
 
            bool hasAtcSuffix() const;
 
            int getSuffixSortOrder() const;
 
            bool equalsString(const QString &callsignString) const;
 
            bool isValid() const;
 
            CIcons::IconIndex toIcon() const { return convertToIcon(*this).getIndex(); }
 
            QVariant propertyByIndex(CPropertyIndexRef index) const;
 
            void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
 
            int comparePropertyByIndex(CPropertyIndexRef index, const CCallsign &compareValue) const;
 
            QString convertToQString(bool i18n = false) const;
 
            void clear();
 
            static int suffixToSortOrder(const QString &suffix);
 
            static bool isValidAircraftCallsign(const QString &callsign);
 
            static bool isValidAircraftCallsign(const CCallsign &callsign);
 
            static bool isValidAtcCallsign(const QString &callsign);
 
            static bool isValidAtcCallsign(const CCallsign &callsign);
 
            static QString unifyCallsign(const QString &callsign, TypeHint hint = NoHint);
 
            static const QStringList &atcCallsignSuffixes();
 
            static const QStringList &atcAlikeCallsignSuffixes();
 
            static bool looksLikeAtcCallsign(const QString &callsign);
 
            static const CIcon &atcSuffixToIcon(const QString &suffix);
 
            static const CIcon &convertToIcon(const CCallsign &callsign);
 
            static CStatusMessage logMessage(const CCallsign &callsign, const QString &message,
                                             const QStringList &extraCategories = {},
                                             CStatusMessage::StatusSeverity s = CStatusMessage::SeverityInfo);
 
            static void addLogDetailsToList(CStatusMessageList *log, const CCallsign &callsign, const QString &message,
                                            const QStringList &extraCategories = {},
                                            CStatusMessage::StatusSeverity s = CStatusMessage::SeverityInfo);
 
            static void registerMetadata();
 
        private:
            QString m_callsignAsSet;
            QString m_callsign;
            QString m_telephonyDesignator;
            TypeHint m_typeHint = NoHint;
 
            SWIFT_METACLASS(
                CCallsign,
                SWIFT_METAMEMBER(callsign, 0, CaseInsensitiveComparison),
                SWIFT_METAMEMBER(callsignAsSet, 0, DisabledForComparison | DisabledForHashing),
                SWIFT_METAMEMBER(telephonyDesignator, 0, DisabledForComparison | DisabledForHashing),
                SWIFT_METAMEMBER(typeHint, 0, DisabledForComparison | DisabledForHashing));
        };
    } // namespace aviation
} // namespace swift::misc
 
Q_DECLARE_METATYPE(swift::misc::aviation::CCallsign)
Q_DECLARE_METATYPE(swift::misc::aviation::CCallsign::TypeHint)
 
#endif // SWIFT_MISC_AVIATION_CALLSIGN_H