RingDetector.h revision 10448
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_OPTICAL_RINGDETECTOR_H__ 23#define __DSENT_MODEL_OPTICAL_RINGDETECTOR_H__ 24 25#include "util/CommonType.h" 26#include "model/OpticalModel.h" 27#include "model/optical_graph/OpticalReceiver.h" 28 29namespace DSENT 30{ 31 class RingDetector : public OpticalModel, public OpticalReceiver 32 { 33 public: 34 // Receiver topolgy strings 35 static const String INTEGRATINGSENSEAMP; 36 37 public: 38 RingDetector(const String& instance_name_, const TechModel* tech_model_); 39 virtual ~RingDetector(); 40 41 public: 42 // Set a list of properties' name needed to construct model 43 void initParameters(); 44 // Set a list of properties' name needed to construct model 45 void initProperties(); 46 // Returns the sensitivity of the receiver given an extinction ratio 47 double getSensitivity(double ER_dB_) const; 48 49 private: 50 // Precompute values based on tech parameters 51 void precomputeTech(); 52 // Design the receiver helper function 53 void designReceiver(); 54 // Calculates inverse normal cdf 55 double calcInvNormCdf(double num_); 56 57 protected: 58 // Build the model 59 virtual void constructModel(); 60 virtual void updateModel(); 61 virtual void useModel(); 62 virtual void propagateTransitionInfo(); 63 64 private: 65 // Precomputed numbers 66 double m_quad_a_; 67 double m_quad_b1_; 68 double m_quad_b2_; 69 double m_quad_c_; 70 71 }; // class RingDetector 72} // namespace DSENT 73 74#endif // __DSENT_MODEL_OPTICAL_RINGDETECTOR_H__ 75 76