ext/dsent/model/optical_graph/OpticalModulator.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_OPTICALMODULATOR_H__
  23 #define __DSENT_MODEL_OPTICALGRAPH_OPTICALMODULATOR_H__
  24
  25 #include "model/optical_graph/OpticalNode.h"
  26 #include "util/CommonType.h"
  27
  28 namespace DSENT
  29 {
  30     class OpticalTransmitter;
  31
  32     class OpticalModulator : public OpticalNode
  33     {
  34         public:
  35             OpticalModulator(const String& instance_name_, OpticalModel* model_, const WavelengthGroup& wavelengths_, bool opt_loss_, OpticalTransmitter* transmitter_);
  36             ~OpticalModulator();
  37
  38         public:
  39             // Set losses
  40             void setLosses(double IL_dB_, double ER_dB_);
  41             // Tell the modulator to set a new insertion loss and extinction ratio
  42             bool setModulatorSpec(double IL_dB_, double ER_dB_);
  43             // Get modulator insertion loss
  44             double getInsertionLoss() const;
  45             // Get modulator extinction ratio
  46             double getExtinctionRatio() const;
  47             // Ask whether the model is able to optimize for insertion loss
  48             // and extinction ratios
  49             bool canOptimizeLoss() const;
  50             // Ask the modulator for its power at a given utilization
  51             double getPower(double util_) const;
  52
  53         private:
  54             // Disable copy constructor
  55             OpticalModulator(const OpticalModulator& node_);
  56
  57         private:
  58             // Optical sender of the modulator
  59             OpticalTransmitter* m_transmitter_;
  60             // Insertion loss of the modulator
  61             double m_insertion_loss_;
  62             // Extinction ratio of the modulator
  63             double m_extinction_ratio_;
  64             // Whether the modulator can be optimized
  65             bool m_opt_loss_;
  66
  67     };
  68
  69 } // namespace DSENT
  70
  71 #endif // __DSENT_MODEL_OPTICALGRAPH_OPTICALMODULATOR_H__
  72