simconnectdatadefinition.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_FSXCOMMON_SIMCONNECT_DATADEFINITION_H
#define SWIFT_SIMPLUGIN_FSXCOMMON_SIMCONNECT_DATADEFINITION_H
 
#include <algorithm>
 
#include <QString>
#include <QtGlobal>
 
#include "misc/aviation/aircraftlights.h"
#include "misc/simulation/simulatorinfo.h"
#include "plugins/simulator/fsxcommon/fsxcommonexport.h"
#include "plugins/simulator/fsxcommon/simconnectwindows.h"
 
namespace swift::misc::aviation
{
    class CAircraftParts;
}
namespace swift::simplugin::fsxcommon
{
    struct DataDefinitionOwnAircraft
    {
        double latitudeDeg; 
        double longitudeDeg; 
        double altitudeFt; 
        double altitudeAGLFt; 
        double pressureAltitudeM; 
        double cgToGroundFt; 
        double trueHeadingDeg; 
        double pitchDeg; 
        double bankDeg; 
        double velocity; 
        double elevationFt; 
        double simOnGround; 
        // 12
        double lightStrobe; 
        double lightLanding; 
        double lightTaxi; 
        double lightBeacon; 
        double lightNav; 
        double lightLogo; 
        // 18
        double transponderCode; 
        double com1ActiveMHz; 
        double com2ActiveMHz; 
        double com1StandbyMHz; 
        double com2StandbyMHz; 
        double comTransmit1; 
        double comTransmit2; 
        double comReceiveAll; 
        double comTest1; 
        double comTest2; 
        double comStatus1; 
        double comStatus2; 
        // 30
        double flapsHandlePosition; 
        double spoilersHandlePosition; 
        double gearHandlePosition; 
        // 33
        double numberOfEngines; 
        double engine1Combustion; 
        double engine2Combustion; 
        double engine3Combustion; 
        double engine4Combustion; 
        // 38
        double engine1RpmPct; 
        double engine2RpmPct; 
        double engine3RpmPct; 
        double engine4RpmPct; 
        double velocityWorldX; 
        double velocityWorldY; 
        double velocityWorldZ; 
        double rotationVelocityBodyX; 
        double rotationVelocityBodyY; 
        double rotationVelocityBodyZ; 
        // 48
        double altitudeCalibratedFt; 
        // 49
    };
 
    struct DataDefinitionOwnAircraftModel
    {
        char title[256]; 
    };
 
    struct DataDefinitionRemoteAircraftModel
    {
        double cgToGroundFt; 
        char atcType[32]; 
        char atcModel[32]; 
        char atcId[32]; 
        char atcAirlineNumber[64]; 
        char atcFlightNumber[8]; 
        char title[256]; 
    };
 
    struct DataDefinitionRemoteAtc
    {
        // length here is from SimConnect_AddToDataDefinition
        char atcId[32]; 
        char atcAirline[64]; 
        char atcFlightNumber[8]; 
 
        void copyAtcId(const char *c)
        {
            strncpy_s(atcId, c, 10);
            atcId[9] = 0;
        }
        void copyAtcAirline(const char *c)
        {
            strncpy_s(atcAirline, c, 50);
            atcAirline[49] = 0;
        }
        void copyFlightNumber(const char *c)
        {
            strncpy_s(atcFlightNumber, c, 6);
            atcFlightNumber[5] = 0;
        }
 
        void setDefaultValues()
        {
            std::fill(atcId, atcId + 10, static_cast<byte>(0));
            std::fill(atcAirline, atcAirline + 50, static_cast<byte>(0));
            std::fill(atcFlightNumber, atcFlightNumber + 6, static_cast<byte>(0));
        }
    };
 
    struct FSXCOMMON_EXPORT DataDefinitionRemoteAircraftPartsWithoutLights
    {
        double flapsLeadingEdgeLeftPercent; 
        double flapsLeadingEdgeRightPercent; 
        double flapsTrailingEdgeLeftPercent; 
        double flapsTrailingEdgeRightPercent; 
        double gearHandlePosition; 
        double spoilersHandlePosition; 
        double engine1Combustion; 
        double engine2Combustion; 
        double engine3Combustion; 
        double engine4Combustion; 
        double engine1RpmPct; 
        double engine2RpmPct; 
        double engine3RpmPct; 
        double engine4RpmPct; 
 
        DataDefinitionRemoteAircraftPartsWithoutLights();
 
        DataDefinitionRemoteAircraftPartsWithoutLights(const swift::misc::aviation::CAircraftParts &parts);
 
        bool operator==(const DataDefinitionRemoteAircraftPartsWithoutLights &rhs) const;
 
        void setAllEngines(bool on, double engineRpmPct);
 
        void setEngine(int number1based, bool on, double engineRpmPct);
 
        void resetAllFlaps();
 
        void resetSpoilers();
 
        void resetToInvalid();
 
        void initFromParts(const swift::misc::aviation::CAircraftParts &parts);
    };
 
    struct FSXCOMMON_EXPORT DataDefinitionRemoteAircraftLights
    {
        double lightStrobe; 
        double lightLanding; 
        double lightTaxi; 
        double lightBeacon; 
        double lightNav; 
        double lightLogo; 
        double lightRecognition; 
        double lightCabin; 
 
        swift::misc::aviation::CAircraftLights toLights() const;
    };
 
    struct DataDefinitionPosData
    {
        double latitudeDeg; 
        double longitudeDeg; 
        double altitudeFt; 
        double elevationFt; 
        double cgToGroundFt; 
 
        double aboveGroundFt() const { return altitudeFt - elevationFt; }
 
        bool isOnGround() const { return this->aboveGroundFt() < 1.0; }
    };
 
    struct DataDefinitionClientAreaSb
    {
        byte data[128] {}; 
 
        byte getTransponderMode() const { return data[17]; }
 
        byte getIdent() const { return data[19]; }
 
        bool isIdent() const { return getIdent() != 0; }
 
        bool isStandby() const { return getTransponderMode() != 0; }
 
        void setRunning(bool running) { data[0] = running ? 1 : 0; }
 
        void setConnected(bool connected) { data[1] = connected ? 1 : 0; }
 
        void setDefaultValues()
        {
            std::fill(data, data + 128, static_cast<byte>(0));
            data[0] = 1; // SB running, indicates the client is running as external app, 0..not running, 1..external
                         // app, 2..FS module
            data[1] = 0; // SB connected to FSD, 0..not connected, 1..connected
            data[17] = 1; // 1..standby, 0..mode C
            data[19] = 0; // no ident
        }
 
        QString toQString() const;
    };
 
    struct DataDefinitionMSFSTransponderMode
    {
        double transponderMode = 1; 
        double ident = 0; 
    };
 
    enum ClientAreaId
    {
        ClientAreaSquawkBox
    };
 
    // TODO TZ: are there any changes in MSFS2024
    class FSXCOMMON_EXPORT CSimConnectDefinitions
    {
    public:
        enum DataDefiniton
        {
            DataOwnAircraft,
            DataOwnAircraftTitle,
            DataRemoteAircraftLights,
            DataRemoteAircraftPartsWithoutLights,
            DataRemoteAircraftSetPosition, 
            DataRemoteAircraftGetPosition, 
            DataRemoteAircraftModelData, 
            DataRemoteAircraftSetData, 
            DataSimEnvironment,
            DataTransponderModeMSFS,
            DataClientAreaSb, 
            DataClientAreaSbIdent, 
            DataClientAreaSbStandby, 
            DataClientAreaSbConnected, 
            DataClientAreaSbRunning 
        };
 
        enum Request
        {
            RequestOwnAircraft,
            RequestOwnAircraftTitle,
            RequestSbData, 
            RequestMSFSTransponder, 
            RequestFacility,
            RequestEndMarker 
        };
 
        enum SimObjectRequest
        {
            SimObjectBaseId, 
            SimObjectAdd,
            SimObjectRemove,
            SimObjectPositionData,
            SimObjectLights,
            SimObjectModel,
            SimObjectMisc,
            SimObjectEndMarker 
        };
 
        static const QString &requestToString(Request request);
 
        static const QString &simObjectRequestToString(SimObjectRequest simObjectRequest);
 
        CSimConnectDefinitions();
 
        static HRESULT initDataDefinitionsWhenConnected(const HANDLE hSimConnect,
                                                        const swift::misc::simulation::CSimulatorInfo &simInfo);
 
    private:
        static HRESULT initOwnAircraft(const HANDLE hSimConnect);
 
        static HRESULT initRemoteAircraft(const HANDLE hSimConnect);
 
        static HRESULT initRemoteAircraftSimData(const HANDLE hSimConnect);
 
        static HRESULT initRemoteAircraftSimDataSet(const HANDLE hSimConnect);
 
        static HRESULT initSimulatorEnvironment(const HANDLE hSimConnect);
 
        static HRESULT initSbDataArea(const HANDLE hSimConnect);
 
        static HRESULT initMSFSTransponder(const HANDLE hSimConnect);
 
        static HRESULT initMSFS2024Transponder(const HANDLE hSimConnect);
    };
} // namespace swift::simplugin::fsxcommon
 
#endif // SWIFT_SIMPLUGIN_FSXCOMMON_SIMCONNECT_DATADEFINITION_H