contextsimulator.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_CORE_CONTEXTSIMULATOR_H
#define SWIFT_CORE_CONTEXTSIMULATOR_H
 
#include <QObject>
#include <QString>
 
#include "core/context/context.h"
#include "core/corefacade.h"
#include "core/corefacadeconfig.h"
#include "core/simulator.h"
#include "core/swiftcoreexport.h"
#include "misc/aviation/airportlist.h"
#include "misc/geo/elevationplane.h"
#include "misc/pixmap.h"
#include "misc/pq/length.h"
#include "misc/simulation/aircraftmatchersetup.h"
#include "misc/simulation/aircraftmodellist.h"
#include "misc/simulation/interpolation/interpolationrenderingsetup.h"
#include "misc/simulation/matchinglog.h"
#include "misc/simulation/matchingstatistics.h"
#include "misc/simulation/settings/simulatorsettings.h"
#include "misc/simulation/simulatorinternals.h"
#include "misc/simulation/simulatorplugininfo.h"
#include "misc/simulation/simulatorplugininfolist.h"
 
// clazy:excludeall=const-signal-or-slot
 
#define SWIFT_CORE_CONTEXTSIMULATOR_INTERFACENAME "org.swift_project.swift_core.contextsimulator"
 
#define SWIFT_CORE_CONTEXTSIMULATOR_OBJECTPATH "/simulator"
 
class QDBusConnection;
 
namespace swift::misc
{
    class CDBusServer;
    namespace simulation
    {
        class CSimulatedAircraft;
    }
} // namespace swift::misc
namespace swift::core::context
{
    class SWIFT_CORE_EXPORT IContextSimulator : public IContext
    {
        Q_OBJECT
        Q_CLASSINFO("D-Bus Interface", SWIFT_CORE_CONTEXTSIMULATOR_INTERFACENAME)
 
    public:
        static const QString &InterfaceName();
 
        static const QString &ObjectPath();
 
        QString getPathAndContextId() const override { return this->buildPathAndContextId(ObjectPath()); }
 
        static IContextSimulator *create(CCoreFacade *parent, CCoreFacadeConfig::ContextMode mode,
                                         swift::misc::CDBusServer *server, QDBusConnection &connection);
 
        ~IContextSimulator() override {}
 
    signals:
        void simulatorStatusChanged(int status);
 
        void simulatorPluginChanged(const swift::misc::simulation::CSimulatorPluginInfo &info);
 
        void simulatorChanged(const swift::misc::simulation::CSimulatorInfo &simulator);
 
        void simulatorSettingsChanged();
 
        void vitalityLost();
 
        void insufficientFrameRateDetected(bool fatal);
 
        void renderRestrictionsChanged(bool restricted, bool enabled, int maxAircraft,
                                       const swift::misc::physical_quantities::CLength &maxRenderedDistance);
 
        void interpolationAndRenderingSetupChanged();
 
        void matchingSetupChanged();
 
        void modelSetChanged(const swift::misc::simulation::CSimulatorInfo &simulator);
 
        void modelMatchingCompleted(const swift::misc::simulation::CSimulatedAircraft &aircraft);
 
        void addingRemoteModelFailed(const swift::misc::simulation::CSimulatedAircraft &aircraft, bool disabled,
                                     bool failover, const swift::misc::CStatusMessage &message);
 
        void aircraftRenderingChanged(const swift::misc::simulation::CSimulatedAircraft &aircraft);
 
        void ownAircraftModelChanged(const swift::misc::simulation::CAircraftModel &model);
 
        void airspaceSnapshotHandled();
 
        void driverMessages(const swift::misc::CStatusMessageList &messages);
 
        void validatedModelSet(const swift::misc::simulation::CSimulatorInfo &simulator,
                               const swift::misc::simulation::CAircraftModelList &valid,
                               const swift::misc::simulation::CAircraftModelList &invalid, bool stopped,
                               const swift::misc::CStatusMessageList &msgs);
 
        void autoPublishDataWritten(const swift::misc::simulation::CSimulatorInfo &simulator);
 
    public slots:
        virtual swift::misc::simulation::CSimulatorPluginInfo getSimulatorPluginInfo() const = 0;
 
        virtual swift::misc::simulation::CSimulatorPluginInfoList getAvailableSimulatorPlugins() const = 0;
 
        virtual swift::misc::simulation::settings::CSimulatorSettings getSimulatorSettings() const = 0;
 
        virtual bool setSimulatorSettings(const swift::misc::simulation::settings::CSimulatorSettings &settings,
                                          const swift::misc::simulation::CSimulatorInfo &simulator) = 0;
 
        virtual int checkListeners() = 0;
 
        virtual bool startSimulatorPlugin(const swift::misc::simulation::CSimulatorPluginInfo &simulatorInfo) = 0;
 
        virtual void stopSimulatorPlugin(const swift::misc::simulation::CSimulatorPluginInfo &simulatorInfo) = 0;
 
        virtual ISimulator::SimulatorStatus getSimulatorStatus() const = 0;
 
        virtual swift::misc::simulation::CSimulatorInternals getSimulatorInternals() const = 0;
 
        virtual swift::misc::simulation::CAircraftModelList getModelSet() const = 0;
 
        virtual swift::misc::simulation::CSimulatorInfo getModelSetLoaderSimulator() const = 0;
 
        virtual void setModelSetLoaderSimulator(const swift::misc::simulation::CSimulatorInfo &simulator) = 0;
 
        virtual swift::misc::simulation::CSimulatorInfo simulatorsWithInitializedModelSet() const = 0;
 
        virtual swift::misc::CStatusMessageList verifyPrerequisites() const = 0;
 
        virtual int getModelSetCount() const = 0;
 
        virtual swift::misc::simulation::CAircraftModelList
        getModelSetModelsStartingWith(const QString &modelString) const = 0;
 
        virtual QStringList getModelSetStrings() const = 0;
 
        virtual QStringList getModelSetCompleterStrings(bool sorted) const = 0;
 
        virtual int removeModelsFromSet(const swift::misc::simulation::CAircraftModelList &removeModels) = 0;
 
        virtual void disableModelsForMatching(const swift::misc::simulation::CAircraftModelList &removedModels,
                                              bool incremental) = 0;
 
        virtual swift::misc::simulation::CAircraftModelList getDisabledModelsForMatching() const = 0;
 
        virtual bool isValidationInProgress() const = 0;
 
        virtual bool triggerModelSetValidation(const swift::misc::simulation::CSimulatorInfo &simulator) = 0;
 
        virtual void restoreDisabledModels() = 0;
 
        virtual bool isKnownModelInSet(const QString &modelstring) const = 0;
 
        virtual swift::misc::simulation::CInterpolationAndRenderingSetupGlobal
        getInterpolationAndRenderingSetupGlobal() const = 0;
 
        virtual swift::misc::simulation::CInterpolationSetupList
        getInterpolationAndRenderingSetupsPerCallsign() const = 0;
 
        virtual swift::misc::simulation::CInterpolationAndRenderingSetupPerCallsign
        getInterpolationAndRenderingSetupPerCallsignOrDefault(
            const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual void setInterpolationAndRenderingSetupGlobal(
            const swift::misc::simulation::CInterpolationAndRenderingSetupGlobal &setup) = 0;
 
        virtual bool
        setInterpolationAndRenderingSetupsPerCallsign(const swift::misc::simulation::CInterpolationSetupList &setups,
                                                      bool ignoreSameAsGlobal) = 0;
 
        virtual swift::misc::CStatusMessageList
        getInterpolationMessages(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        bool isSimulatorAvailable() const;
 
        bool isSimulatorSimulating() const;
 
        virtual swift::misc::CStatusMessageList
        getMatchingMessages(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual swift::misc::simulation::MatchingLog isMatchingMessagesEnabled() const = 0;
 
        virtual void enableMatchingMessages(swift::misc::simulation::MatchingLog enabled) = 0;
 
        virtual bool followAircraft(const swift::misc::aviation::CCallsign &callsign) = 0;
 
        virtual void recalculateAllAircraft() = 0;
 
        virtual bool resetToModelMatchingAircraft(const swift::misc::aviation::CCallsign &callsign) = 0;
 
        virtual bool requestElevationBySituation(const swift::misc::aviation::CAircraftSituation &situation) = 0;
 
        virtual swift::misc::geo::CElevationPlane
        findClosestElevationWithinRange(const swift::misc::geo::CCoordinateGeodetic &reference,
                                        const swift::misc::physical_quantities::CLength &range) const = 0;
 
        virtual int doMatchingsAgain() = 0;
 
        virtual bool doMatchingAgain(const swift::misc::aviation::CCallsign &callsign) = 0;
 
        virtual swift::misc::simulation::CMatchingStatistics getCurrentMatchingStatistics(bool missingOnly) const = 0;
 
        virtual void setMatchingSetup(const swift::misc::simulation::CAircraftMatcherSetup &setup) = 0;
 
        virtual bool testRemoteAircraft(const swift::misc::simulation::CSimulatedAircraft &aircraft, bool add) = 0;
 
        virtual bool testUpdateRemoteAircraft(const swift::misc::aviation::CCallsign &cs,
                                              const swift::misc::aviation::CAircraftSituation &situation,
                                              const swift::misc::aviation::CAircraftParts &parts) = 0;
 
        virtual swift::misc::simulation::CAircraftMatcherSetup getMatchingSetup() const = 0;
 
    protected:
        IContextSimulator(CCoreFacadeConfig::ContextMode mode, CCoreFacade *runtime) : IContext(mode, runtime) {}
    };
} // namespace swift::core::context
 
#endif // SWIFT_CORE_CONTEXTSIMULATOR_H