service.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_SIM_XSWIFTBUS_SERVICE_H
#define SWIFT_SIM_XSWIFTBUS_SERVICE_H

 
#ifndef NOMINMAX
#    define NOMINMAX
#endif
 
// clang-format off
#include "dbusobject.h"
#include "datarefs.h"
#include "messages.h"
#include "terrainprobe.h"
#include "custom_datarefs.h"
#include <XPLM/XPLMNavigation.h>
#include <string>
#include <chrono>
#include <limits>
// clang-format on

#define XSWIFTBUS_SERVICE_INTERFACENAME "org.swift_project.xswiftbus.service"
#define XSWIFTBUS_SERVICE_OBJECTPATH "/xswiftbus/service"
 
namespace XSwiftBus
{
    class CService : public CDBusObject
    {
    public:
        CService(CSettingsProvider *settingsProvider);

        virtual ~CService() override;

        static const std::string &InterfaceName()
        {
            static const std::string s(XSWIFTBUS_SERVICE_INTERFACENAME);
            return s;
        }

        static const std::string &ObjectPath()
        {
            static const std::string s(XSWIFTBUS_SERVICE_OBJECTPATH);
            return s;
        }

        void onAircraftModelChanged();

        void onSceneryLoaded();

        static std::string getVersionNumber();

        static std::string getCommitHash();

        void addTextMessage(const std::string &text, double red, double green, double blue);

        static std::string getAircraftModelPath();

        static std::string getAircraftModelFilename();

        static std::string getAircraftModelString();

        static std::string getAircraftName();

        std::string getAircraftLivery() const;

        std::string getAircraftIcaoCode() const { return m_icao.get(); }

        std::string getAircraftDescription() const { return m_descrip.get(); }

        static int getXPlaneVersionMajor();

        static int getXPlaneVersionMinor();

        static std::string getXPlaneInstallationPath();

        static std::string getXPlanePreferencesPath();

        bool isPaused() const { return m_paused.get(); }

        bool isUsingRealTime() const { return m_useSystemTime.get(); }

        std::tuple<double, double, double, double> getFrameStats();

        void resetFrameTotals();

        void setFlightNetworkConnected(bool connected);

        void setOwnCallsign(const std::string &callsign);

        double getLatitudeDeg() const { return m_latitude.get(); }

        double getLongitudeDeg() const { return m_longitude.get(); }

        double getAltitudeMslM() const { return m_elevation.get(); }

        double getPressureAltitudeFt() const
        {
            return m_pressureAlt.isValid() ? m_pressureAlt.get() : std::numeric_limits<double>::quiet_NaN();
        }

        double getHeightAglM() const { return m_agl.get(); }

        double getGroundSpeedMps() const { return m_groundSpeed.get(); }

        double getIndicatedAirspeedKias() const { return m_indicatedAirspeed.get(); }

        double getTrueAirspeedKias() const { return m_trueAirspeed.get(); }

        double getPitchDeg() const { return m_pitch.get(); }

        double getRollDeg() const { return m_roll.get(); }

        double getTrueHeadingDeg() const { return m_heading.get(); }

        double getLocalXVelocityMps() const { return isPaused() ? 0 : m_velocityX.get(); }
        double getLocalYVelocityMps() const { return isPaused() ? 0 : m_velocityY.get(); }
        double getLocalZVelocityMps() const { return isPaused() ? 0 : m_velocityZ.get(); }

        double getPitchRadPerSec() const { return isPaused() ? 0 : m_pitchVelocity.get(); }
        double getRollRadPerSec() const { return isPaused() ? 0 : m_rollVelocity.get(); }
        double getHeadingRadPerSec() const { return isPaused() ? 0 : m_headingVelocity.get(); }

        bool getAnyWheelOnGround() const { return m_onGroundAny.get(); }

        bool getAllWheelsOnGround() const { return m_onGroundAll.get(); }

        double getGroundElevation() const
        {
            return m_terrainProbe.getElevation(m_latitude.get(), m_longitude.get(), m_elevation.get())[0];
        }

        int getComSelection() const { return m_comAudioSelection.get(); }
        bool isCom1Selected() const { return this->getComSelection() == 6; }
        bool isCom2Selected() const { return this->getComSelection() == 7; }

        int getCom1ActiveKhz() const { return m_com1Active.get(); }

        int getCom1StandbyKhz() const { return m_com1Standby.get(); }

        bool getCom1Power() const { return m_com1Power.get(); }

        bool getCom1Listening() const { return m_com1Listening.get(); }

        float getCom1Volume() const { return m_com1Volume.get(); }

        bool isCom1Receiving() const { return this->getCom1Power() && this->getCom1Listening(); }

        bool isCom1Transmitting() const { return this->getCom1Power() && this->isCom1Selected(); }

        int getCom2ActiveKhz() const { return m_com2Active.get(); }

        int getCom2StandbyKhz() const { return m_com2Standby.get(); }

        bool getCom2Power() const { return m_com2Power.get(); }

        bool getCom2Listening() const { return m_com2Listening.get(); }

        float getCom2Volume() const { return m_com2Volume.get(); }

        bool isCom2Receiving() const { return this->getCom2Power() && this->getCom2Listening(); }

        bool isCom2Transmitting() const { return this->getCom2Power() && this->isCom2Selected(); }

        int getTransponderCode() const { return m_xpdrCode.get(); }

        int getTransponderMode() const { return m_xpdrMode.get(); }

        bool getTransponderIdent() const { return m_xpdrIdent.get(); }

        bool getBeaconLightsOn() const { return m_beaconLightsOn.get(); }

        bool getLandingLightsOn() const { return m_landingLightsOn.get(); }

        bool getNavLightsOn() const { return m_navLightsOn.get(); }

        bool getStrobeLightsOn() const { return m_strobeLightsOn.get(); }

        bool getTaxiLightsOn() const { return m_taxiLightsOn.get(); }

        double getQNHInHg() const { return m_qnhInhg.get(); }

        void setCom1ActiveKhz(int freq) { m_com1Active.set(freq); }

        void setCom1StandbyKhz(int freq) { m_com1Standby.set(freq); }

        void setCom2ActiveKhz(int freq) { m_com2Active.set(freq); }

        void setCom2StandbyKhz(int freq) { m_com2Standby.set(freq); }

        void setTransponderCode(int code) { m_xpdrCode.set(code); }

        void setTransponderMode(int mode) { m_xpdrMode.set(mode); }

        double getFlapsDeployRatio() const { return m_flapsReployRatio.get(); }

        double getGearDeployRatio() const { return m_gearReployRatio.getAt(0); }

        int getNumberOfEngines() const { return m_numberOfEngines.get(); }

        std::vector<double> getEngineN1Percentage() const
        {
            std::vector<double> list;
            const int number = getNumberOfEngines();
            list.reserve(static_cast<std::vector<double>::size_type>(number));
            for (int engineNumber = 0; engineNumber < number; ++engineNumber)
            {
                list.push_back(m_enginesN1Percentage.getAt(engineNumber));
            }
            return list;
        }

        double getSpeedBrakeRatio() const { return m_speedBrakeRatio.get(); }

        void toggleMessageBoxVisibility() { m_messages.toggle(); }

        void setPopupMessageWindow(bool enabled) { m_popupMessageWindow = enabled; }

        void setDisappearMessageWindow(bool enabled) { m_disappearMessageWindow = enabled; }

        void setDisappearMessageWindowTimeMs(int durationMs);

        std::string getSettingsJson() const;

        void setSettingsJson(const std::string &jsonString);

        int process();
 
    protected:
        DBusHandlerResult dbusMessageHandler(const CDBusMessage &message) override;
 
    private:
        void emitAircraftModelChanged(const std::string &path, const std::string &filename, const std::string &livery,
                                      const std::string &icao, const std::string &modelString, const std::string &name,
                                      const std::string &description);
 
        void emitSceneryLoaded();
 
        CMessageBoxControl m_messages { 16, 16, 16 };
        bool m_popupMessageWindow = true;
        bool m_disappearMessageWindow = true;
        int m_disapperMessageWindowTimeMs = 5000;
        std::chrono::system_clock::time_point m_disappearMessageWindowTime;
        CTerrainProbe m_terrainProbe;

        void updateMessageBoxFromSettings();
 
        struct FramePeriodSampler;
        std::unique_ptr<FramePeriodSampler> m_framePeriodSampler;
 
        DataRef<xplane::data::sim::graphics::scenery::async_scenery_load_in_progress> m_sceneryIsLoading;
        int m_sceneryWasLoading = 0;
 
        CustomDataRef<TSwiftNetworkConnected> m_swiftNetworkConnected;
        CustomDataRef<TSwiftCallsign> m_swiftCallsign;
        StringDataRef<xplane::data::sim::aircraft::view::acf_livery_path> m_liveryPath;
        StringDataRef<xplane::data::sim::aircraft::view::acf_ICAO> m_icao;
        StringDataRef<xplane::data::sim::aircraft::view::acf_descrip> m_descrip;
        DataRef<xplane::data::sim::time::paused> m_paused;
        DataRef<xplane::data::sim::time::use_system_time> m_useSystemTime;
        DataRef<xplane::data::sim::flightmodel::position::latitude> m_latitude;
        DataRef<xplane::data::sim::flightmodel::position::longitude> m_longitude;
        DataRef<xplane::data::sim::flightmodel::position::elevation> m_elevation;
        DataRef<xplane::data::sim::flightmodel2::position::pressure_altitude> m_pressureAlt;
        DataRef<xplane::data::sim::flightmodel::position::y_agl> m_agl;
        DataRef<xplane::data::sim::flightmodel::position::groundspeed> m_groundSpeed;
        DataRef<xplane::data::sim::flightmodel::position::indicated_airspeed2> m_indicatedAirspeed;
        DataRef<xplane::data::sim::flightmodel::position::true_airspeed> m_trueAirspeed;
        DataRef<xplane::data::sim::flightmodel::position::theta> m_pitch;
        DataRef<xplane::data::sim::flightmodel::position::phi> m_roll;
        DataRef<xplane::data::sim::flightmodel::position::psi> m_heading;
        DataRef<xplane::data::sim::flightmodel::position::local_vx> m_velocityX;
        DataRef<xplane::data::sim::flightmodel::position::local_vy> m_velocityY;
        DataRef<xplane::data::sim::flightmodel::position::local_vz> m_velocityZ;
        DataRef<xplane::data::sim::flightmodel::position::Prad> m_rollVelocity;
        DataRef<xplane::data::sim::flightmodel::position::Qrad> m_pitchVelocity;
        DataRef<xplane::data::sim::flightmodel::position::Rrad> m_headingVelocity;
        DataRef<xplane::data::sim::flightmodel::failures::onground_any> m_onGroundAny;
        DataRef<xplane::data::sim::flightmodel::failures::onground_all> m_onGroundAll;
        DataRef<xplane::data::sim::cockpit2::radios::actuators::com1_frequency_hz_833> m_com1Active;
        DataRef<xplane::data::sim::cockpit2::radios::actuators::com1_standby_frequency_hz_833> m_com1Standby;
        DataRef<xplane::data::sim::cockpit2::radios::actuators::audio_com_selection>
            m_comAudioSelection; // 6==COM1, 7==COM2
        DataRef<xplane::data::sim::cockpit2::radios::actuators::com1_power> m_com1Power;
        DataRef<xplane::data::sim::cockpit2::radios::actuators::audio_volume_com1> m_com1Volume; // 0..1
        DataRef<xplane::data::sim::cockpit2::radios::actuators::audio_selection_com1> m_com1Listening;
        DataRef<xplane::data::sim::cockpit2::radios::actuators::com2_frequency_hz_833> m_com2Active;
        DataRef<xplane::data::sim::cockpit2::radios::actuators::com2_standby_frequency_hz_833> m_com2Standby;
        DataRef<xplane::data::sim::cockpit2::radios::actuators::com2_power> m_com2Power;
        DataRef<xplane::data::sim::cockpit2::radios::actuators::audio_volume_com2> m_com2Volume; // 0..1
        DataRef<xplane::data::sim::cockpit2::radios::actuators::audio_selection_com2> m_com2Listening;
        DataRef<xplane::data::sim::cockpit::radios::transponder_code> m_xpdrCode;
        DataRef<xplane::data::sim::cockpit::radios::transponder_mode> m_xpdrMode;
        DataRef<xplane::data::sim::cockpit::radios::transponder_id> m_xpdrIdent;
        DataRef<xplane::data::sim::cockpit::electrical::beacon_lights_on> m_beaconLightsOn;
        DataRef<xplane::data::sim::cockpit::electrical::landing_lights_on> m_landingLightsOn;
        DataRef<xplane::data::sim::cockpit::electrical::nav_lights_on> m_navLightsOn;
        DataRef<xplane::data::sim::cockpit::electrical::strobe_lights_on> m_strobeLightsOn;
        DataRef<xplane::data::sim::cockpit::electrical::taxi_light_on> m_taxiLightsOn;
        DataRef<xplane::data::sim::flightmodel2::controls::flap_handle_deploy_ratio> m_flapsReployRatio;
        ArrayDataRef<xplane::data::sim::flightmodel2::gear::deploy_ratio> m_gearReployRatio;
        DataRef<xplane::data::sim::aircraft::engine::acf_num_engines> m_numberOfEngines;
        ArrayDataRef<xplane::data::sim::flightmodel::engine::ENGN_N1_> m_enginesN1Percentage;
        DataRef<xplane::data::sim::flightmodel2::controls::speedbrake_ratio> m_speedBrakeRatio;
        DataRef<xplane::data::sim::weather::barometer_sealevel_inhg> m_qnhInhg;
    };
} // namespace XSwiftBus
 
#endif // SWIFT_SIM_XSWIFTBUS_SERVICE_H