res-reader.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_RES_READER_DEFINITIONS_H
#define WOSS_RES_READER_DEFINITIONS_H
 
 
#include <string>
#include <pressure-definitions.h>
#include <time-arrival-definitions.h>
#include <memory>
 
 
namespace woss {
 
  class Woss;
 
  class ResReader {
 
    public:
 
    ResReader( const Woss& woss );
 
    virtual ~ResReader() = default;
 
    virtual bool initialize() = 0;
 
    virtual std::unique_ptr<Pressure> readAvgPressure( double frequency, double tx_depth, double start_rx_depth, double start_rx_range, double end_rx_depth, double end_rx_range ) = 0;
 
    virtual std::unique_ptr<Pressure> readPressure( double frequency, double tx_depth, double rx_depth, double rx_range ) const = 0;
 
    virtual std::unique_ptr<TimeArr> readTimeArr(double frequency, double tx_depth, double rx_depth, double rx_range ) const = 0;
 
    const Woss& getWossRef() const { return woss_ref; }
 
    ResReader& setFileName( const std::string& name ) { file_name = name; return *this; }
 
    std::string getFileName() const { return file_name; }
 
    protected:
 
    const Woss& woss_ref;
 
    std::string file_name;
 
  };
 
}
 
#endif /* WOSS_RES_READER_DEFINITIONS_H */