/* Copyright (C) 2013 * 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. */ #ifndef BLACKSIM_XSWIFTBUS_SERVICE_H #define BLACKSIM_XSWIFTBUS_SERVICE_H //! \file #ifndef NOMINMAX #define NOMINMAX #endif #include "dbusobject.h" #include "datarefs.h" #include "messages.h" #include "navdatareference.h" #include #include #include //! \cond PRIVATE #define XSWIFTBUS_SERVICE_INTERFACENAME "org.swift_project.xswiftbus.service" #define XSWIFTBUS_SERVICE_OBJECTPATH "/xswiftbus/service" //! \endcond namespace XSwiftBus { /*! * XSwiftBus service object which is accessible through DBus */ class CService : public CDBusObject { public: //! Constructor CService(); //! Destructor ~CService() override = default; //! DBus interface name static const std::string &InterfaceName() { static const std::string s(XSWIFTBUS_SERVICE_INTERFACENAME); return s; } //! DBus object path static const std::string &ObjectPath() { static const std::string s(XSWIFTBUS_SERVICE_OBJECTPATH); return s; } //! Called by XPluginReceiveMessage when the model changes. void onAircraftModelChanged(); //! Returns the XSwiftBus version number std::string getVersionNumber() const { return XSWIFTBUS_VERSION; } //! Add a text message to the on-screen display, with RGB components in the range [0,1] void addTextMessage(const std::string &text, double red, double green, double blue); //! Called by newly connected client to cause airportsInRangeUpdated to be emitted. void updateAirportsInRange(); //! Get full path to current aircraft model std::string getAircraftModelPath() const; //! Get base filename of current aircraft model std::string getAircraftModelFilename() const; //! Get canonical swift model string of current aircraft model std::string getAircraftModelString() const; //! Get name of current aircraft model std::string getAircraftName() const; //! Get current aircraft livery std::string getAircraftLivery() const; //! Get the ICAO code of the current aircraft model std::string getAircraftIcaoCode() const { return m_icao.get(); } //! Get the description of the current aircraft model std::string getAircraftDescription() const { return m_descrip.get(); } //! Get major version number int getXPlaneVersionMajor() const; //! Get minor version number int getXPlaneVersionMinor() const; //! Get root of X-Plane install path std::string getXPlaneInstallationPath() const; //! Get full path to X-Plane preferences file std::string getXPlanePreferencesPath() const; //! True if sim is paused bool isPaused() const { return m_paused.get(); } //! True if sim time is tracking operating system time bool isUsingRealTime() const { return m_useSystemTime.get(); } //! Get aircraft latitude in degrees double getLatitudeDeg() const { return m_latitude.get(); } //! Get aircraft longitude in degrees double getLongitudeDeg() const { return m_longitude.get(); } //! Get aircraft altitude in meters double getAltitudeMslM() const { return m_elevation.get(); } //! Get aircraft height in meters double getHeightAglM() const { return m_agl.get(); } //! Get aircraft groundspeed in meters per second double getGroundSpeedMps() const { return m_groundSpeed.get(); } //! Get aircraft IAS in knots double getIndicatedAirspeedKias() const { return m_indicatedAirspeed.get(); } //! Get aircraft TAS in meters per second double getTrueAirspeedKias() const { return m_trueAirspeed.get(); } //! Get aircraft pitch in degrees above horizon double getPitchDeg() const { return m_pitch.get(); } //! Get aircraft roll in degrees double getRollDeg() const { return m_roll.get(); } //! Get aircraft true heading in degrees double getTrueHeadingDeg() const { return m_heading.get(); } //! Get whether any wheel is on the ground bool getAnyWheelOnGround() const { return m_onGroundAny.get(); } //! Get whether all wheels are on the ground bool getAllWheelsOnGround() const { return m_onGroundAll.get(); } //! Get the current COM1 active frequency in kHz int getCom1ActiveKhz() const { return m_com1Active.get() * 10; } //! Get the current COM1 standby frequency in kHz int getCom1StandbyKhz() const { return m_com1Standby.get() * 10; } //! Get the current COM2 active frequency in kHz int getCom2ActiveKhz() const { return m_com2Active.get() * 10; } //! Get the current COM2 standby frequency in kHz int getCom2StandbyKhz() const { return m_com2Standby.get() * 10; } //! Get the current transponder code in decimal int getTransponderCode() const { return m_xpdrCode.get(); } //! Get the current transponder mode (depends on the aircraft, 0 and 1 usually mean standby, >1 active) int getTransponderMode() const { return m_xpdrMode.get(); } //! Get whether we are currently squawking ident bool getTransponderIdent() const { return m_xpdrIdent.get(); } //! Get whether beacon lights are on bool getBeaconLightsOn() const { return m_beaconLightsOn.get(); } //! Get whether landing lights are on bool getLandingLightsOn() const { return m_landingLightsOn.get(); } //! Get whether nav lights are on bool getNavLightsOn() const { return m_navLightsOn.get(); } //! Get whether strobe lights are on bool getStrobeLightsOn() const { return m_strobeLightsOn.get(); } //! Get whether taxi lights are on bool getTaxiLightsOn() const { return m_taxiLightsOn.get(); } //! Get barometric pressure at sea level in inches of mercury. double getQNHInHg() const { return m_qnhInhg.get(); } //! Set the current COM1 active frequency in kHz void setCom1ActiveKhz(int freq) { m_com1Active.set(freq / 10); } //! Set the current COM1 standby frequency in kHz void setCom1StandbyKhz(int freq) { m_com1Standby.set(freq / 10); } //! Set the current COM2 active frequency in kHz void setCom2ActiveKhz(int freq) { m_com2Active.set(freq / 10); } //! Set the current COM2 standby frequency in kHz void setCom2StandbyKhz(int freq) { m_com2Standby.set(freq / 10); } //! Set the current transponder code in decimal void setTransponderCode(int code) { m_xpdrCode.set(code); } //! Set the current transponder mode (depends on the aircraft, 0 and 1 usually mean standby, >1 active) void setTransponderMode(int mode) { m_xpdrMode.set(mode); } //! Get flaps deploy ratio, where 0.0 is flaps fully retracted, and 1.0 is flaps fully extended. double getFlapsDeployRatio() const { return m_flapsReployRatio.get(); } //! Get gear deploy ratio, where 0 is up and 1 is down double getGearDeployRatio() const { return m_gearReployRatio.get(); } //! Get the number of engines of current aircraft int getNumberOfEngines() const { return m_numberOfEngines.get(); } //! Get the N1 speed as percent of max (per engine) std::vector getEngineN1Percentage() const { std::vector list; const auto number = static_cast(getNumberOfEngines()); list.reserve(number); for (unsigned int engineNumber = 0; engineNumber < number; ++engineNumber) { list.push_back(m_enginesN1Percentage.getAt(engineNumber)); } return list; } //! Get the ratio how much the speedbrakes surfaces are extended (0.0 is fully retracted, and 1.0 is fully extended) double getSpeedBrakeRatio() const { return m_speedBrakeRatio.get(); } //! \copydoc XSwiftBus::CMessageBoxControl::toggle void toggleMessageBoxVisibility() { m_messages.toggle(); } //! Enable/disable message window popping up for new messages void setPopupMessageWindow(bool enabled) { m_popupMessageWindow = enabled; } //! Enable/disable message window disappearing again after 5 seconds void setDisappearMessageWindow(bool enabled) { m_disappearMessageWindow = enabled; } //! Perform generic processing 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 emitAirportsInRangeUpdated(const std::vector &icaoCodes, const std::vector &names, const std::vector &lats, const std::vector &lons, const std::vector &alts); CMessageBoxControl m_messages { 16, 16, 16 }; bool m_popupMessageWindow = true; bool m_disappearMessageWindow = true; std::chrono::system_clock::time_point m_disappearMessageWindowTime; std::vector m_airports; void readAirportsDatabase(); std::vector findClosestAirports(int number, double latitude, double longitude); StringDataRef m_liveryPath; StringDataRef m_icao; StringDataRef m_descrip; DataRef m_paused; DataRef m_useSystemTime; DataRef m_latitude; DataRef m_longitude; DataRef m_elevation; DataRef m_agl; DataRef m_groundSpeed; DataRef m_indicatedAirspeed; DataRef m_trueAirspeed; DataRef m_pitch; DataRef m_roll; DataRef m_heading; DataRef m_onGroundAny; DataRef m_onGroundAll; DataRef m_com1Active; DataRef m_com1Standby; DataRef m_com2Active; DataRef m_com2Standby; DataRef m_xpdrCode; DataRef m_xpdrMode; DataRef m_xpdrIdent; DataRef m_beaconLightsOn; DataRef m_landingLightsOn; DataRef m_navLightsOn; DataRef m_strobeLightsOn; DataRef m_taxiLightsOn; DataRef m_flapsReployRatio; DataRef m_gearReployRatio; DataRef m_numberOfEngines; ArrayDataRef m_enginesN1Percentage; DataRef m_speedBrakeRatio; DataRef m_qnhInhg; }; } #endif // guard