flightplancomponent.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_GUI_COMPONENTS_FLIGHTPLANCOMPONENT_H
#define SWIFT_GUI_COMPONENTS_FLIGHTPLANCOMPONENT_H
 
#include <QFileDialog>
#include <QListWidget>
#include <QMenu>
#include <QNetworkReply>
#include <QObject>
#include <QScopedPointer>
#include <QStringList>
#include <QTabWidget>
#include <QtGlobal>
 
#include "gui/overlaymessagesframe.h"
#include "gui/swiftguiexport.h"
#include "misc/aviation/comnavequipment.h"
#include "misc/aviation/flightplan.h"
#include "misc/aviation/ssrequipment.h"
#include "misc/datacache.h"
#include "misc/directories.h"
#include "misc/identifier.h"
#include "misc/logcategories.h"
#include "misc/network/data/lastserver.h"
#include "misc/network/user.h"
#include "misc/settingscache.h"
#include "misc/simulation/data/lastmodel.h"
#include "misc/simulation/simulatedaircraft.h"
#include "misc/statusmessagelist.h"
 
namespace Ui
{
    class CFlightPlanComponent;
}
namespace swift::gui::components
{
    namespace FlightPlanSettings
    {
        struct TRemarksHistory : public swift::misc::TSettingTrait<QStringList>
        {
            static const char *key() { return "flightplan/remarkshistory"; }
 
            static const QString &humanReadable()
            {
                static const QString name("FP remarks history");
                return name;
            }
        };
 
        struct TRemarksHistoryAdditional : public swift::misc::TSettingTrait<QStringList>
        {
            static const char *key() { return "flightplan/remarkshistoryadd"; }
 
            static const QString &humanReadable()
            {
                static const QString name("FP remarks history (add)");
                return name;
            }
        };
    } // namespace FlightPlanSettings
 
    class CStringListDialog;
    class CAltitudeDialog;
    class CSimBriefDownloadDialog;
 
    class SWIFT_GUI_EXPORT CFlightPlanComponent : public COverlayMessagesTabWidget
    {
        Q_OBJECT
 
    public:
        explicit CFlightPlanComponent(QWidget *parent = nullptr);
 
        ~CFlightPlanComponent() override;
 
        void loginDataSet();
 
        void fillWithFlightPlanData(const swift::misc::aviation::CFlightPlan &flightPlan);
 
        const swift::misc::aviation::CFlightPlan &getSentFlightPlan() const { return m_sentFlightPlan; }
 
        static const QStringList &getLogCategories();
 
    private:
        static constexpr std::chrono::milliseconds OverlayTimeout { 5000 };
        QScopedPointer<Ui::CFlightPlanComponent> ui;
        CAltitudeDialog *m_altitudeDialog = nullptr;
        CStringListDialog *m_fpRemarksDialog = nullptr;
        CSimBriefDownloadDialog *m_simBriefDialog = nullptr;
        QMenu *m_navComEquipmentMenu = nullptr;
        QMenu *m_ssrEquipmentMenu = nullptr;
        swift::misc::aviation::CFlightPlan m_sentFlightPlan; 
        swift::misc::simulation::CAircraftModel m_model; 
        swift::misc::aviation::CComNavEquipment m_navComEquipment; 
        swift::misc::aviation::CSsrEquipment m_ssrEquipment; 
        swift::misc::CIdentifier m_identifier { "FlightPlanComponent", this }; 
        swift::misc::CSetting<swift::misc::settings::TDirectorySettings> m_directories {
            this
        }; 
        swift::misc::CSetting<FlightPlanSettings::TRemarksHistory> m_remarksHistory { this }; 
        swift::misc::CSetting<FlightPlanSettings::TRemarksHistoryAdditional> m_remarksHistoryAdditional {
            this
        }; 
        swift::misc::CDataReadOnly<swift::misc::simulation::data::TLastModel> m_lastAircraftModel {
            this
        }; 
        swift::misc::CDataReadOnly<swift::misc::network::data::TLastServer> m_lastServer {
            this
        }; 
 
        struct WakeTurbulenceEntry
        {
            QString m_name; 
            swift::misc::aviation::CWakeTurbulenceCategory m_wtc; 
        };
 
        const QList<WakeTurbulenceEntry> m_wakeTurbulenceCategories = {
            { "Light", swift::misc::aviation::CWakeTurbulenceCategory::LIGHT },
            { "Medium", swift::misc::aviation::CWakeTurbulenceCategory::MEDIUM },
            { "Heavy", swift::misc::aviation::CWakeTurbulenceCategory::HEAVY },
            { "Super", swift::misc::aviation::CWakeTurbulenceCategory::SUPER }
        }; 
 
        swift::misc::CStatusMessageList validateAndInitializeFlightPlan(swift::misc::aviation::CFlightPlan &fligtPlan);
 
        static const QString &defaultIcao()
        {
            static const QString d("ICAO");
            return d;
        }
 
        static const QString &defaultTime()
        {
            static const QString t("00:00");
            return t;
        }
 
        const swift::misc::CIdentifier &flightPlanIdentifier() const { return m_identifier; }
 
        void prefillWithOwnAircraftData();
 
        void prefillWithAircraftData(const swift::misc::simulation::CSimulatedAircraft &aircraft, bool force = false);
 
        void prefillWithUserData(const swift::misc::network::CUser &user);
 
        void initCompleters();
 
        QString getDefaultFilename(bool load);
 
        void currentTextChangedToBuildRemarks(const QString &text)
        {
            this->buildRemarksString();
            Q_UNUSED(text)
        }
 
        void syncVoiceComboBoxes(const QString &text);
 
        void sendFlightPlan();
 
        void resetFlightPlan();
 
        void loadFromDisk();
 
        void loadTemplateFromDisk();
 
        void saveToDisk();
 
        bool saveFPToDisk(const QString &fileName);
 
        void saveTemplateToDisk();
 
        void clearTemplate();
 
        QString getTemplateName() const;
 
        void setSelcalInOwnAircraft();
 
        void loadFlightPlanFromNetwork();
 
        void buildRemarksString();
 
        void copyRemarksConfirmed() { this->copyRemarks(true); }
 
        void copyRemarks(bool confirm = true);
 
        void currentTabGenerator();
 
        void swiftWebDataRead();
 
        void aircraftTypeChanged();
 
        void syncWithSimulator();
 
        swift::misc::aviation::CAircraftIcaoCode getAircraftIcaoCode() const;
 
        void showEquipmentCodesTab();
 
        bool isVfr() const;
 
        swift::misc::aviation::CFlightPlan::FlightRules getFlightRules() const;
 
        bool overrideRemarks();
 
        void updateDirectorySettings(const QString &fileOrDirectory);
 
        void altitudeDialog();
 
        void remarksHistory();
 
        void updateRemarksHistories();
 
        void setRemarksUIValues(const QString &remarks);
 
        void loadFromSimBrief();
 
        void handleSimBriefResponse(QNetworkReply *nwReplyPtr);
 
        void setupNavComContextMenu();
 
        void setupSsrContextMenu();
 
        void updateNavComEquipmentFromSelection();
 
        void updateSsrEquipmentFromSelection();
 
        void updateNavComEquipmentUi();
 
        void updateSsrEquipmentUi();
 
        void updateWakeTurbulenceCategorySelector(const swift::misc::aviation::CWakeTurbulenceCategory &wtc);
 
        swift::misc::aviation::CWakeTurbulenceCategory getSelectedWakeTurbulenceCategory() const;
 
        static QListWidget *getMenuEquipmentList(QMenu *menu);
 
        static void updateListSelection(QMenu *menu, const QStringList &enabledOptions);
 
        static bool consolidateRemarks(QStringList &remarks, const QString &newRemarks);
    };
} // namespace swift::gui::components
#endif // SWIFT_GUI_COMPONENTS_FLIGHTPLANCOMPONENT_H