simulatoremulated.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2017 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1

 
#ifndef SWIFT_SIMPLUGIN_EMULATED_SIMULATOREMULATED_H
#define SWIFT_SIMPLUGIN_EMULATED_SIMULATOREMULATED_H
 
#include <QMap>
#include <QPointer>
#include <QTimer>
 
#include "../plugincommon/simulatorplugincommon.h"
#include "simulatoremulatedmonitordialog.h"
 
#include "misc/aviation/comsystem.h"
#include "misc/connectionguard.h"
#include "misc/pq/time.h"
#include "misc/simulation/interpolation/interpolationlogger.h"
#include "misc/simulation/interpolation/interpolationrenderingsetup.h"
#include "misc/simulation/interpolation/interpolatormulti.h"
#include "misc/simulation/settings/swiftpluginsettings.h"
#include "misc/simulation/simulatorplugininfo.h"
 
namespace swift::simplugin::emulated
{
    class CSimulatorEmulated : public common::CSimulatorPluginCommon
    {
        Q_OBJECT
        Q_INTERFACES(swift::core::ISimulator)
        Q_INTERFACES(swift::misc::simulation::ISimulationEnvironmentProvider)
        Q_INTERFACES(swift::misc::simulation::IInterpolationSetupProvider)
 
        friend class CSimulatorEmulatedMonitorDialog; 
 
    public:
        CSimulatorEmulated(const swift::misc::simulation::CSimulatorPluginInfo &info,
                           swift::misc::simulation::IOwnAircraftProvider *ownAircraftProvider,
                           swift::misc::simulation::IRemoteAircraftProvider *remoteAircraftProvider,
                           swift::misc::network::IClientProvider *clientProvider, QObject *parent = nullptr);

        ~CSimulatorEmulated() override;
 
        // functions implemented
        bool connectTo() override;
        bool disconnectFrom() override;
        void unload() override;
        bool isConnected() const override;
        bool isPaused() const override;
        bool isSimulating() const override;
        bool changeRemoteAircraftModel(const swift::misc::simulation::CSimulatedAircraft &aircraft) override;
        bool changeRemoteAircraftEnabled(const swift::misc::simulation::CSimulatedAircraft &aircraft) override;
        bool updateOwnSimulatorCockpit(const swift::misc::simulation::CSimulatedAircraft &aircraft,
                                       const swift::misc::CIdentifier &originator) override;
        bool updateOwnSimulatorSelcal(const swift::misc::aviation::CSelcal &selcal,
                                      const swift::misc::CIdentifier &originator) override;
        void displayStatusMessage(const swift::misc::CStatusMessage &message) const override;
        void displayTextMessage(const swift::misc::network::CTextMessage &message) const override;
        bool isPhysicallyRenderedAircraft(const swift::misc::aviation::CCallsign &callsign) const override;
        swift::misc::aviation::CCallsignSet physicallyRenderedAircraft() const override;
        swift::misc::CStatusMessageList
        getInterpolationMessages(const swift::misc::aviation::CCallsign &callsign) const override;
        bool testSendSituationAndParts(const swift::misc::aviation::CCallsign &callsign,
                                       const swift::misc::aviation::CAircraftSituation &situation,
                                       const swift::misc::aviation::CAircraftParts &parts) override;
        bool requestElevation(const swift::misc::geo::ICoordinateGeodetic &reference,
                              const swift::misc::aviation::CCallsign &callsign) override;
 
        // ----- functions just logged -------
        bool logicallyAddRemoteAircraft(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft) override;
        bool logicallyRemoveRemoteAircraft(const swift::misc::aviation::CCallsign &callsign) override;
        int physicallyRemoveMultipleRemoteAircraft(const swift::misc::aviation::CCallsignSet &callsigns) override;
 
        // functions logged and used
        bool parseCommandLine(const QString &commandLine, const swift::misc::CIdentifier &originator) override;

        void setCombinedStatus(bool connected, bool simulating, bool paused);

        swift::misc::simulation::CSimulatorInfo getEmulatedSimulator() const;

        const swift::misc::simulation::CSimulatedAircraft &getInternalOwnAircraft() const { return m_myAircraft; }

        bool changeInternalCom(const swift::misc::simulation::CSimulatedAircraft &aircraft);

        bool changeInternalCom(const swift::misc::aviation::CComSystem &comSystem,
                               swift::misc::aviation::CComSystem::ComUnit unit);

        bool changeInternalSelcal(const swift::misc::aviation::CSelcal &selcal);

        bool changeInternalSituation(const swift::misc::aviation::CAircraftSituation &situation);

        bool changeInternalParts(const swift::misc::aviation::CAircraftParts &parts);

        bool setInterpolatorFetchTime(int timeMs);

        bool isInterpolatorFetching() const;

        static void registerHelp(); // cppcheck-suppress duplInheritedMember
 
    signals:
        void internalAircraftChanged();
 
    protected:
        bool physicallyAddRemoteAircraft(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft) override;
        bool physicallyRemoveRemoteAircraft(const swift::misc::aviation::CCallsign &callsign) override;
        int physicallyRemoveAllRemoteAircraft() override;

        bool parseDetails(const swift::misc::CSimpleCommandParser &parser) override;
 
    private:
        void setObjectName(const swift::misc::simulation::CSimulatorInfo &info);

        bool canLog() const;

        bool canDisplay() const;

        void closeMonitor();

        void onSettingsChanged();

        void onSimulatorStatusChanged();

        void connectOwnSignals();

        void updateRemoteAircraft();
 
        bool m_log = false; 
        bool m_paused = false;
        bool m_connected = true;
        bool m_simulating = true;
        int m_countInterpolatedSituations = 0;
        int m_countInterpolatedParts = 0;
        QTimer m_interpolatorFetchTimer; 
        swift::misc::simulation::CSimulatedAircraft m_myAircraft; 
        swift::misc::simulation::CSimulatedAircraftList m_renderedAircraft; 
        QPointer<CSimulatorEmulatedMonitorDialog>
            m_monitorWidget; 
        swift::misc::CConnectionGuard m_connectionGuard; 
        swift::misc::CSettingReadOnly<swift::misc::simulation::settings::TSwiftPlugin> m_pluginSettings {
            this, &CSimulatorEmulated::onSettingsChanged
        };
        QMap<swift::misc::aviation::CCallsign, swift::misc::simulation::CInterpolatorMultiWrapper>
            m_interpolators; 
    };

    class CSimulatorEmulatedListener : public swift::core::ISimulatorListener
    {
        Q_OBJECT
 
    public:
        CSimulatorEmulatedListener(const swift::misc::simulation::CSimulatorPluginInfo &info);
 
    protected:
        void startImpl() override;

        void stopImpl() override;

        void checkImpl() override;
    };
} // namespace swift::simplugin::emulated
 
#endif // SWIFT_SIMPLUGIN_EMULATED_SIMULATOREMULATED_H