uwgainfromdb.h

Go to the documentation of this file.

//
// Copyright (c) 2017 Regents of the SIGNET lab, University of Padova.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
// 3. Neither the name of the University of Padova (SIGNET lab) nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
 
#ifndef UWGAINFROMDB_H
#define UWGAINFROMDB_H
 
#include <uwphysical.h>
 
#include <packet.h>
#include <module.h>
#include <tclcl.h>
 
#include <fstream>
#include <sstream>
 
class UnderwaterGainFromDb : public UnderwaterPhysical
{
 
public:
    UnderwaterGainFromDb();
 
    virtual ~UnderwaterGainFromDb()
    {
    }
 
    virtual int command(int, const char *const *);
 
protected:
    virtual double getPER(double snr, int nbits, Packet *p);
 
    virtual void setTimeRoughness(const int &);
 
    virtual void setDepthRoughness(const int &);
 
    virtual void setDistanceRoughness(const int &);
 
    virtual void setTotalTime(const int &);
 
    virtual void setFrequencyCorrectionFactor(const double &);
 
    inline const int &
    getTimeRoughness() const
    {
        return time_roughness_;
    }
 
    inline const int &
    getDepthRoughness() const
    {
        return depth_roughness_;
    }
 
    inline const int &
    getDistanceRoughness() const
    {
        return distance_roughness_;
    }
 
    inline const int &
    getTotalTime() const
    {
        return total_time_;
    }
 
    inline const double &
    getFrequencyCorrectionFactor() const
    {
        return frequency_correction_factor_;
    }
 
    virtual double getGain(
            const double &, const double &, const double &, const double &);
 
    virtual double retriveGainFromFile(
            const string &, const int &, const int &) const;
 
    virtual string createNameFile(const int &, const int &);
 
    inline const bool
    isZero(const double &value) const
    {
        return std::fabs(value) < std::numeric_limits<double>::epsilon();
    }
 
    char *path_; 
    char token_separator_; 
    ostringstream osstream_; 
private:
    // Variables
    int time_roughness_; 
    int depth_roughness_; 
    int distance_roughness_; 
    int total_time_; 
    double frequency_correction_factor_; 
};
 
#endif /* UWGAINFROMDB_H  */