ext/dsent/model/optical_graph/OpticalReceiver.h

   1 /* Copyright (c) 2012 Massachusetts Institute of Technology
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to deal
   5  * in the Software without restriction, including without limitation the rights
   6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   7  * copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19  * THE SOFTWARE.
  20  */
  21
  22 #ifndef __DSENT_MODEL_OPTICALGRAPH_OPTICALRECEIVER_H__
  23 #define __DSENT_MODEL_OPTICALGRAPH_OPTICALRECEIVER_H__
  24
  25 #include "model/OpticalModel.h"
  26 #include "util/CommonType.h"
  27
  28 namespace DSENT
  29 {
  30     // The job of an optical receiver interface is to provide a function to
  31     // return a sensitivity (in Amps)
  32     class OpticalReceiver
  33     {
  34         public:
  35             OpticalReceiver(){};
  36             virtual ~OpticalReceiver(){};
  37
  38         public:
  39             // Returns the sensitivity of the receiver given an extinction ratio
  40             virtual double getSensitivity(double ER_dB_) const = 0;
  41     };
  42
  43 } // namespace DSENT
  44
  45 #endif // __DSENT_MODEL_OPTICALGRAPH_OPTICALRECEIVER_H__
  46