fsuipc.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2014 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_SIMPLUGIN_FSUIPC_H
#define SWIFT_SIMPLUGIN_FSUIPC_H
 
#include <QStringList>
 
#include "misc/simulation/simulatedaircraft.h"
#include "plugins/simulator/fscommon/fscommonexport.h"
 
namespace swift::simplugin::fscommon
{
    class FSCOMMON_EXPORT CFsuipc : public QObject
    {
        Q_OBJECT
 
    public:
        CFsuipc(QObject *parent = nullptr);
 
        virtual ~CFsuipc() override;
 
        bool open(bool force = false);
 
        void close();
 
        bool isOpened() const;
 
        bool isOpen() const;
 
        bool write(const swift::misc::aviation::CTransponder &xpdr);
 
        bool setSimulatorTime(int hour, int minute);
 
        QString getVersion() const;
 
        bool read(swift::misc::simulation::CSimulatedAircraft &aircraft, bool cockpit, bool situation,
                  bool aircraftParts);
 
        static const QStringList &errorMessages()
        {
            static const QStringList errors({
                "Okay",
                "Attempt to Open when already Open",
                "Cannot link to FSUIPC or WideClient",
                "Failed to Register common message with Windows",
                "Failed to create Atom for mapping filename",
                "Failed to create a file mapping object",
                "Failed to open a view to the file map",
                "Incorrect version of FSUIPC, or not FSUIPC",
                "Sim is not version requested",
                "Call cannot execute, link not Open",
                "Call cannot execute: no requests accumulated",
                "IPC timed out all retries",
                "IPC sendmessage failed all retries",
                "IPC request contains bad data",
                "Maybe running on WideClient, but FS not running on Server, or wrong FSUIPC",
                "Read or Write request cannot be added, memory for Process is full",
            });
            return errors;
        }
 
        static const QString &errorMessage(int index)
        {
            if (index >= 0 && index < errorMessages().size()) { return errorMessages().at(index); }
            static const QString unknown("Unknown error message index");
            return unknown;
        }
 
        static const QStringList &simulators()
        {
            static const QStringList sims(
                { "any", "FS98", "FS2000", "CFS2", "CFS1", "Fly!", "FS2002", "FS2004", "FSX", "ESP", "P3D" });
            return sims;
        }
 
        static const QString &simulator(int index)
        {
            if (index >= 0 && index < simulators().size()) { return simulators().at(index); }
            static const QString unknown("Unknown simulator index");
            return unknown;
        }
 
    private:
        bool m_opened = false;
        int m_openCount = 0; 
        int m_closeCount = 0; 
        int m_lastErrorIndex = 0;
        QString m_lastErrorMessage;
        QString m_fsuipcVersion;
 
        unsigned int m_lastTimestamp = 0;
 
        static double intToFractional(double fractional);
    };
} // namespace swift::simplugin::fscommon
 
#endif // SWIFT_SIMPLUGIN_FSUIPC_H