fsdsetup.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2016 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_NETWORK_FSDSETUP_H
#define SWIFT_MISC_NETWORK_FSDSETUP_H
 
#include <QMetaType>
#include <QString>
 
#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::network, CFsdSetup)
 
namespace swift::misc::network
{
    class SWIFT_MISC_EXPORT CFsdSetup : public CValueObject<CFsdSetup>
    {
    public:
        enum ColumnIndex
        {
            IndexTextCodec = CPropertyIndexRef::GlobalIndexCFsdSetup,
            IndexSendReceiveDetails
        };
 
        enum SendReceiveDetailsFlag
        {
            Nothing = 0, 
            SendAircraftParts = 1 << 0, 
            SendInterimPositions = 1 << 1, 
            SendGndFlag = 1 << 2, 
            ReceiveAircraftParts = 1 << 3, 
            ReceiveInterimPositions = 1 << 4, 
            ReceiveGndFlag = 1 << 5, 
            Force3LetterAirlineICAO = 1 << 6, 
            SendVisualPositions = 1 << 7, 
            ReceiveEuroscopeSimData = 1 << 8, 
            SendFplWithIcaoEquipment = 1 << 9, 
            AllSending = SendAircraftParts | SendInterimPositions | SendVisualPositions | SendGndFlag, 
            AllReceive = ReceiveAircraftParts | ReceiveInterimPositions | ReceiveGndFlag, 
            All = AllReceive | AllSending, 
            AllParts = SendAircraftParts | ReceiveAircraftParts, 
            AllSendingWithoutGnd = AllSending - SendGndFlag, 
            AllReceiveWithoutGnd = AllReceive - ReceiveGndFlag, 
            AllInterimPositions = SendInterimPositions | ReceiveInterimPositions, 
            AllWithoutGnd = AllReceiveWithoutGnd | AllSendingWithoutGnd, 
            VATSIMDefault = AllParts | Force3LetterAirlineICAO | SendVisualPositions | SendFplWithIcaoEquipment
        };
        Q_DECLARE_FLAGS(SendReceiveDetails, SendReceiveDetailsFlag)
 
        
        static constexpr qint64 c_positionTimeOffsetMsec = 6000; 
        static constexpr qint64 c_interimPositionTimeOffsetMsec =
            1500; 
 
        CFsdSetup() {}
 
        CFsdSetup(SendReceiveDetails sendReceive);
 
        CFsdSetup(const QString &codec, SendReceiveDetails sendReceive = All);
 
        const QString &getTextCodec() const { return m_textCodec; }
 
        void setTextCodec(const QString &codec) { m_textCodec = codec.trimmed(); }
 
        SendReceiveDetails getSendReceiveDetails() const;
 
        void setSendReceiveDetails(SendReceiveDetails sendReceive) { m_sendReceive = sendReceive; }
 
        void addSendReceiveDetails(SendReceiveDetails sendReceive) { m_sendReceive |= sendReceive; }
 
        void removeSendReceiveDetails(SendReceiveDetails sendReceive) { m_sendReceive &= ~sendReceive; }
 
        void setSendReceiveDetails(bool partsSend, bool partsReceive, bool gndSend, bool gndReceive, bool interimSend,
                                   bool interimReceive, bool visualSend, bool euroscopeSimDataReceive,
                                   bool icaoEquipment);
 
        bool sendAircraftParts() const { return this->getSendReceiveDetails().testFlag(SendAircraftParts); }
        bool sendGndFlag() const { return this->getSendReceiveDetails().testFlag(SendGndFlag); }
        bool sendInterimPositions() const { return this->getSendReceiveDetails().testFlag(SendInterimPositions); }
        bool sendVisualPositions() const { return this->getSendReceiveDetails().testFlag(SendVisualPositions); }
 
        bool receiveAircraftParts() const { return this->getSendReceiveDetails().testFlag(ReceiveAircraftParts); }
        bool receiveGndFlag() const { return this->getSendReceiveDetails().testFlag(ReceiveGndFlag); }
        bool receiveInterimPositions() const { return this->getSendReceiveDetails().testFlag(ReceiveInterimPositions); }
        bool receiveEuroscopeSimData() const { return this->getSendReceiveDetails().testFlag(ReceiveEuroscopeSimData); }
        bool shouldSendFlightPlanEquipmentInIcaoFormat() const
        {
            return this->getSendReceiveDetails().testFlag(SendFplWithIcaoEquipment);
        }
 
        bool force3LetterAirlineCodes() const
        {
            return this->getSendReceiveDetails().testFlag(Force3LetterAirlineICAO);
        }
        void setForce3LetterAirlineCodes(bool force);
 
        CStatusMessageList validate() const;
 
        QVariant propertyByIndex(CPropertyIndexRef index) const;
 
        void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
 
        int comparePropertyByIndex(CPropertyIndexRef index, const CFsdSetup &compareValue) const;
 
        QString convertToQString(bool i18n = false) const;
 
        static QString sendReceiveDetailsToString(SendReceiveDetails details);
 
        static const CFsdSetup &vatsimStandard();
 
    private:
        QString m_textCodec = "latin1";
        int m_sendReceive = static_cast<int>(All);
 
        SWIFT_METACLASS(
            CFsdSetup,
            SWIFT_METAMEMBER(textCodec),
            SWIFT_METAMEMBER(sendReceive));
    };
} // namespace swift::misc::network
 
Q_DECLARE_METATYPE(swift::misc::network::CFsdSetup)
Q_DECLARE_METATYPE(swift::misc::network::CFsdSetup::SendReceiveDetails)
Q_DECLARE_METATYPE(swift::misc::network::CFsdSetup::SendReceiveDetailsFlag)
Q_DECLARE_OPERATORS_FOR_FLAGS(swift::misc::network::CFsdSetup::SendReceiveDetails)
 
#endif // SWIFT_MISC_NETWORK_FSDSETUP_H