chartcatalog.h

/******************************************************************************
 * $Id: chartcatalog.h,v 1.0 2011/02/26 01:54:37 nohal Exp $
 *
 * Project:  OpenCPN
 * Purpose:  Chart downloader Plugin
 * Author:   Pavel Kalian
 *
 ***************************************************************************
 *   Copyright (C) 2011 by Pavel Kalian   *
 *   $EMAIL$   *
 *                                                                         *
 *   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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************
 */
 
#ifndef _CHARTCATALOG_H_
#define _CHARTCATALOG_H_
 
#include "wx/wxprec.h"
 
#ifndef WX_PRECOMP
#include "wx/wx.h"
#endif  // precompiled headers
 
#include "pugixml.hpp"
#include <memory>
#include <vector>
 
// Forward declarations
class NoticeToMariners;
class Vertex;
class Panel;
class Chart;
class Location;
class RiverMiles;
class Area;
class ChartFile;
 
// Declarations
class ChartCatalog {
public:
  ChartCatalog();
  ~ChartCatalog();
  // public methods
  bool LoadFromFile(wxString path, bool headerOnly = false);
  bool LoadFromXml(pugi::xml_document *doc, bool headerOnly);
  wxDateTime GetReleaseDate(void);
  // public properties
  wxString title;
  wxDateTime date_created;
  wxDateTime time_created;
  wxDateTime date_valid;
  wxDateTime time_valid;
  wxDateTime dt_valid;
  wxString ref_spec;
  wxString ref_spec_vers;
  wxString s62AgencyCode;
  std::vector<std::unique_ptr<Chart>> charts;
 
private:
  bool ParseNoaaHeader(const pugi::xml_node &xmldata);
};
 
class Chart {
public:
  Chart(pugi::xml_node &xmldata);
  virtual ~Chart();
  // public methods
  virtual wxString GetChartTitle() { return title; }
  virtual wxString GetDownloadLocation() { return zipfile_location; }
  virtual bool NeedsManualDownload() {
    return manual_download_url != wxEmptyString;
  }
  virtual wxString GetManualDownloadUrl() { return manual_download_url; }
  virtual wxString GetChartFilename(bool to_check = false);
  virtual wxDateTime GetUpdateDatetime() { return zipfile_datetime_iso8601; }
 
  // public properties
  wxString number;  // chart number used for zip file name, BSB name, cell
                    // number  .Paul.
  wxString title;   // RNC: <title>, ENC:<lname>
  wxArrayString *coast_guard_districts;
  wxArrayString *states;
  wxArrayString *regions;
  wxString zipfile_location;
  wxString target_filename;
  wxDateTime zipfile_datetime;
  wxDateTime zipfile_datetime_iso8601;
  int zipfile_size;
  int edtn;
  int updn;
  wxDateTime uadt;
  wxDateTime isdt;
  wxString reference_file;
  wxString manual_download_url;
 
  NoticeToMariners *nm;
  NoticeToMariners *lnm;
  std::vector<std::unique_ptr<Panel>> coverage;
};
 
class RasterChart : public Chart  //<chart>
{
public:
  RasterChart(pugi::xml_node &xmldata);
  // public methods
 
  // public properties
  int source_edition;
  int raster_edition;
  int ntm_edition;
  wxString source_date;
  wxString ntm_date;
  wxString source_edition_last_correction;
  wxString raster_edition_last_correction;
  wxString ntm_edition_last_correction;
};
 
class EncCell : public Chart  //<cell>
{
public:
  EncCell(pugi::xml_node &xmldata);
  // public methods
 
  // public properties
  // wxString name;  use wxString number in class Chart .Paul.
  wxString src_chart;
  int cscale;
  wxString status;
  int edtn;
  int updn;
  wxDateTime uadt;
  wxDateTime isdt;
};
 
class IEncCell : public Chart  //<Cell>
{
public:
  IEncCell(pugi::xml_node &xmldata);
  ~IEncCell();
  // public methods
  wxString GetChartTitle();
  wxString GetDownloadLocation();
  wxDateTime GetUpdateDatetime();
 
  // public properties
  // wxString name;  use wxString number in class Chart .Paul.
  Location *location;
  wxString river_name;
  RiverMiles *river_miles;
  Area *area;
  wxString edition;
  ChartFile *shp_file;
  ChartFile *s57_file;
  ChartFile *kml_file;
};
 
class ChartFile {
public:
  ChartFile(pugi::xml_node &xmldata);
  // public methods
 
  // public properties
  wxString location;
  wxDateTime date_posted;
  wxDateTime time_posted;
  int file_size;
};
 
class Location {
public:
  Location(pugi::xml_node &xmldata);
  // public methods
 
  // public properties
  wxString from;
  wxString to;
};
 
class RiverMiles {
public:
  RiverMiles(pugi::xml_node &xmldata);
  // public methods
 
  // public properties
  double begin;
  double end;
};
 
class Area {
public:
  Area(pugi::xml_node &xmldata);
  // public methods
 
  // public properties
  double north;
  double south;
  double east;
  double west;
};
 
class NoticeToMariners  // for <nm> and <lnm>
{
public:
  NoticeToMariners(pugi::xml_node &xmldata);
  // public methods
 
  // public properties
  wxString agency;  //<nm_agency> or <lnm_agency>
  wxString doc;
  wxDateTime date;
};
 
class Vertex {
public:
  Vertex(pugi::xml_node &xmldata);
  virtual ~Vertex() {};
  // public methods
 
  // public properties
  double lat;
  double lon;
};
 
class Panel {
public:
  Panel(pugi::xml_node &xmldata);
  virtual ~Panel();
  // public methods
 
  // public properties
  int panel_no;
  std::vector<Vertex> vertexes;
};
 
class RncPanel : public Panel {
public:
  RncPanel(pugi::xml_node &xmldata);
  // public methods
 
  // public properties
  wxString panel_title;
  wxString file_name;
  int scale;
};
 
class EncPanel : public Panel {
public:
  EncPanel(pugi::xml_node &xmldata);
  // public methods
 
  // public properties
  wxString type;
};
 
#endif  //_CHARTCATALOG_H_