xswiftbusserviceproxy.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_SIMPLUGIN_XSWIFTBUS_SERVICE_PROXY_H
#define SWIFT_SIMPLUGIN_XSWIFTBUS_SERVICE_PROXY_H
 
#include <functional>
 
#include <QDBusError>
#include <QDBusPendingReply>
#include <QList>
#include <QObject>
#include <QString>
#include <QStringList>
 
#include "misc/genericdbusinterface.h"
 
// clazy:excludeall=const-signal-or-slot
 
class QDBusConnection;
class QDBusPendingCallWatcher;
 
#define XSWIFTBUS_SERVICE_INTERFACENAME "org.swift_project.xswiftbus.service"
#define XSWIFTBUS_SERVICE_OBJECTPATH "/xswiftbus/service"
 
namespace swift::simplugin::xplane
{
    struct XPlaneData;
 
    class CXSwiftBusServiceProxy : public QObject
    {
        Q_OBJECT
 
    public:
        static const QString &InterfaceName()
        {
            static const QString s(XSWIFTBUS_SERVICE_INTERFACENAME);
            return s;
        }
 
        static const QString &ObjectPath()
        {
            static const QString s(XSWIFTBUS_SERVICE_OBJECTPATH);
            return s;
        }
 
        CXSwiftBusServiceProxy(QDBusConnection &connection, QObject *parent = nullptr, bool dummy = false);
 
        bool isValid() const { return m_dbusInterface->isValid(); }
 
        void cancelAllPendingAsyncCalls() { m_dbusInterface->cancelAllPendingAsyncCalls(); }
 
    private:
        swift::misc::CGenericDBusInterface *m_dbusInterface = nullptr;
 
        // Returns a function object which can be passed to CGenericDBusInterface::callDBusAsync.
        template <typename T>
        std::function<void(QDBusPendingCallWatcher *)> setterCallback(T *obj)
        {
            return [this, obj](QDBusPendingCallWatcher *watcher) {
                QDBusPendingReply<T> reply = *watcher;
                if (reply.isError()) { emit this->asyncMethodError(reply.error()); }
                else { *obj = reply; }
                watcher->deleteLater();
            };
        }
 
    signals:
        SWIFT_NO_RELAY void asyncMethodError(QDBusError error);
 
        void aircraftModelChanged(const QString &path, const QString &filename, const QString &livery,
                                  const QString &icao, const QString &modelString, const QString &name,
                                  const QString &description);
 
        void sceneryLoaded();
 
    public slots:
        QString getVersionNumber();
 
        QString getCommitHash();
 
        void getOwnAircraftSituationDataAsync(swift::simplugin::xplane::XPlaneData *o_xplaneData);
 
        void getOwnAircraftVelocityDataAsync(swift::simplugin::xplane::XPlaneData *o_xplaneData);
 
        void getOwnAircraftCom1DataAsync(swift::simplugin::xplane::XPlaneData *o_xplaneData);
 
        void getOwnAircraftCom2DataAsync(swift::simplugin::xplane::XPlaneData *o_xplaneData);
 
        void getOwnAircraftXpdrAsync(swift::simplugin::xplane::XPlaneData *o_xplaneData);
 
        void getOwnAircraftLightsAsync(swift::simplugin::xplane::XPlaneData *o_xplaneData);
 
        void getOwnAircraftPartsAsync(swift::simplugin::xplane::XPlaneData *o_xplaneData);
 
        void getOwnAircraftModelDataAsync(swift::simplugin::xplane::XPlaneData *o_xplaneData);
 
        void addTextMessage(const QString &text, double red, double green, double blue);
 
        QString getAircraftModelPath() const;
        void getAircraftModelPathAsync(QString *o_modelPath);
 
        QString getAircraftModelFilename() const;
        void getAircraftModelFilenameAsync(QString *o_modelFilename);
 
        QString getAircraftLivery() const;
        void getAircraftLiveryAsync(QString *o_modelLivery);
 
        QString getAircraftIcaoCode() const;
        void getAircraftIcaoCodeAsync(QString *o_icaoCode);
 
        QString getAircraftDescription() const;
        void getAircraftDescriptionAsync(QString *o_description);
 
        QString getAircraftModelString() const;
        void getAircraftModelStringAsync(QString *o_modelString);
 
        QString getAircraftName() const;
        void getAircraftNameAsync(QString *o_name);
 
        int getXPlaneVersionMajor() const;
        void getXPlaneVersionMajorAsync(int *o_versionMajor);
 
        int getXPlaneVersionMinor() const;
        void getXPlaneVersionMinorAsync(int *o_versionMinor);
 
        QString getXPlaneInstallationPath() const;
        void getXPlaneInstallationPathAsync(QString *o_installPath);
 
        QString getXPlanePreferencesPath() const;
        void getXPlanePreferencesPathAsync(QString *o_prefsPath);
 
        bool isPaused() const;
        void isPausedAsync(bool *o_paused);
 
        bool isUsingRealTime() const;
        void isUsingRealTimeAsync(bool *o_isRealTime);
 
        void getFrameStats(double *o_averageFps, double *o_simTimeRatio, double *o_trackMilesShort,
                           double *o_minutesLate) const;
        void getFrameStatsAsync(double *o_averageFps, double *o_simTimeRatio, double *o_trackMilesShort,
                                double *o_minutesLate);
 
        void resetFrameTotals();
 
        double getLatitudeDeg() const;
        void getLatitudeDegAsync(double *o_latitude);
 
        double getLongitudeDeg() const;
        void getLongitudeDegAsync(double *o_longitude);
 
        double getAltitudeMslM() const;
        void getAltitudeMslMAsync(double *o_altitude);
 
        double getPressureAltitudeFt() const;
        void getPressureAltitudeFtAsync(double *o_altitude);
 
        double getHeightAglM() const;
        void getHeightAglMAsync(double *o_height);
 
        double getGroundSpeedMps() const;
        void getGroundSpeedMpsAsync(double *o_groundspeed);
 
        double getIndicatedAirspeedKias() const;
        void getIndicatedAirspeedKiasAsync(double *o_ias);
 
        double getTrueAirspeedKias() const;
        void getTrueAirspeedKiasAsync(double *o_tas);
 
        double getPitchDeg() const;
        void getPitchDegAsync(double *o_pitch);
 
        double getRollDeg() const;
        void getRollDegAsync(double *o_roll);
 
        double getTrueHeadingDeg() const;
        void getTrueHeadingDegAsync(double *o_heading);
 
        double getLocalXVelocityMps() const;
        void getLocalXVelocityMpsAsync(double *o_velocity);
 
        double getLocalYVelocityMps() const;
        void getLocalYVelocityMpsAsync(double *o_velocity);
 
        double getLocalZVelocityMps() const;
        void getLocalZVelocityMpsAsync(double *o_velocity);
 
        double getPitchRadPerSec() const;
        void getPitchRadPerSecAsync(double *o_radPerSec);
 
        double getRollRadPerSec() const;
        void getRollRadPerSecAsync(double *o_radPerSec);
 
        double getHeadingRadPerSec() const;
        void getHeadingRadPerSecAsync(double *o_radPerSec);
 
        bool getAnyWheelOnGround() const;
        void getAnyWheelOnGroundAsync(bool *o_anyWheel);
 
        bool getAllWheelsOnGround() const;
        void getAllWheelsOnGroundAsync(bool *o_allWheels);
 
        double getGroundElevation() const;
        void getGroundElevationAsync(double *o_elevationM);
 
        int getCom1ActiveKhz() const;
        void getCom1ActiveKhzAsync(int *o_com1Active);
 
        int getCom1StandbyKhz() const;
        void getCom1StandbyKhzAsync(int *o_com1Standby);
 
        bool isCom1Receiving() const;
        void isCom1ReceivingAsync(bool *o_com1Rec);
 
        bool isCom1Transmitting() const;
        void isCom1TransmittingAsync(bool *o_com1Tx);
 
        double getCom1Volume() const;
        void getCom1VolumeAsync(double *o_com1Volume);
 
        int getCom2ActiveKhz() const;
        void getCom2ActiveKhzAsync(int *o_com2Active);
 
        int getCom2StandbyKhz() const;
        void getCom2StandbyKhzAsync(int *o_com2Standby);
 
        bool isCom2Receiving() const;
        void isCom2ReceivingAsync(bool *o_com2Rec);
 
        bool isCom2Transmitting() const;
        void isCom2TransmittingAsync(bool *o_com2Tx);
 
        double getCom2Volume() const;
        void getCom2VolumeAsync(double *o_com2Volume);
 
        int getTransponderCode() const;
        void getTransponderCodeAsync(int *o_xpdrCode);
 
        int getTransponderMode() const;
        void getTransponderModeAsync(int *o_xpdrMode);
 
        bool getTransponderIdent() const;
        void getTransponderIdentAsync(bool *o_ident);
 
        bool getBeaconLightsOn() const;
        void getBeaconLightsOnAsync(bool *o_beaconLightsOn);
 
        bool getLandingLightsOn() const;
        void getLandingLightsOnAsync(bool *o_landingLightsOn);
 
        bool getNavLightsOn() const;
        void getNavLightsOnAsync(bool *o_navLightsOn);
 
        bool getStrobeLightsOn() const;
        void getStrobeLightsOnAsync(bool *o_strobeLightsOn);
 
        bool getTaxiLightsOn() const;
        void getTaxiLightsOnAsync(bool *o_taxiLightsOn);
 
        double getQNHInHg() const;
        void getQNHInHgAsync(double *o_qnh);
 
        void setCom1ActiveKhz(int freq);
 
        void setCom1StandbyKhz(int freq);
 
        void setCom2ActiveKhz(int freq);
 
        void setCom2StandbyKhz(int freq);
 
        void setTransponderCode(int code);
 
        void setTransponderMode(int mode);
 
        double getFlapsDeployRatio() const;
        void getFlapsDeployRatioAsync(double *o_flapsDeployRatio);
 
        double getGearDeployRatio() const;
        void getGearDeployRatioAsync(double *o_gearDeployRatio);
 
        int getNumberOfEngines() const;
        void getNumberOfEnginesAsync(double *o_numberOfEngines);
 
        QList<double> getEngineN1Percentage() const;
        void getEngineN1PercentageAsync(QList<double> *o_engineN1Percentage);
 
        double getSpeedBrakeRatio() const;
        void getSpeedBrakeRatioAsync(double *o_speedBrakeRatio);
 
        QString getSettingsJson() const;
        void getSettingsJsonAsync(QString *o_jsonSettings);
 
        void setSettingsJson(const QString &json);
    };
} // namespace swift::simplugin::xplane
 
#endif // SWIFT_SIMPLUGIN_XSWIFTBUS_SERVICE_PROXY_H