woss-db.h

Go to the documentation of this file.

/* WOSS - World Ocean Simulation System -
 * 
 * Copyright (C) 2009 2025 Federico Guerra
 * and regents of the SIGNET lab, University of Padova
 *
 * Author: Federico Guerra - WOSS@guerra-tlc.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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 WOSS_DB_H 
#define WOSS_DB_H
 
#include <fstream>
#include <memory>
#include <utility>
#include <string>
#if defined(WOSS_NETCDF4_SUPPORT)
#include <ncFile.h>
#elif defined(WOSS_NETCDF_SUPPORT)
#include <netcdfcpp.h>
#endif
#include <definitions.h>
#include <coordinates-definitions.h>
#include <pressure-definitions.h>
#include <sediment-definitions.h>
#include <ssp-definitions.h>
#include <time-arrival-definitions.h>
 
namespace woss {
    
  class Time;
  
  
  static constexpr inline const char* DB_NAME_NOT_SET = "DB_NAME_NOT_SET";

  using PathName = std::pair< std::string, std::string >; // path , filename
 

  class WossDb {
 
    
    public:
 
      
    WossDb( const std::string& name ); 
 
    virtual ~WossDb() = default;
 

    void setDbName( const std::string& pathname ) { db_name = pathname; }

    std::string getDbName() const { return db_name; }
 

    void setDebug( double flag = true ) { debug = flag; }
    
    bool isUsingDebug() const { return debug; }
 

    virtual bool isValid() const { return( db_name.length() > 0 ); }
 

    virtual bool openConnection() = 0;
 
    
    virtual bool finalizeConnection() = 0;
    

    virtual bool closeConnection() = 0;
 
    protected:
 
    std::string db_name;
 
    bool debug;

    PathName getPathName( const std::string& complete_path ) const;
 
  };

#ifdef WOSS_NETCDF_SUPPORT
  class WossNetcdfDb : public WossDb {
 
    public:

    WossNetcdfDb( const std::string& name );
 
    virtual ~WossNetcdfDb() override;

    virtual bool openConnection() override;

    virtual bool closeConnection() override;
 
    protected:

#if defined(WOSS_NETCDF4_SUPPORT)
    std::unique_ptr< netCDF::NcFile > netcdf_db = nullptr;
#else
    std::unique_ptr< NcFile> netcdf_db = nullptr;
#endif // defined(WOSS_NETCDF4_SUPPORT)
 
  };
#endif // WOSS_NETCDF_SUPPORT
  

  class WossTextualDb : public WossDb {
 
    public:

    WossTextualDb( const std::string& name );
 
    virtual ~WossTextualDb() override;

    virtual bool openConnection() override;

    virtual bool closeConnection() override;
 
    protected:

    std::fstream textual_db;
 
  };


  class WossBathymetryDb {
 
    public:
 
    WossBathymetryDb() = default;
 
    virtual ~WossBathymetryDb() = default;

    virtual bool insertValue( const Coord& coordinates, const Bathymetry& bathymetry_value ) = 0;

    virtual Bathymetry getValue( const Coord& coords ) const = 0; 
  };
 

  class WossSedimentDb {
 
    public:
 
    WossSedimentDb() = default;
 
    virtual ~WossSedimentDb() = default;

    virtual bool insertValue( const Coord& coordinates, const Sediment& sediment_value ) = 0;
    
    virtual std::unique_ptr<Sediment> getValue( const CoordZ& coords ) const = 0; 

    virtual std::unique_ptr<Sediment> getValue( const CoordZVector& coordz_vector ) const = 0; 
 
  };
 

  class WossSSPDb {
 
    public:
 
    WossSSPDb() = default;
 
    virtual ~WossSSPDb() = default;

    virtual bool insertValue( const Coord& coordinates, const Time& time_value, const SSP& ssp_value ) = 0;
      
    virtual std::unique_ptr<SSP> getValue( const Coord& coords, const Time& time, long double ssp_depth_precision ) const = 0;
 
  };
 

  class WossResTimeArrDb {
 
    public:
 
    WossResTimeArrDb() = default;
 
    virtual ~WossResTimeArrDb() = default;
  
    virtual std::unique_ptr<TimeArr> getValue( const CoordZ& coord_tx, const CoordZ& coord_rx, const double frequency, const Time& time_value ) const = 0;

    virtual bool insertValue( const CoordZ& coord_tx, const CoordZ& coord_rx, const double frequency, const Time& time_value, const TimeArr& channel ) = 0;
 
  };
 

  class WossResPressDb {
 
    public:
 
    WossResPressDb() = default;
 
    virtual ~WossResPressDb() = default;
  
    virtual std::unique_ptr<Pressure> getValue( const CoordZ& coord_tx, const CoordZ& coord_rx, const double frequency, const Time& time_value ) const = 0;

    virtual bool insertValue( const CoordZ& coord_tx, const CoordZ& coord_rx, const double frequency, const Time& time_value,  const Pressure& pressure ) = 0;
 
  };
 
}
 
#endif /* WOSS_DB_H */