client.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_NETWORK_CLIENT_H
#define SWIFT_MISC_NETWORK_CLIENT_H
 
#include <QMetaType>
#include <QString>
 
#include "misc/aviation/callsign.h"
#include "misc/metaclass.h"
#include "misc/network/user.h"
#include "misc/network/voicecapabilities.h"
#include "misc/propertyindexref.h"
#include "misc/simulation/aircraftmodel.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::network, CClient)
 
namespace swift::misc::network
{
    class SWIFT_MISC_EXPORT CClient : public CValueObject<CClient>
    {
    public:
        enum ColumnIndex
        {
            IndexCapabilities = CPropertyIndexRef::GlobalIndexCClient,
            IndexCapabilitiesString,
            IndexModelString,
            IndexServer,
            IndexUser,
            IndexCallsign,
            IndexVoiceCapabilities,
            IndexVoiceCapabilitiesString,
            IndexVoiceCapabilitiesPixmap,
            IndexVoiceCapabilitiesIcon
        };
 
        enum Capability
        {
            None = 0,
            FsdWithInterimPositions = 1 << 0, 
            FsdWithIcaoCodes = 1 << 1, 
            FsdAtisCanBeReceived = 1 << 2, 
            FsdWithAircraftConfig = 1 << 3, 
            FsdWithGroundFlag = 1 << 4, 
            FsdModelString = 1 << 5, 
            FsdWithVisualPositions = 1 << 6 
        };
        Q_DECLARE_FLAGS(Capabilities, Capability)
 
        
        CClient() = default;
 
        CClient(const aviation::CCallsign &callsign, const QString &modelString = {});
 
        CClient(const CUser &user) : m_user(user) {}
 
        const aviation::CCallsign &getCallsign() const { return m_user.getCallsign(); }
 
        bool isAtc() const { return getCallsign().isAtcAlikeCallsign(); }
 
        bool isValid() const;
 
        Capabilities getCapabilities() const { return static_cast<Capabilities>(m_capabilities); }
 
        void setCapabilities(const Capabilities &capabilities);
 
        QString getCapabilitiesAsString() const;
 
        bool hasCapability(Capability capability) const;
 
        bool hasAircraftPartsCapability() const;
 
        bool hasGndFlagCapability() const;
 
        void addCapability(Capability capability);
 
        void removeCapability(Capability capability);
 
        const CVoiceCapabilities &getVoiceCapabilities() const { return m_voiceCapabilities; }
 
        bool hasSpecifiedVoiceCapabilities() const { return !m_voiceCapabilities.isUnknown(); }
 
        void setVoiceCapabilities(const CVoiceCapabilities &voiceCapabilities)
        {
            m_voiceCapabilities = voiceCapabilities;
        }
 
        void setVoiceCapabilities(const QString &flightPlanRemarks)
        {
            m_voiceCapabilities = CVoiceCapabilities(flightPlanRemarks);
        }
 
        const CUser &getUser() const { return m_user; }
 
        void setUser(const CUser &user) { m_user = user; }
 
        bool setUserCallsign(const swift::misc::aviation::CCallsign &callsign);
 
        const QString &getServer() const { return m_server; }
 
        void setServer(const QString &server) { m_server = server; }
 
        bool isSwiftClient() const { return m_swift; }
 
        void setSwiftClient(bool isSwift) { m_swift = isSwift; }
 
        const QString &getQueriedModelString() const { return m_modelString; }
 
        bool hasQueriedModelString() const { return !m_modelString.isEmpty(); }
 
        void setQueriedModelString(const QString &modelString);
 
        CIcons::IconIndex toIcon() const;
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
        QString convertToQString(bool i18n = false) const;
 
    private:
        CUser m_user;
        int m_capabilities = static_cast<int>(None);
        bool m_swift = false; // another swift client
        QString m_modelString;
        QString m_server;
        CVoiceCapabilities m_voiceCapabilities;
 
        SWIFT_METACLASS(
            CClient,
            SWIFT_METAMEMBER(user),
            SWIFT_METAMEMBER(swift),
            SWIFT_METAMEMBER(modelString),
            SWIFT_METAMEMBER(capabilities),
            SWIFT_METAMEMBER(server),
            SWIFT_METAMEMBER(voiceCapabilities));
    };
} // namespace swift::misc::network
 
Q_DECLARE_METATYPE(swift::misc::network::CClient)
Q_DECLARE_METATYPE(swift::misc::network::CClient::Capability)
Q_DECLARE_METATYPE(swift::misc::network::CClient::Capabilities)
 
#endif // SWIFT_MISC_NETWORK_CLIENT_H