woss-db-manager.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_MANAGER_IMPLEMENT_H 
#define WOSS_DB_MANAGER_IMPLEMENT_H
 
 
#include <memory>
#include <string>
#include <definitions.h>
#include <definitions-handler.h>
#include "woss-db-custom-data-container.h"
#include "woss-db.h"
 
 
namespace woss {
 
  class WossDbManager {
 
                
    protected:
   
    
    class BearingOperator {
 
      public:
 
      double operator()( const Coord& x, const Coord& y ) const {
        return( x.getInitialBearing(y) );
      }
      
    };
    
 
    class RangeOperator {
 
      public:
 
      double operator()( const Coord& x, const Coord& y ) const {
        return( x.getGreatCircleDistance(y) );
      }
 
    };
 
    public:
 
    using CCBathymetry = CustomDataContainer< Coord, BearingOperator, RangeOperator, Bathymetry >;
 
    using CCSSP = CustomDataTimeContainer< Coord, BearingOperator, RangeOperator, std::shared_ptr<SSP> >;
 
    using CCSediment = CustomDataContainer< Coord, BearingOperator, RangeOperator, std::shared_ptr<Sediment> >;
 
    using CCAltimetry = CustomDataContainer< Coord, BearingOperator, RangeOperator, std::shared_ptr<Altimetry> >;
 
    WossDbManager();
 
    WossDbManager( const WossDbManager& instance ) = default;
 
    WossDbManager( WossDbManager&& instance ) = default;
 
    WossDbManager& operator=( const WossDbManager& instance ) = default;
 
    WossDbManager& operator=( WossDbManager&& instance ) = default;
 
    virtual ~WossDbManager() = default;
 
    virtual std::unique_ptr<Altimetry> getAltimetry( const CoordZ& tx, const CoordZ& rx ) const;
    
    
    virtual std::unique_ptr<Sediment> getSediment( const CoordZ& tx, const CoordZ& rx ) const;
 
    virtual std::unique_ptr<Sediment> getSediment( const CoordZ& tx, const CoordZVector& rx_coordz_vector ) const;
 
 
    virtual Bathymetry getBathymetry( const Coord& tx, const Coord& rx ) const;
 
    virtual void getBathymetry( const Coord& tx, CoordZVector& rx_coordz_vector ) const;
 
 
    virtual std::unique_ptr<SSP> getSSP( const Coord& tx, const Coord& rx, const Time& time, long double ssp_depth_precision = SSP_CUSTOM_DEPTH_PRECISION ) const;
 
    virtual std::unique_ptr<SSP> getAverageSSP( const Coord& tx, const Coord& rx, const Time& time_start, const Time& time_end, int max_time_values, long double ssp_depth_precision = SSP_CUSTOM_DEPTH_PRECISION ) const;
 
 
    virtual std::unique_ptr<TimeArr> getTimeArr( const CoordZ& coord_tx, const CoordZ& coord_rx, const double frequency, const Time& time_value ) const;
 
    virtual void insertTimeArr( const CoordZ& coord_tx, const CoordZ& coord_rx, const double frequency, const Time& time_value, const TimeArr& channel ) const;
 
 
    virtual std::unique_ptr<Pressure> getPressure( const CoordZ& coord_tx, const CoordZ& coord_rx, const double frequency, const Time& time_value ) const;
 
    virtual void insertPressure( const CoordZ& coord_tx, const CoordZ& coord_rx, const double frequency, const Time& time_value, const Pressure& pressure ) const;
 
    
    WossDbManager& setBathymetryDb( std::unique_ptr<WossBathymetryDb> ptr ) { bathymetry_db = std::move(ptr); return *this; }
 
    WossDbManager& setSedimentDb( std::unique_ptr<WossSedimentDb> ptr ) { sediment_db = std::move(ptr); return *this; }
 
    WossDbManager& setSSPDb( std::unique_ptr<WossSSPDb> ptr ) { ssp_db = std::move(ptr); return *this; }
 
    WossDbManager& setResTimeArrDb( std::unique_ptr<WossResTimeArrDb> ptr ) { results_arrivals_db = std::move(ptr); return *this; }
  
    WossDbManager& setResPressureDb( std::unique_ptr<WossResPressDb> ptr ) { results_pressure_db = std::move(ptr); return *this; }
 
    bool setCustomAltimetry( const Altimetry& altimetry, const Coord& tx_coord = CCAltimetry::DB_CDATA_ALL_OUTER_KEYS, 
                            double bearing = CCAltimetry::DB_CDATA_ALL_MEDIUM_KEYS, 
                            double range = CCAltimetry::DB_CDATA_ALL_INNER_KEYS );
      
    std::unique_ptr<Altimetry> getCustomAltimetry( const Coord& tx_coord = CCAltimetry::DB_CDATA_ALL_OUTER_KEYS, 
                                 double bearing = CCAltimetry::DB_CDATA_ALL_MEDIUM_KEYS, 
                                 double range = CCAltimetry::DB_CDATA_ALL_INNER_KEYS ) const;
    
    WossDbManager& eraseCustomAltimetry( const Coord& tx_coord = CCAltimetry::DB_CDATA_ALL_OUTER_KEYS, 
                                         double bearing = CCAltimetry::DB_CDATA_ALL_MEDIUM_KEYS, 
                                         double range = CCAltimetry::DB_CDATA_ALL_INNER_KEYS );
    
    
    bool setCustomSediment( const Sediment& sediment, const Coord& tx_coord = CCSediment::DB_CDATA_ALL_OUTER_KEYS, 
                            double bearing = CCSediment::DB_CDATA_ALL_MEDIUM_KEYS, 
                            double range = CCSediment::DB_CDATA_ALL_INNER_KEYS );
 
    bool setCustomSediment( const std::string& sediment_string, 
                            const Coord& txCoord = CCSediment::DB_CDATA_ALL_OUTER_KEYS,
                            double bearing = CCSediment::DB_CDATA_ALL_MEDIUM_KEYS,
                            double range = CCSediment::DB_CDATA_ALL_INNER_KEYS );
 
    std::unique_ptr<Sediment> getCustomSediment( const Coord& tx_coord = CCSediment::DB_CDATA_ALL_OUTER_KEYS, 
                                 double bearing = CCSediment::DB_CDATA_ALL_MEDIUM_KEYS, 
                                 double range = CCSediment::DB_CDATA_ALL_INNER_KEYS ) const;
 
    WossDbManager& eraseCustomSediment( const Coord& tx_coord = CCSediment::DB_CDATA_ALL_OUTER_KEYS, 
                                        double bearing = CCSediment::DB_CDATA_ALL_MEDIUM_KEYS, 
                                        double range = CCSediment::DB_CDATA_ALL_INNER_KEYS );
    
    
    bool setCustomSSP( const SSP& ssp, const Coord& tx_coord = CCSSP::DB_CDATA_ALL_OUTER_KEYS, 
                                       double bearing = CCSSP::DB_CDATA_ALL_MEDIUM_KEYS, 
                                       double range = CCSSP::DB_CDATA_ALL_INNER_KEYS,
                                       const Time& time_value = CCSSP::DB_CDATA_ALL_TIME_KEYS );
 
    bool setCustomSSP( const std::string& sspString, const Coord& txCoord = CCSSP::DB_CDATA_ALL_OUTER_KEYS,
                        double bearing = CCSSP::DB_CDATA_ALL_MEDIUM_KEYS,
                        double range = CCSSP::DB_CDATA_ALL_INNER_KEYS,
                        const Time& time_value = CCSSP::DB_CDATA_ALL_TIME_KEYS );
 
    virtual bool importCustomSSP( const std::string& filename, const Time& = CCSSP::DB_CDATA_ALL_TIME_KEYS,
                                        const Coord& tx_coord = CCSSP::DB_CDATA_ALL_OUTER_KEYS, double bearing = CCSSP::DB_CDATA_ALL_MEDIUM_KEYS );
 
    std::unique_ptr<SSP> getCustomSSP( const Coord& tx_coord = CCSSP::DB_CDATA_ALL_OUTER_KEYS, 
                                      double bearing = CCSSP::DB_CDATA_ALL_MEDIUM_KEYS, 
                                      double range = CCSSP::DB_CDATA_ALL_INNER_KEYS,
                                      const Time& time_value = CCSSP::DB_CDATA_ALL_TIME_KEYS ) const;
 
    WossDbManager& eraseCustomSSP( const Coord& tx_coord = CCSSP::DB_CDATA_ALL_OUTER_KEYS, 
                                   double bearing = CCSSP::DB_CDATA_ALL_MEDIUM_KEYS, 
                                   double range = CCSSP::DB_CDATA_ALL_INNER_KEYS,
                                   const Time& time_value = CCSSP::DB_CDATA_ALL_TIME_KEYS );
                                     
    bool setCustomBathymetry( const Bathymetry& bathymetry, const Coord& tx_coord = CCBathymetry::DB_CDATA_ALL_OUTER_KEYS, 
                                   double bearing = CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS, 
                                   double range = CCBathymetry::DB_CDATA_ALL_INNER_KEYS );
 
    bool setCustomBathymetry (const std::string &bathyLine, const Coord& tx_coord = CCBathymetry::DB_CDATA_ALL_OUTER_KEYS, 
                              double bearing = CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS);
 
    virtual bool importCustomBathymetry( const std::string& filename, const Coord& tx_coord = CCBathymetry::DB_CDATA_ALL_OUTER_KEYS, 
                                         double bearing = CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS );
   
    Bathymetry getCustomBathymetry( const Coord& tx_coord = CCBathymetry::DB_CDATA_ALL_OUTER_KEYS, 
                                     double bearing = CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS, 
                                     double range = CCBathymetry::DB_CDATA_ALL_INNER_KEYS ) const;
 
    WossDbManager& eraseCustomBathymetry( const Coord& tx_coord = CCBathymetry::DB_CDATA_ALL_OUTER_KEYS, 
                                          double bearing = CCBathymetry::DB_CDATA_ALL_MEDIUM_KEYS, 
                                          double range = CCBathymetry::DB_CDATA_ALL_INNER_KEYS );
    
 
    WossDbManager& setDebug( bool flag ) { debug = flag; updateDebugFlag(); return *this; }
 
    bool getDebug() const { return debug; }
 
    protected:
 
    std::unique_ptr<WossBathymetryDb> bathymetry_db;
 
    std::unique_ptr<WossSedimentDb> sediment_db;
 
    std::unique_ptr<WossSSPDb> ssp_db;
 
    std::unique_ptr<WossResTimeArrDb> results_arrivals_db;
  
    std::unique_ptr<WossResPressDb> results_pressure_db;
 
    bool debug;
 
    CCBathymetry ccbathy_map;
    
    CCSediment ccsediment_map;
    
    CCSSP ccssp_map;
 
    CCAltimetry ccaltimetry_map;
    
 
    virtual bool closeAllConnections();
 
    virtual void updateDebugFlag();
    
  };
 
  
  //inline functions
  inline bool WossDbManager::setCustomAltimetry( const Altimetry& altimetry, const Coord& tx_coord, double bearing, double range ) {
    return ccaltimetry_map.insert( altimetry.clone(), tx_coord, bearing, range );
  }
 
 
  inline std::unique_ptr<Altimetry> WossDbManager::getCustomAltimetry( const Coord& tx_coord, double bearing, double range ) const {
    auto ret = ccaltimetry_map.get( tx_coord, bearing, range );
    if (ret)
      return (*ret)->clone();
    else
      return( SDefHandler::instance().createAltimetry( Altimetry::createNotValid() ) );
  }
 
 
  inline WossDbManager& WossDbManager::eraseCustomAltimetry( const Coord& tx_coord, double bearing, double range ) {
    ccaltimetry_map.erase( tx_coord, bearing, range );
    return *this;
  }
 
 
  inline bool WossDbManager::setCustomSediment( const Sediment& sediment, const Coord& tx_coord, double bearing, double range ) {
    return ccsediment_map.insert( sediment.clone(), tx_coord, bearing, range );
  }
 
 
  inline std::unique_ptr<Sediment> WossDbManager::getCustomSediment( const Coord& tx_coord, double bearing, double range ) const {
    auto ret = ccsediment_map.get( tx_coord, bearing, range );
    if (ret)
      return (*ret)->clone();
    else
      return( SDefHandler::instance().createSediment() );
  }
 
 
  inline WossDbManager& WossDbManager::eraseCustomSediment( const Coord& tx_coord, double bearing, double range ) {
    ccsediment_map.erase( tx_coord, bearing, range );
    return *this;
  }
 
 
  inline bool WossDbManager::setCustomSSP( const SSP& ssp, const Coord& tx_coord, double bearing, double range, const Time& time_key ) {
    return ccssp_map.insert( ssp.clone(), tx_coord, bearing, range, time_key );
  }
      
      
  inline std::unique_ptr<SSP> WossDbManager::getCustomSSP( const Coord& tx_coord, double bearing, double range, const Time& time_key ) const {
    auto ret = ccssp_map.get( tx_coord, bearing, range, time_key);
    if (ret)
      return (*ret)->clone();
    else
      return( SDefHandler::instance().createSSP() );
  }
 
 
  inline WossDbManager& WossDbManager::eraseCustomSSP( const Coord& tx_coord, double bearing, double range, const Time& time_key ) {
    ccssp_map.erase( tx_coord, bearing, range, time_key );
    return *this;
  }
 
 
  inline bool WossDbManager::setCustomBathymetry( const Bathymetry& bathy, const Coord& tx_coord, double bearing, double range ) {
    return ccbathy_map.insert(bathy, tx_coord, bearing, range );
  }
      
      
  inline Bathymetry WossDbManager::getCustomBathymetry( const Coord& tx_coord, double bearing, double range ) const {
    auto ret = ccbathy_map.get( tx_coord, bearing, range);
    if (ret)
      return (*ret);
    else
      return( Bathymetry() );
  }
 
 
  inline WossDbManager& WossDbManager::eraseCustomBathymetry( const Coord& tx_coord, double bearing, double range ) {
    ccbathy_map.erase( tx_coord, bearing, range );
    return *this;
  }
 
}
 
#endif /* WOSS_DB_MANAGER_IMPLEMENT_H */