pilotclient/src/blackmisc/simulation/simulationenvironmentprovider.h

/* Copyright (C) 2018
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
 * including this file, may be copied, modified, propagated, or distributed except according to the terms
 * contained in the LICENSE file.
 */

//! \file

#ifndef BLACKMISC_SIMULATION_SIMULATIONENVIRONMENTPROVIDER_H
#define BLACKMISC_SIMULATION_SIMULATIONENVIRONMENTPROVIDER_H

#include "simulatorplugininfo.h"
#include "aircraftmodel.h"
#include "blackmisc/provider.h"
#include "blackmisc/geo/coordinategeodeticlist.h"
#include "blackmisc/geo/elevationplane.h"

#include <QMap>
#include <QObject>
#include <QPair>

namespace BlackMisc
{
    namespace Simulation
    {
        //! Direct in memory access to elevation data
        //! \remark we are interested in elevations of airports
        class BLACKMISC_EXPORT ISimulationEnvironmentProvider : public IProvider
        {
        public:
            //! All remembered coordiantes
            //! \remark might be a relatively large list
            //! \threadsafe
            Geo::CCoordinateGeodeticList getElevationCoordinates() const;

            //! Find closest elevation
            //! \threadsafe
            Geo::CElevationPlane findClosestElevationWithinRange(const Geo::ICoordinateGeodetic &reference, const PhysicalQuantities::CLength &range) const;

            //! Find closest elevation
            //! \threadsafe
            Geo::CElevationPlane findClosestElevationWithinRangeOrRequest(const Geo::ICoordinateGeodetic &reference, const PhysicalQuantities::CLength &range, const Aviation::CCallsign &callsign);

            //! Request elevation, there is no guarantee the requested elevation will be available in the provider
            //! \threadsafe
            virtual bool requestElevation(const Geo::ICoordinateGeodetic &reference, const Aviation::CCallsign &callsign) = 0;

            //! Elevations found/missed statistics
            //! \threadsafe
            QPair<int, int> getElevationsFoundMissed() const;

            //! Get the represented plugin
            //! \threadsafe
            CSimulatorPluginInfo getSimulatorPluginInfo() const;

            //! Get the represented simulator
            //! \threadsafe
            CSimulatorInfo getSimulatorInfo() const;

            //! Default model
            //! \threadsafe
            CAircraftModel getDefaultModel() const;

            //! Get CG per callsign, NULL if not found
            //! \threadsafe
            PhysicalQuantities::CLength getCG(const Aviation::CCallsign &callsign) const;

            //! Has a CG?
            //! \threadsafe
            bool hasCG(const Aviation::CCallsign &callsign) const;

            //! Has the same CG?
            //! \threadsafe
            bool hasSameCG(const PhysicalQuantities::CLength &cg, const Aviation::CCallsign &callsign) const;

        protected:
            //! Ctor
            ISimulationEnvironmentProvider(const CSimulatorPluginInfo &pluginInfo);

            //! New plugin info and default model
            //! \remark normally only used by emulated driver
            //! \threadsafe
            void setNewPluginInfo(const CSimulatorPluginInfo &info, const CAircraftModel &defaultModel);

            //! Default model
            //! \threadsafe
            void setDefaultModel(const CAircraftModel &defaultModel);

            //! Clear default model
            //! \threadsafe
            void clearDefaultModel();

            //! Clear elevations
            void clearElevations();

            //! Clear CGs
            //! \threadsafe
            void clearCGs();

            //! Clear data
            //! \threadsafe
            void clearSimulationEnvironmentData();

            //! Only keep closest ones
            //! \threadsafe
            int cleanUpElevations(const Geo::ICoordinateGeodetic &referenceCoordinate, int maxNumber = MaxElevations);

            //! Remember a given elevation
            //! \threadsafe
            bool rememberGroundElevation(const Geo::ICoordinateGeodetic &elevationCoordinate, const PhysicalQuantities::CLength &epsilon = Geo::CElevationPlane::singlePointRadius()) ;

            //! Remember a given elevation
            //! \threadsafe
            bool rememberGroundElevation(const Geo::CElevationPlane &elevationPlane) ;

            //! Insert or replace a CG
            //! \remark passing a NULL value will remove the CG
            //! \threadsafe
            bool insertCG(const PhysicalQuantities::CLength &cg, const Aviation::CCallsign &cs);

            //! Remove a CG
            //! \threadsafe
            int removeCG(const Aviation::CCallsign &cs);

            //! Min.range considered as single point
            static PhysicalQuantities::CLength minRange(const PhysicalQuantities::CLength &range);

            static constexpr int MaxElevations = 1000;  //!< How many elevations we keep

        private:
            CAircraftModel m_defaultModel; //!< default model
            CSimulatorPluginInfo m_simulatorPluginInfo; //!< info object
            Geo::CCoordinateGeodeticList m_elvCoordinates;
            QMap<Aviation::CCallsign, PhysicalQuantities::CLength> m_cgs; //! CGs
            mutable int m_elvFound = 0;   //!< statistics only
            mutable int m_elvMissed = 0;  //!< statistics only
            mutable QReadWriteLock m_lockElvCoordinates; //!< lock m_coordinates
            mutable QReadWriteLock m_lockCG; //!< lock CGs
            mutable QReadWriteLock m_lockModel; //!< lock models
        };

        //! Class which can be directly used to access an \sa ISimulationEnvironmentProvider object
        class BLACKMISC_EXPORT CSimulationEnvironmentAware : public IProviderAware<ISimulationEnvironmentProvider>
        {
        public:
            //! Set the provider
            void setSimulationEnvironmentProvider(ISimulationEnvironmentProvider *provider) { this->setProvider(provider); }

            //! \copydoc ISimulationEnvironmentProvider::findClosestElevationWithinRange
            Geo::CElevationPlane findClosestElevationWithinRange(const Geo::ICoordinateGeodetic &reference, const PhysicalQuantities::CLength &range) const;

            //! \copydoc ISimulationEnvironmentProvider::findClosestElevationWithinRangeOrRequest
            Geo::CElevationPlane findClosestElevationWithinRangeOrRequest(const Geo::ICoordinateGeodetic &reference, const PhysicalQuantities::CLength &range, const Aviation::CCallsign &callsign);

            //! \copydoc ISimulationEnvironmentProvider::requestElevation
            bool requestElevation(const Geo::ICoordinateGeodetic &reference, const Aviation::CCallsign &callsign);

            //! \copydoc ISimulationEnvironmentProvider::getElevationsFoundMissed
            QPair<int, int> getElevationsFoundMissed() const;

            //! \copydoc ISimulationEnvironmentProvider::getSimulatorPluginInfo
            CSimulatorPluginInfo getSimulatorPluginInfo() const;

            //! \copydoc ISimulationEnvironmentProvider::getSimulatorPluginInfo
            CSimulatorInfo getSimulatorInfo() const;

            //! \copydoc ISimulationEnvironmentProvider::getDefaultModel
            CAircraftModel getDefaultModel() const;

            //! \copydoc ISimulationEnvironmentProvider::getCG
            PhysicalQuantities::CLength getCG(const Aviation::CCallsign &callsign) const;

            //! \copydoc ISimulationEnvironmentProvider::hasCG
            bool hasCG(const Aviation::CCallsign &callsign) const;

        protected:
            //! Default constructor
            CSimulationEnvironmentAware() {}

            //! Constructor
            CSimulationEnvironmentAware(ISimulationEnvironmentProvider *simEnvProvider) : IProviderAware(simEnvProvider) { Q_ASSERT(simEnvProvider); }
        };
    } // namespace
} // namespace

Q_DECLARE_INTERFACE(BlackMisc::Simulation::ISimulationEnvironmentProvider, "org.swift-project.blackmisc::simulation::isimulationenvironmentprovider")

#endif // guard