simulationenvironmentprovider_8h_source.html

 // 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_SIMULATION_SIMULATIONENVIRONMENTPROVIDER_H

 #define SWIFT_MISC_SIMULATION_SIMULATIONENVIRONMENTPROVIDER_H


 #include <QHash>

 #include <QObject>

 #include <QPair>


 #include "misc/aviation/aircraftsituation.h"

 #include "misc/aviation/percallsign.h"

 #include "misc/geo/coordinategeodeticlist.h"

 #include "misc/geo/elevationplane.h"

 #include "misc/pq/length.h"

 #include "misc/provider.h"

 #include "misc/simulation/aircraftmodel.h"

 #include "misc/simulation/settings/simulatorsettings.h"

 #include "misc/simulation/simulatorplugininfo.h"


 namespace swift::misc::simulation

 {

     class SWIFT_MISC_EXPORT ISimulationEnvironmentProvider : public IProvider

     {

     public:

         geo::CCoordinateGeodeticList getAllElevationCoordinates() const;


         geo::CCoordinateGeodeticList getElevationCoordinatesOnGround() const;


         geo::CElevationPlane averageElevationOfOnGroundAircraft(const aviation::CAircraftSituation &reference,

                                                                 const physical_quantities::CLength &range,

                                                                 int minValues, int sufficientValues) const;


         aviation::CAltitude highestElevation() const;


         geo::CElevationPlane findClosestElevationWithinRange(const geo::ICoordinateGeodetic &reference,

                                                              const physical_quantities::CLength &range) const;


         geo::CElevationPlane findClosestElevationWithinRangeOrRequest(const geo::ICoordinateGeodetic &reference,

                                                                       const physical_quantities::CLength &range,

                                                                       const aviation::CCallsign &callsign);


         virtual bool requestElevation(const geo::ICoordinateGeodetic &reference,

                                       const aviation::CCallsign &callsign) = 0;


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


         QPair<int, int> getElevationsFoundMissed() const;


         QPair<qint64, qint64> getElevationRequestTimes() const;


         QString getElevationsFoundMissedInfo() const;


         QString getElevationRequestTimesInfo() const;


         CSimulatorPluginInfo getSimulatorPluginInfo() const;


         CSimulatorInfo getSimulatorInfo() const;


         QString getSimulatorNameAndVersion() const;


         CAircraftModel getDefaultModel() const;


         aviation::CLengthPerCallsign getSimulatorCGsPerCallsign() const;


         QHash<QString, physical_quantities::CLength> getSimulatorCGsPerModelString() const;


         physical_quantities::CLength getSimulatorCG(const aviation::CCallsign &callsign) const;


         physical_quantities::CLength getSimulatorOrDbCG(const aviation::CCallsign &callsign,

                                                         const physical_quantities::CLength &dbCG) const;


         physical_quantities::CLength getSimulatorCGPerModelString(const QString &modelString) const;


         physical_quantities::CLength getSimulatorOrDbCGPerModelString(const QString &modelString,

                                                                       const physical_quantities::CLength &dbCG) const;


         physical_quantities::CLength overriddenCGorDefault(const physical_quantities::CLength &defaultCG,

                                                            const QString &modelString) const;


         bool hasSimulatorCG(const aviation::CCallsign &callsign) const;


         bool hasSameSimulatorCG(const physical_quantities::CLength &cg, const aviation::CCallsign &callsign) const;


         int setMaxElevationsRemembered(int max);


         int getMaxElevationsRemembered() const;


         void resetSimulationEnvironmentStatistics();


         bool cleanElevationValues(const aviation::CAircraftSituation &reference,

                                   const physical_quantities::CLength &keptRange, bool forced = false);


         int removeElevationValues(const aviation::CAircraftSituation &reference,

                                   const physical_quantities::CLength &removeRange);


     protected:

         ISimulationEnvironmentProvider(const CSimulatorPluginInfo &pluginInfo);


         ISimulationEnvironmentProvider(const CSimulatorPluginInfo &pluginInfo,

                                        const settings::CSimulatorSettings &settings, bool supportElevation,

                                        bool supportCG);


         bool isCgProviderEnabled() const;

         bool isElevationProviderEnabled() const;

         void setCgProviderEnabled(bool enabled);

         void setElevationProviderEnabled(bool enabled);

         void setSimulationProviderEnabled(bool elvEnabled, bool cgEnabled);


         geo::CCoordinateGeodeticList getAllElevationCoordinates(int &maxRemembered) const;


         void setNewPluginInfo(const CSimulatorPluginInfo &info, const settings::CSimulatorSettings &settings,

                               const CAircraftModel &defaultModel);


         void setNewPluginInfo(const CSimulatorPluginInfo &info, const settings::CSimulatorSettings &settings);


         void setSimulatorDetails(const QString &name, const QString &details, const QString &version);


         QString getSimulatorName() const;


         QString getSimulatorVersion() const;


         QString getSimulatorDetails() const;


         void setDefaultModel(const CAircraftModel &defaultModel);


         void clearDefaultModel();


         void clearElevations();


         void clearCGs();


         void clearSimulationEnvironmentData();


         int cleanUpElevations(const geo::ICoordinateGeodetic &referenceCoordinate, int maxNumber = -1);


         bool rememberGroundElevation(

             const aviation::CCallsign &requestedForCallsign, bool likelyOnGroundElevation,

             const geo::ICoordinateGeodetic &elevationCoordinate,

             const physical_quantities::CLength &epsilon = geo::CElevationPlane::singlePointRadius());


         bool rememberGroundElevation(const aviation::CCallsign &requestedForCallsign, bool likelyOnGroundElevation,

                                      const geo::CElevationPlane &elevationPlane);


         bool insertCG(const physical_quantities::CLength &cg, const aviation::CCallsign &cs);


         bool insertCG(const physical_quantities::CLength &cg, const QString &modelString,

                       const aviation::CCallsign &cs);


         bool insertCGOverridden(const physical_quantities::CLength &cg, const aviation::CCallsign &cs);


         bool insertCGOverridden(const physical_quantities::CLength &cg, const aviation::CCallsignSet &callsigns);


         bool insertCGForModelString(const physical_quantities::CLength &cg, const QString &modelString);


         bool insertCGForModelStringOverridden(const physical_quantities::CLength &cg, const QString &modelString);


         aviation::CLengthPerCallsign clearCGOverrides();


         int removeSimulatorCG(const aviation::CCallsign &cs);


         void removePendingElevationRequest(const aviation::CCallsign &cs);


         static physical_quantities::CLength minRange(const physical_quantities::CLength &range);


     private:

         CSimulatorPluginInfo m_simulatorPluginInfo;

         settings::CSimulatorSettings m_settings;

         QString m_simulatorName;

         QString m_simulatorDetails;

         QString m_simulatorVersion;

         CAircraftModel m_defaultModel;


         // idea: the elevations on gnd are likely taxiways and runways, so we keep those

         int m_maxElevations = 100;

         int m_maxElevationsGnd = 400;

         geo::CCoordinateGeodeticList m_elvCoordinates;

         geo::CCoordinateGeodeticList m_elvCoordinatesGnd;


         aviation::CTimestampPerCallsign

             m_pendingElevationRequests;

         aviation::CLengthPerCallsign m_cgsPerCallsign;

         aviation::CLengthPerCallsign m_cgsPerCallsignOverridden;

         QHash<QString, physical_quantities::CLength> m_cgsPerModel;

         QHash<QString, physical_quantities::CLength>

             m_cgsPerModelOverridden;

         qint64 m_statsMaxElevRequestTimeMs = -1;

         qint64 m_statsCurrentElevRequestTimeMs = -1;


         bool m_enableElevation = true;

         bool m_enableCG = true;


         mutable int m_elvFound = 0;

         mutable int m_elvMissed = 0;


         mutable QReadWriteLock m_lockElvCoordinates {

             QReadWriteLock::Recursive

         };

         mutable QReadWriteLock m_lockCG { QReadWriteLock::Recursive };

         mutable QReadWriteLock m_lockModel { QReadWriteLock::Recursive };

         mutable QReadWriteLock m_lockSimInfo { QReadWriteLock::Recursive };

     };


     class SWIFT_MISC_EXPORT CSimulationEnvironmentAware : public IProviderAware<ISimulationEnvironmentProvider>

     {

         virtual void anchor();


     public:

         void setSimulationEnvironmentProvider(ISimulationEnvironmentProvider *provider) { this->setProvider(provider); }


         geo::CElevationPlane findClosestElevationWithinRange(const geo::ICoordinateGeodetic &reference,

                                                              const physical_quantities::CLength &range) const;


         geo::CElevationPlane findClosestElevationWithinRangeOrRequest(const geo::ICoordinateGeodetic &reference,

                                                                       const physical_quantities::CLength &range,

                                                                       const aviation::CCallsign &callsign);


         geo::CElevationPlane averageElevationOfOnGroundAircraft(const aviation::CAircraftSituation &reference,

                                                                 const physical_quantities::CLength &range,

                                                                 int minValues, int sufficientValues) const;


         aviation::CAltitude highestElevation() const;


         bool requestElevation(const geo::ICoordinateGeodetic &reference, const aviation::CCallsign &callsign);


         bool requestElevation(const aviation::CAircraftSituation &situation);


         QPair<int, int> getElevationsFoundMissed() const;


         QString getElevationsFoundMissedInfo() const;


         QPair<qint64, qint64> getElevationRequestTimes() const;


         QString getElevationRequestTimesInfo() const;


         CSimulatorPluginInfo getSimulatorPluginInfo() const;


         CSimulatorInfo getSimulatorInfo() const;


         QString getSimulatorNameAndVersion() const;


         CAircraftModel getDefaultModel() const;


         physical_quantities::CLength getSimulatorCG(const aviation::CCallsign &callsign) const;


         physical_quantities::CLength getSimulatorOrDbCG(const aviation::CCallsign &callsign,

                                                         const physical_quantities::CLength &dbCG) const;


         bool hasSimulatorCG(const aviation::CCallsign &callsign) const;


         bool cleanElevationValues(const aviation::CAircraftSituation &reference,

                                   const physical_quantities::CLength &range, bool forced = false);


     protected:

         CSimulationEnvironmentAware() {}


         CSimulationEnvironmentAware(ISimulationEnvironmentProvider *simEnvProvider) : IProviderAware(simEnvProvider)

         {

             Q_ASSERT(simEnvProvider);

         }

     };

 } // namespace swift::misc::simulation


 Q_DECLARE_INTERFACE(swift::misc::simulation::ISimulationEnvironmentProvider,

                     "org.swift-project.misc::simulation::isimulationenvironmentprovider")


 #endif // SWIFT_MISC_SIMULATION_SIMULATIONENVIRONMENTPROVIDER_H

aircraftmodel.h

aircraftsituation.h

QHash< CCallsign, physical_quantities::CLength >

swift::misc::IProviderAware
Base class of provider aware classes.
Definition: provider.h:41

swift::misc::IProvider
Base class for providers.
Definition: provider.h:19

swift::misc::aviation::CAircraftSituation
Value object encapsulating information of an aircraft's situation.
Definition: aircraftsituation.h:54

swift::misc::aviation::CAltitude
Altitude as used in aviation, can be AGL or MSL altitude.
Definition: altitude.h:52

swift::misc::aviation::CCallsign
Value object encapsulating information of a callsign.
Definition: callsign.h:30

swift::misc::aviation::CCallsignSet
Value object for a set of callsigns.
Definition: callsignset.h:26

swift::misc::geo::CCoordinateGeodeticList
Value object encapsulating a list of coordinates.
Definition: coordinategeodeticlist.h:31

swift::misc::geo::CElevationPlane
Plane of same elevation, can be a single point or larger area (e.g. airport)
Definition: elevationplane.h:21

swift::misc::geo::CElevationPlane::singlePointRadius
static const physical_quantities::CLength & singlePointRadius()
Radius for single point.
Definition: elevationplane.cpp:173

swift::misc::geo::ICoordinateGeodetic
Geodetic coordinate, a position in 3D space relative to the reference geoid.
Definition: coordinategeodetic.h:39

swift::misc::physical_quantities::CLength
Physical unit length (length)
Definition: length.h:18

swift::misc::simulation::CAircraftModel
Aircraft model (used by another pilot, my models on disk)
Definition: aircraftmodel.h:71

swift::misc::simulation::CSimulationEnvironmentAware
Class which can be directly used to access an.
Definition: simulationenvironmentprovider.h:337

swift::misc::simulation::CSimulationEnvironmentAware::CSimulationEnvironmentAware
CSimulationEnvironmentAware(ISimulationEnvironmentProvider *simEnvProvider)
Constructor.
Definition: simulationenvironmentprovider.h:410

swift::misc::simulation::CSimulationEnvironmentAware::setSimulationEnvironmentProvider
void setSimulationEnvironmentProvider(ISimulationEnvironmentProvider *provider)
Set the provider.
Definition: simulationenvironmentprovider.h:342

swift::misc::simulation::CSimulationEnvironmentAware::CSimulationEnvironmentAware
CSimulationEnvironmentAware()
Default constructor.
Definition: simulationenvironmentprovider.h:407

swift::misc::simulation::CSimulatorInfo
Simple hardcoded info about the corresponding simulator.
Definition: simulatorinfo.h:41

swift::misc::simulation::CSimulatorPluginInfo
Describing a simulator plugin.
Definition: simulatorplugininfo.h:24

swift::misc::simulation::ISimulationEnvironmentProvider
Direct in memory access to elevation data.
Definition: simulationenvironmentprovider.h:28

swift::misc::simulation::ISimulationEnvironmentProvider::requestElevation
virtual bool requestElevation(const geo::ICoordinateGeodetic &reference, const aviation::CCallsign &callsign)=0
Request elevation, there is no guarantee the requested elevation will be available in the provider.

swift::misc::simulation::settings::CSimulatorSettings
Settings for simulator Driver independent parts (such as directories), also used in model loaders.
Definition: simulatorsettings.h:31

coordinategeodeticlist.h

elevationplane.h

length.h

percallsign.h

provider.h

simulatorplugininfo.h

simulatorsettings.h

SWIFT_MISC_EXPORT
#define SWIFT_MISC_EXPORT
Export a class or function from the library.
Definition: swiftmiscexport.h:19