grib_request_dlg.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2010 by David S. Register                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, see <https://www.gnu.org/licenses/>. *
 **************************************************************************/
 
#ifndef GRIBREQUESTDIALOG_H_
#define GRIBREQUESTDIALOG_H_
 
#ifndef WX_PRECOMP
#include <wx/wx.h>
#endif
 
#include "grib_ui_dlg_base.h"
#include "grib_ui_dlg.h"
#include "jsonreader.h"
#include "pi_ocpndc.h"
 
#define XYGRIB_MAX_DOWNLOADABLE_GRIB_SIZE_MB 10
 
enum GribDownloadType {
  WORLD,          
  LOCAL,          
  LOCAL_CATALOG,  
  XYGRIB,         
  NONE            
};
 
const std::string CATALOG_URL =
    "https://raw.githubusercontent.com/chartcatalogs/gribcatalog/main/"
    "sources.json";
 
enum ZoneSelectionRenderState {
  RENDER_NONE = 0,      // No selection zone to render
  RENDER_COMPLETE = 1,  // Selection is complete, render the final zone
  RENDER_DRAWING = 2    // User is actively drawing the selection zone
};
 
class GribRequestSetting : public GribRequestSettingBase {
public:
  GribRequestSetting(GRIBUICtrlBar &parent);
 
  ~GribRequestSetting() override;
 
  void OnClose(wxCloseEvent &event) override;
  void SetVpSize(PlugIn_ViewPort *vp);
  void OnVpUnderMouseChange(PlugIn_ViewPort *vp);
  void OnVpWithFocusChange(PlugIn_ViewPort *vp);
  bool MouseEventHook(wxMouseEvent &event);
  bool RenderZoneOverlay(wxDC &dc);
  bool RenderGlZoneOverlay();
  bool DoRenderZoneOverlay();
  void SetRequestDialogSize();
  void StopGraphicalZoneSelection();
  void UpdateAreaSelectionState();
  [[nodiscard]] double GetMinLat() const;
  [[nodiscard]] double GetMaxLat() const;
  [[nodiscard]] double GetMinLon() const;
  [[nodiscard]] double GetMaxLon() const;
 
  [[nodiscard]] int GetBoundingBoxCanvasIndex() const {
    return m_boundingBoxCanvasIndex;
  }
 
  void Save() {
    wxCommandEvent evt;
    OnOK(evt);
  }
 
  wxString m_RequestConfigBase;
  wxString m_MailToAddresses;
  ZoneSelectionRenderState m_RenderSelectionZoneState;
 
  wxPoint m_StartPoint;
  double m_StartLat;
  double m_StartLon;
 
  PlugIn_ViewPort *m_VpFocus;
  PlugIn_ViewPort *m_VpMouse;
  double m_Lat;
  double m_Lon;
 
protected:
  void OnTopChange(wxCommandEvent &event) override;
  void OnMovingClick(wxCommandEvent &event) override;
  void OnAnyChange(wxCommandEvent &event) override;
  void OnAnySpinChange(wxSpinEvent &event) override {
    wxCommandEvent evt;
    OnAnyChange(evt);
  }
  void OnNotebookPageChanged(wxNotebookEvent &event) override {
    HighlightArea(0, 0, 0, 0);
  }
  void OnTimeRangeChange(wxCommandEvent &event) override;
  void OnSendMaiL(wxCommandEvent &event) override;
  void OnOK(wxCommandEvent &event) override;
  void OnZoneSelectionModeChange(wxCommandEvent &event) override;
  void OnCancel(wxCommandEvent &event) override {
    wxCloseEvent evt;
    OnClose(evt);
  }
  void OnWorldLengthChoice(wxCommandEvent &event) override { event.Skip(); }
  void OnWorldResolutionChoice(wxCommandEvent &event) override { event.Skip(); }
  void OnWorldDownload(wxCommandEvent &event) override;
  void OnLocalTreeItemExpanded(wxTreeEvent &event) override { event.Skip(); }
  void OnLocalTreeSelChanged(wxTreeEvent &event) override;
  void OnUpdateLocalCatalog(wxCommandEvent &event) override;
  // XyGrib GUI callbacks
  void OnXyGribDownloadButton(wxCommandEvent &event) override;
  void OnXyGribAtmModelChoice(wxCommandEvent &event) override;
  void OnXyGribWaveModelChoice(wxCommandEvent &event) override;
  void OnXyGribConfigChange(wxCommandEvent &event) override;
  void OnDownloadLocal(wxCommandEvent &event) override;
  void OnCoordinatesChange(wxSpinEvent &event) override;
  void SaveConfig() override;
 
private:
  void HighlightArea(double latmax, double lonmax, double latmin,
                     double lonmin);
  void ReadLocalCatalog();
  void FillTreeCtrl(wxJSONValue &data);
  void ApplyRequestConfig(unsigned rs, unsigned it, unsigned tr);
  wxString WriteMail();
  int EstimateFileSize(double *size);
 
  template <typename T>
  static std::string FormatPerLocale(T value);
 
  static wxString GetDownloadProgressText(long bytesTransferred,
                                          long bytesTotal);
  void InitRequestConfig();
  void OnExit(wxCommandEvent &event) {
    wxCloseEvent evt;
    OnClose(evt);
  }
 
  void OnMouseEventTimer(wxTimerEvent &event);
  void SetCoordinatesText();
 
  void onDLEvent(OCPN_downloadEvent &ev);
  void EnableDownloadButtons();
 
  // Xygrib internal methods
  void InitializeXygribDialog();
  wxString BuildXyGribUrl();
  wxString BuildGribFileName();
 
  // Manage XyGrib UI Configuration
  void ApplyXyGribConfiguration();
  void MemorizeXyGribConfiguration();
  // Calculate estimated size of GRIB file
  void UpdateGribSizeEstimate();
 
  // Index of currently selected XyGrib atmospheric model
  int m_selectedAtmModelIndex;
  // Index of currently selected XyGrib wave model
  int m_selectedWaveModelIndex;
  // Last size estimation of the GRIB file
  int m_gribSizeEstimate;
 
  GRIBUICtrlBar &m_parent;
 
  wxDC *m_pdc;
  pi_ocpnDC *m_oDC;  // Used for selection overlay on GL
 
  wxTimer m_tMouseEventTimer;
  wxTimer m_tMouseClickTimer;
  wxMouseEvent m_SingleClickEvent;
 
  bool IsZYGRIB;
  bool IsGFS;
  int m_MailError_Nb;
  int m_SendMethod;
  bool m_AllowSend;
  bool m_IsMaxLong;
  double m_displayScale;
  bool m_connected;
  bool m_downloading;
  long m_download_handle;
  bool m_bTransferSuccess;
  bool m_canceled;
  bool m_bLocal_source_selected;
  GribDownloadType m_downloadType;
  int m_boundingBoxCanvasIndex;
};
 
#endif  //    GRIBREQUESTDIALOG_H_