pilotclient/src/xswiftbus/weather.h

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

#ifndef BLACKSIM_XSWIFTBUS_WEATHER_H
#define BLACKSIM_XSWIFTBUS_WEATHER_H

//! \file

#ifndef NOMINMAX
#    define NOMINMAX
#endif
#include "dbusobject.h"
#include "datarefs.h"

//! \cond PRIVATE
#define XSWIFTBUS_WEATHER_INTERFACENAME "org.swift_project.xswiftbus.weather"
#define XSWIFTBUS_WEATHER_OBJECTPATH "/xswiftbus/weather"
//! \endcond

namespace XSwiftBus
{
    /*!
     * xswiftbus weather object which is accessible through DBus
     */
    class CWeather : public CDBusObject
    {
    public:
        //! Constructor
        CWeather(CSettingsProvider *settingsProvider);

        //! DBus interface name
        static const std::string &InterfaceName()
        {
            static std::string s(XSWIFTBUS_WEATHER_INTERFACENAME);
            return s;
        }

        //! DBus object path
        static const std::string &ObjectPath()
        {
            static std::string s(XSWIFTBUS_WEATHER_OBJECTPATH);
            return s;
        }

        //! True if the sim is using X-Plane built-in real weather source.
        bool isUsingRealWeather() const { return m_useRealWeather.get(); }

        //! Set whether or not to use X-Plane built-in real weather source.
        void setUseRealWeather(bool enable) { m_useRealWeather.set(enable ? 1 : 0); }

        //! Set reported visibility in meters.
        void setVisibility(double visibilityM) { m_visibilityM.set(static_cast<float>(visibilityM)); }

        //! Set temperature at sea level in degrees C.
        void setTemperature(int degreesC) { m_temperatureC.setAsInt(degreesC); }

        //! Set dew point at sea level in degrees C.
        void setDewPoint(int degreesC) { m_dewPointC.setAsInt(degreesC); }

        //! Set barometric pressure at sea level in inches of mercury.
        void setQNH(double inHg) { m_qnhInhg.set(static_cast<float>(inHg)); }

        //! Set amount of precipitation between 0 and 1.
        void setPrecipitationRatio(double precipRatio) { m_precipRatio.set(static_cast<float>(precipRatio)); }

        //! Set amount of thunderstorms between 0 and 1.
        void setThunderstormRatio(double cbRatio) { m_cbRatio.set(static_cast<float>(cbRatio)); }

        //! Set amount of turbulence between 0 and 1.
        void setTurbulenceRatio(double turbulenceRatio) { m_turbulenceRatio.set(static_cast<float>(turbulenceRatio)); }

        //! Set runway friction, 0=dry, 1=damp, 2=wet.
        void setRunwayFriction(int friction) { m_runwayFriction.setAsInt(friction); }

        //! Set a cloud layer.
        //! \param layer Layer 0, 1, or 2.
        //! \param baseM Cloud base in meters above mean sea level.
        //! \param topsM Cloud tops in meters above mean sea level.
        //! \param type Type of cloud: 0=clear, 1=cirrus, 2=scattered, 3=broken, 4=overcast, 5=stratus.
        //! \param coverage Amount of sky covered [0,6].
        void setCloudLayer(int layer, int baseM, int topsM, int type, int coverage);

        //! Set a wind layer.
        //! \param layer Layer 0, 1, or 2.
        //! \param altitudeM Altitude in middle of layer in meters above mean sea level.
        //! \param directionDeg Direction from which wind is blowing in degrees true.
        //! \param speedKt Wind speed in knots.
        //! \param shearDirectionDeg Direction from which wind shears blow in degrees true.
        //! \param shearSpeedKt Wind speed gain in knots (e.g. speed=10 and shearSpeed=5 means speed varies between 10 and 15).
        //! \param turbulence Amount of turbulence [0,10].
        void setWindLayer(int layer, int altitudeM, double directionDeg, int speedKt, int shearDirectionDeg, int shearSpeedKt, int turbulence);

        //! Perform generic processing
        int process();

    protected:
        virtual DBusHandlerResult dbusMessageHandler(const CDBusMessage &message) override;

    private:
        DataRef<xplane::data::sim::weather::use_real_weather_bool> m_useRealWeather;
        DataRef<xplane::data::sim::weather::visibility_reported_m> m_visibilityM;
        DataRef<xplane::data::sim::weather::rain_percent> m_precipRatio;
        DataRef<xplane::data::sim::weather::thunderstorm_percent> m_cbRatio;
        DataRef<xplane::data::sim::weather::wind_turbulence_percent> m_turbulenceRatio;
        DataRef<xplane::data::sim::weather::temperature_sealevel_c> m_temperatureC;
        DataRef<xplane::data::sim::weather::dewpoi_sealevel_c> m_dewPointC;
        DataRef<xplane::data::sim::weather::barometer_sealevel_inhg> m_qnhInhg;
        DataRef<xplane::data::sim::weather::runway_friction> m_runwayFriction;
        struct
        {
            DataRef<xplane::data::sim::weather::cloud_base_msl_m_0> base;
            DataRef<xplane::data::sim::weather::cloud_tops_msl_m_0> tops;
            DataRef<xplane::data::sim::weather::cloud_type_0> type;
            DataRef<xplane::data::sim::weather::cloud_coverage_0> coverage;
        } m_cloudLayer0;
        struct
        {
            DataRef<xplane::data::sim::weather::cloud_base_msl_m_1> base;
            DataRef<xplane::data::sim::weather::cloud_tops_msl_m_1> tops;
            DataRef<xplane::data::sim::weather::cloud_type_1> type;
            DataRef<xplane::data::sim::weather::cloud_coverage_1> coverage;
        } m_cloudLayer1;
        struct
        {
            DataRef<xplane::data::sim::weather::cloud_base_msl_m_2> base;
            DataRef<xplane::data::sim::weather::cloud_tops_msl_m_2> tops;
            DataRef<xplane::data::sim::weather::cloud_type_2> type;
            DataRef<xplane::data::sim::weather::cloud_coverage_2> coverage;
        } m_cloudLayer2;
        struct
        {
            DataRef<xplane::data::sim::weather::wind_altitude_msl_m_0> altitude;
            DataRef<xplane::data::sim::weather::wind_direction_degt_0> direction;
            DataRef<xplane::data::sim::weather::wind_speed_kt_0> speed;
            DataRef<xplane::data::sim::weather::shear_direction_degt_0> shearDirection;
            DataRef<xplane::data::sim::weather::shear_speed_kt_0> shearSpeed;
            DataRef<xplane::data::sim::weather::turbulence_0> turbulence;
        } m_windLayer0;
        struct
        {
            DataRef<xplane::data::sim::weather::wind_altitude_msl_m_1> altitude;
            DataRef<xplane::data::sim::weather::wind_direction_degt_1> direction;
            DataRef<xplane::data::sim::weather::wind_speed_kt_1> speed;
            DataRef<xplane::data::sim::weather::shear_direction_degt_1> shearDirection;
            DataRef<xplane::data::sim::weather::shear_speed_kt_1> shearSpeed;
            DataRef<xplane::data::sim::weather::turbulence_1> turbulence;
        } m_windLayer1;
        struct
        {
            DataRef<xplane::data::sim::weather::wind_altitude_msl_m_2> altitude;
            DataRef<xplane::data::sim::weather::wind_direction_degt_2> direction;
            DataRef<xplane::data::sim::weather::wind_speed_kt_2> speed;
            DataRef<xplane::data::sim::weather::shear_direction_degt_2> shearDirection;
            DataRef<xplane::data::sim::weather::shear_speed_kt_2> shearSpeed;
            DataRef<xplane::data::sim::weather::turbulence_2> turbulence;
        } m_windLayer2;
    };

}

#endif // guard