clientprovider.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2018 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_NETWORK_CLIENTPROVIDER_H
#define SWIFT_MISC_NETWORK_CLIENTPROVIDER_H
 
#include <QMap>
#include <QReadWriteLock>
 
#include "misc/aviation/callsignset.h"
#include "misc/network/clientlist.h"
#include "misc/provider.h"
 
namespace swift::misc
{
    namespace aviation
    {
        class CAircraftSituation;
    }
    namespace network
    {
        class SWIFT_MISC_EXPORT IClientProvider : public IProvider
        {
        public:
            virtual CClientList getClients() const = 0;
 
            virtual void setClients(const CClientList &clients) = 0;
 
            virtual void clearClients() = 0;
 
            virtual CClientList getClientsForCallsigns(const aviation::CCallsignSet &callsigns) const = 0;
 
            virtual CClient getClientOrDefaultForCallsign(const aviation::CCallsign &callsign) const = 0;
 
            virtual bool hasClientInfo(const aviation::CCallsign &callsign) const = 0;
 
            virtual bool addNewClient(const CClient &client) = 0;
 
            virtual bool setOtherClient(const swift::misc::network::CClient &client) = 0;
 
            virtual int updateOrAddClient(const aviation::CCallsign &callsign, const CPropertyIndexVariantMap &vm,
                                          bool skipEqualValues = true) = 0;
 
            virtual int removeClient(const aviation::CCallsign &callsign) = 0;
 
            virtual bool autoAdjustCientGndCapability(const aviation::CAircraftSituation &situation) = 0;
 
            virtual bool addClientGndCapability(const aviation::CCallsign &callsign) = 0;
 
            virtual bool setClientGndCapability(const aviation::CCallsign &callsign, bool supportGndFlag) = 0;
 
            virtual void markAsSwiftClient(const aviation::CCallsign &callsign) = 0;
        };
 
        class SWIFT_MISC_EXPORT CClientProvider : public IClientProvider
        {
        public:
            virtual CClientList getClients() const override;
            virtual void setClients(const CClientList &clients) override;
            virtual void clearClients() override;
            virtual CClientList getClientsForCallsigns(const aviation::CCallsignSet &callsigns) const override;
            virtual CClient getClientOrDefaultForCallsign(const aviation::CCallsign &callsign) const override;
            virtual bool hasClientInfo(const aviation::CCallsign &callsign) const override;
            virtual bool addNewClient(const CClient &client) override;
            virtual bool setOtherClient(const swift::misc::network::CClient &client) override;
            virtual int updateOrAddClient(const aviation::CCallsign &callsign, const CPropertyIndexVariantMap &vm,
                                          bool skipEqualValues = true) override;
            virtual int removeClient(const aviation::CCallsign &callsign) override;
            virtual bool autoAdjustCientGndCapability(const aviation::CAircraftSituation &situation) override;
            virtual bool addClientGndCapability(const aviation::CCallsign &callsign) override;
            virtual bool setClientGndCapability(const aviation::CCallsign &callsign, bool supportGndFlag) override;
            virtual void markAsSwiftClient(const aviation::CCallsign &callsign) override;
 
        private:
            CClientPerCallsign m_clients;
            mutable QReadWriteLock m_lockClient; 
        };
 
        class SWIFT_MISC_EXPORT CClientAware : public IProviderAware<IClientProvider>
        {
            virtual void anchor();
 
        public:
            CClientList getClients() const;
 
            void setClients(const CClientList &clients);
 
            void clearClients();
 
            swift::misc::network::CClientList getClientsForCallsigns(const aviation::CCallsignSet &callsigns) const;
 
            swift::misc::network::CClient getClientOrDefaultForCallsign(const aviation::CCallsign &callsign) const;
 
            bool hasClientInfo(const aviation::CCallsign &callsign) const;
 
            bool addNewClient(const CClient &client);
 
            int updateOrAddClient(const aviation::CCallsign &callsign, const CPropertyIndexVariantMap &vm,
                                  bool skipEqualValues);
 
            int removeClient(const aviation::CCallsign &callsign);
 
            bool autoAdjustCientGndCapability(const aviation::CAircraftSituation &situation);
 
            bool addClientGndCapability(const aviation::CCallsign &callsign);
 
            void markAsSwiftClient(const aviation::CCallsign &callsign);
 
            void setClientProvider(CClientProvider *provider) { this->setProvider(provider); }
 
        protected:
            CClientAware() {}
 
            CClientAware(IClientProvider *clientProvider) : IProviderAware(clientProvider) {}
        };
 
        class SWIFT_MISC_EXPORT CClientProviderDummy : public CClientProvider
        {
        public:
            static CClientProviderDummy *instance();
        };
    } // namespace network
} // namespace swift::misc
 
Q_DECLARE_INTERFACE(swift::misc::network::IClientProvider, "org.swift-project.misc::network::iclientprovider")
 
#endif // SWIFT_MISC_NETWORK_CLIENTPROVIDER_H