pilotclient/src/blackgui/components/atcstationcomponent.h

/* 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. 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.
 */

//! \file

#ifndef BLACKGUI_COMPONENTS_ATCSTATIONCOMPONENT_H
#define BLACKGUI_COMPONENTS_ATCSTATIONCOMPONENT_H

#include "blackgui/settings/viewupdatesettings.h"
#include "blackgui/settings/atcstationssettings.h"
#include "blackgui/overlaymessagesframe.h"
#include "blackgui/blackguiexport.h"
#include "blackcore/network.h"
#include "blackmisc/aviation/atcstation.h"
#include "blackmisc/aviation/comsystem.h"
#include "blackmisc/pq/frequency.h"
#include "blackmisc/identifiable.h"

#include <QDateTime>
#include <QModelIndex>
#include <QObject>
#include <QScopedPointer>
#include <QString>
#include <QTabWidget>
#include <QFrame>
#include <QtGlobal>
#include <QVBoxLayout>
#include <QTimer>
#include <QList>

namespace Ui { class CAtcStationComponent; }
namespace BlackMisc { namespace Aviation { class CCallsign; } }
namespace BlackGui
{
    class CDockWidgetInfoArea;

    namespace Components
    {
        //! ATC stations component
        class BLACKGUI_EXPORT CAtcStationComponent :
            public COverlayMessagesFrameEnableForDockWidgetInfoArea,
            public BlackMisc::CIdentifiable
        {
            Q_OBJECT

        public:
            //! Tab
            //! \remark needs to be in sync with tab order
            enum AtcTab
            {
                TabAtcOnline = 0,
                TabAtcOnlineTree,
                TabAtcBooked
            };

            //! Constructor
            explicit CAtcStationComponent(QWidget *parent = nullptr);

            //! Destructor
            virtual ~CAtcStationComponent() override;

            //! Set tab
            void setTab(AtcTab tab);

            //! Number of booked stations
            int countBookedStations() const;

            //! Number of online stations
            int countOnlineStations() const;

            //! Update stations
            void update();

            //! Get METAR for given ICAO airport code
            void getMetar(const QString &airportIcaoCode);

            //! \copydoc CEnableForDockWidgetInfoArea::setParentDockWidgetInfoArea
            virtual bool setParentDockWidgetInfoArea(BlackGui::CDockWidgetInfoArea *parentDockableWidget) override;

        signals:
            //! Request audio widget
            void requestAudioWidget();

        private:
            //! Set timestampd and call update
            void forceUpdate();

            //! \copydoc Models::CAtcStationListModel::changedAtcStationConnectionStatus
            void changedAtcStationOnlineConnectionStatus(const BlackMisc::Aviation::CAtcStation &station, bool added);

            //! Get all METARs
            void getMetarAsEntered();

            //! Request new ATIS
            void requestAtisUpdates();

            //! A tree view station has been selected
            void onOnlineAtcStationSelected(const BlackMisc::Aviation::CAtcStation &station);

            //! Online ATC station selected
            void onOnlineAtcStationVariantSelected(const BlackMisc::CVariant &object);

            //! Tab changed
            void atcStationsTabChanged();

            //! Booked stations reloading
            void reloadAtcStationsBooked();

            //! Booked stations changed
            void changedAtcStationsBooked();

            //! Online stations changed
            void changedAtcStationsOnline();

            //! Connection status has been changed
            void connectionStatusChanged(BlackCore::INetwork::ConnectionStatus from, BlackCore::INetwork::ConnectionStatus to);

            //! Request dummy ATC online stations
            void testCreateDummyOnlineAtcStations(int number);

            //! Request udpate
            void requestOnlineStationsUpdate();

            //! Info area tab bar has changed
            void infoAreaTabBarChanged(int index);

            //! Count has been changed
            void onCountChanged(int count, bool withFilter);

            //! Online tab info
            void setOnlineTabs(int count, int filtered);

            //! Set COM frequency
            void setComFrequency(const BlackMisc::PhysicalQuantities::CFrequency &frequency, BlackMisc::Aviation::CComSystem::ComUnit unit);

            //! Airports read from web readers
            void airportsRead();

            //! Build a tree view for ATC stations
            void updateTreeView();

            //! Init the completers
            void initCompleters();

            //! Settings have been changed
            void settingsChanged();

            //! Contexts?
            bool canAccessContext() const;

            //! Clear the online views
            void clearOnlineViews();

            //! Inline message
            void showOverlayInlineTextMessage();

            //! Details toggled
            void onDetailsToggled(bool checked);

            //! Get the vertical layout
            QVBoxLayout *vLayout() const;

            QScopedPointer<Ui::CAtcStationComponent> ui;
            QTimer m_updateTimer;
            QList<int> m_stretch;
            QDateTime m_timestampLastReadOnlineStations; //!< stations read
            QDateTime m_timestampOnlineStationsChanged;  //!< stations marked as changed
            QDateTime m_timestampLastReadBookedStations; //!< stations read
            QDateTime m_timestampBookedStationsChanged;  //!< stations marked as changed
            BlackMisc::CSettingReadOnly<BlackGui::Settings::TViewUpdateSettings> m_settingsView { this, &CAtcStationComponent::settingsChanged };
        };
    } // namespace
} // namespace
#endif // guard