woss-creator.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_CREATOR_DEFINITIONS_H
#define WOSS_CREATOR_DEFINITIONS_H
 
#include <string>
#include <memory>
#include "woss.h"
#include "woss-creator-container.h"
 
static constexpr inline double WOSS_CREATOR_MAX_FREQ_STEP = (1.0e20);
 
namespace woss {
 
  class WossDbManager;
  class TransducerHandler;
 
  class WossCreator {
 
    protected:
 
    using CCSimTime = WossCreatorContainer< SimTime >;
    using CCDouble = WossCreatorContainer< double >;
    using CCInt = WossCreatorContainer< int >;
 
    public:
 
    WossCreator();
 
    virtual ~WossCreator() = default;
 
    virtual std::unique_ptr<Woss> const createWoss( const CoordZ& tx, const CoordZ& rx, double start_freq, double end_freq ) const = 0;
   
    WossCreator& setWossDebug( bool flag ) { woss_debug = flag; return *this; }
 
    WossCreator& setDebug( bool flag ) { debug = flag; updateDebugFlag(); return *this; }
 
    bool usingDebug() const { return debug; }
 
    bool usingWossDebug() const { return woss_debug; }
 
    WossCreator& setWrkDirPath( const std::string& path ) { work_dir_path = path; return *this; }
 
     WossCreator& setCleanWorkDir( bool flag ) { woss_clean_workdir = flag; return *this; }
 
    std::string getWrkDirPath() const { return work_dir_path; }
 
    WossCreator& setFrequencyStep( double f_step, const CoordZ& tx, const CoordZ& rx ) { 
      if ( f_step <= 0.0 ) 
        f_step = WOSS_CREATOR_MAX_FREQ_STEP; 
      ccfrequency_step.replace(f_step, tx, rx);
      return *this; }
 
    WossCreator& setFrequencyStep( double f_step, const std::shared_ptr<Location>& tx = CCDouble::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCDouble::ALL_LOCATIONS ) { 
      if ( f_step <= 0.0 ) 
        f_step = WOSS_CREATOR_MAX_FREQ_STEP; 
      ccfrequency_step.replace(f_step, tx, rx);   
      return *this; }
 
    double getFrequencyStep( const CoordZ& tx, const CoordZ& rx ) const { 
      return ccfrequency_step.get(tx, rx); }
 
    double getFrequencyStep( const std::shared_ptr<Location>& tx = CCDouble::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCDouble::ALL_LOCATIONS ) const { 
      return ccfrequency_step.get(tx, rx); }    
 
    WossCreator& eraseFrequencyStep( const CoordZ& tx, const CoordZ& rx ) { 
      ccfrequency_step.erase(tx, rx); return *this; }
 
    WossCreator& eraseFrequencyStep( const std::shared_ptr<Location>& tx = CCDouble::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCDouble::ALL_LOCATIONS ) { 
      ccfrequency_step.erase(tx, rx); return *this; }
 
    WossCreator& setEvolutionTimeQuantum( double value, const CoordZ& tx, const CoordZ& rx ) { 
      ccevolution_time_quantum.replace( value, tx, rx ); return *this; } 
    
    WossCreator& setEvolutionTimeQuantum( double value, const std::shared_ptr<Location>& tx = CCInt::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCInt::ALL_LOCATIONS ) { 
      ccevolution_time_quantum.replace( value, tx, rx ); return *this; } 
 
    double getEvolutionTimeQuantum( const CoordZ& tx, const CoordZ& rx ) const { 
      return ccevolution_time_quantum.get(tx, rx); } 
    
    double getEvolutionTimeQuantum( const std::shared_ptr<Location>& tx = CCInt::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCInt::ALL_LOCATIONS ) const { 
      return ccevolution_time_quantum.get(tx, rx); } 
      
    WossCreator& eraseEvolutionTimeQuantum( const CoordZ& tx, const CoordZ& rx ) { 
      ccevolution_time_quantum.erase(tx, rx); return *this; } 
 
    WossCreator& eraseEvolutionTimeQuantum( const std::shared_ptr<Location>& tx = CCInt::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCInt::ALL_LOCATIONS ) { 
      ccevolution_time_quantum.erase(tx, rx); return *this; } 
 
    WossCreator& setTotalRuns( int runs, const CoordZ& tx, const CoordZ& rx ) {  
      cctotal_runs.replace( runs, tx, rx ); return *this; }
 
    WossCreator& setTotalRuns( int runs, const std::shared_ptr<Location>& tx = CCInt::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCInt::ALL_LOCATIONS ) {  
      cctotal_runs.replace( runs, tx, rx ); return *this; }
 
    int getTotalRuns( const CoordZ& tx, const CoordZ& rx ) const { 
      return cctotal_runs.get(tx, rx); }
    
    int getTotalRuns( const std::shared_ptr<Location>& tx = CCInt::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCInt::ALL_LOCATIONS ) const { 
      return cctotal_runs.get(tx, rx); }
 
    WossCreator& eraseTotalRuns( const CoordZ& tx, const CoordZ& rx ) {  
      cctotal_runs.erase( tx, rx ); return *this; }
 
    WossCreator& eraseTotalRuns( const std::shared_ptr<Location>& tx = CCInt::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCInt::ALL_LOCATIONS ) {  
      cctotal_runs.erase( tx, rx ); return *this; }
 
    WossCreator& setSimTime( const SimTime& simtime, const CoordZ& tx, const CoordZ& rx ) { 
      ccsimtime_map.replace(simtime, tx, rx); return *this; }
      
    WossCreator& setSimTime( const SimTime& simtime, const std::shared_ptr<Location>& tx = CCSimTime::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCSimTime::ALL_LOCATIONS ) { 
      ccsimtime_map.replace(simtime, tx, rx); return *this; }
 
    SimTime getSimTime( const CoordZ& tx, const CoordZ& rx ) const { 
      return ccsimtime_map.get(tx, rx); }
 
    SimTime getSimTime( const std::shared_ptr<Location>& tx = CCSimTime::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCSimTime::ALL_LOCATIONS ) const { 
      return ccsimtime_map.get(tx, rx); }
 
    WossCreator& eraseSimTime( const CoordZ& tx, const CoordZ& rx ) { ccsimtime_map.erase(tx, rx); return *this; }
 
    WossCreator& eraseSimTime( const std::shared_ptr<Location>& tx = CCSimTime::ALL_LOCATIONS, const std::shared_ptr<Location>& rx = CCSimTime::ALL_LOCATIONS ) { 
      ccsimtime_map.erase(tx, rx); return *this; }
 
    WossCreator& setWossDbManager( const std::shared_ptr<WossDbManager>& ptr ) { woss_db_manager = ptr; return *this; }
 
    WossCreator& setTransducerHandler( const std::shared_ptr<TransducerHandler>& ptr ) { transducer_handler = ptr; return *this; }
 
    protected:
 
    std::shared_ptr<WossDbManager> woss_db_manager;
    
    std::shared_ptr<TransducerHandler> transducer_handler;
 
    std::string work_dir_path;
 
    CCDouble ccevolution_time_quantum;
 
    CCInt cctotal_runs;
 
    CCDouble ccfrequency_step;
 
    CCSimTime ccsimtime_map;
 
    bool debug;
 
    bool woss_debug;
    
    bool woss_clean_workdir;
 
    virtual bool initializeWoss( Woss& woss_ref ) const = 0;
 
    virtual void updateDebugFlag();
 
  };
 
}
 
#endif /* WOSS_CREATOR_DEFINITIONS_H */