uwoptical-phy.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 UWOPTICAL_PHY_H
#define UWOPTICAL_PHY_H
 
#include <bpsk.h>
 
#include <module.h>
#include <packet.h>
#include <rng.h>
#include <tclcl.h>
 
#include <climits>
#include <cmath>
#include <fstream>
#include <iostream>
#include <limits>
#include <map>
#include <math.h>
#include <node-core.h>
#include <sstream>
#include <string.h>
#include <vector>
 
#define OPTICAL_MODULATION_TYPE "OPTIC_BPSK"
#define NOT_FOUND_VALUE 0
#define IL_ILLEGAL -1
 
typedef ::std::map<double, double> DepthMap;
typedef DepthMap::iterator DMIt;
 
class UwOpticalPhy : public MPhy_Bpsk
{
 
public:
    UwOpticalPhy();
 
    virtual ~UwOpticalPhy()
    {
    }
 
    virtual int command(int, const char *const *);
 
    virtual void startRx(Packet *p);
 
    virtual double getSNRdB(Packet *p);
 
    virtual void endRx(Packet *p);
 
    virtual double getNoisePower(Packet *p);
 
protected:
    virtual double lookUpLightNoiseE(double depth);
 
    virtual double linearInterpolator(
            double x, double x1, double y1, double x2, double y2);
 
    virtual void initializeLUT();
 
    double getVarTemperature(Packet *p);
    bool use_woss_; 
    // Variables
private:
    // Variables
    double Id; // dark current
    double Il; // light current it can be approximated to the short circuit
               // current
    double R; // shunt resistance
    double S; // sensitivity
    double T; // temperature (K)
    double Ar_; // receiver area [m^2]
    string lut_file_name_; // LUT file name
    char lut_token_separator_; //
    DepthMap
            lut_map; 
    bool variable_temperature_; 
};
 
#endif /* UWOPTICAL_H  */