110448Snilay@cs.wisc.edu/* Copyright (c) 2012 Massachusetts Institute of Technology 210448Snilay@cs.wisc.edu * 310448Snilay@cs.wisc.edu * Permission is hereby granted, free of charge, to any person obtaining a copy 410448Snilay@cs.wisc.edu * of this software and associated documentation files (the "Software"), to deal 510448Snilay@cs.wisc.edu * in the Software without restriction, including without limitation the rights 610448Snilay@cs.wisc.edu * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 710448Snilay@cs.wisc.edu * copies of the Software, and to permit persons to whom the Software is 810448Snilay@cs.wisc.edu * furnished to do so, subject to the following conditions: 910448Snilay@cs.wisc.edu * 1010448Snilay@cs.wisc.edu * The above copyright notice and this permission notice shall be included in 1110448Snilay@cs.wisc.edu * all copies or substantial portions of the Software. 1210448Snilay@cs.wisc.edu * 1310448Snilay@cs.wisc.edu * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 1410448Snilay@cs.wisc.edu * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 1510448Snilay@cs.wisc.edu * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 1610448Snilay@cs.wisc.edu * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 1710448Snilay@cs.wisc.edu * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 1810448Snilay@cs.wisc.edu * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 1910448Snilay@cs.wisc.edu * THE SOFTWARE. 2010448Snilay@cs.wisc.edu */ 2110448Snilay@cs.wisc.edu 2210447Snilay@cs.wisc.edu#ifndef __DSENT_MODEL_OPTICALMODEL_H__ 2310447Snilay@cs.wisc.edu#define __DSENT_MODEL_OPTICALMODEL_H__ 2410447Snilay@cs.wisc.edu 2510447Snilay@cs.wisc.edu#include "util/CommonType.h" 2610447Snilay@cs.wisc.edu#include "model/ElectricalModel.h" 2710447Snilay@cs.wisc.edu 2810447Snilay@cs.wisc.edunamespace DSENT 2910447Snilay@cs.wisc.edu{ 3010447Snilay@cs.wisc.edu class PortInfo; 3110447Snilay@cs.wisc.edu class EventInfo; 3210447Snilay@cs.wisc.edu class OpticalWaveguide; 3310447Snilay@cs.wisc.edu class OpticalLaser; 3410447Snilay@cs.wisc.edu class OpticalFilter; 3510447Snilay@cs.wisc.edu class OpticalModulator; 3610447Snilay@cs.wisc.edu class OpticalDetector; 3710447Snilay@cs.wisc.edu class OpticalReceiver; 3810447Snilay@cs.wisc.edu class OpticalTransmitter; 3910447Snilay@cs.wisc.edu 4010447Snilay@cs.wisc.edu // A Wavelength group consisting of start and end wavelength indices 4110447Snilay@cs.wisc.edu // Assuming it is the same as a net index so I can use the PortInfo class 4210447Snilay@cs.wisc.edu typedef NetIndex WavelengthGroup; 4310447Snilay@cs.wisc.edu 4410447Snilay@cs.wisc.edu // Helper function for making waveguide groups 4510447Snilay@cs.wisc.edu inline WavelengthGroup makeWavelengthGroup(int start_index_, int end_index_) 4610447Snilay@cs.wisc.edu { 4710447Snilay@cs.wisc.edu ASSERT(end_index_ >= start_index_, (String) "[Error] Invalid wavelength group range " + 4810447Snilay@cs.wisc.edu "[" + (String) start_index_ + ":" + (String) end_index_ + "]"); 4910447Snilay@cs.wisc.edu 5010447Snilay@cs.wisc.edu return WavelengthGroup(start_index_, end_index_); 5110447Snilay@cs.wisc.edu } 5210447Snilay@cs.wisc.edu 5310447Snilay@cs.wisc.edu // Helper function for making wavelength groups 5410447Snilay@cs.wisc.edu inline WavelengthGroup makeWavelengthGroup(int index_) 5510447Snilay@cs.wisc.edu { 5610447Snilay@cs.wisc.edu return makeWavelengthGroup(index_, index_); 5710447Snilay@cs.wisc.edu } 5810447Snilay@cs.wisc.edu 5910447Snilay@cs.wisc.edu // OpticalModel specifies optical connectivity to other optical models as well 6010447Snilay@cs.wisc.edu class OpticalModel : public ElectricalModel 6110447Snilay@cs.wisc.edu { 6210447Snilay@cs.wisc.edu 6310447Snilay@cs.wisc.edu public: 6410447Snilay@cs.wisc.edu OpticalModel(const String& instance_name_, const TechModel* tech_model_); 6510447Snilay@cs.wisc.edu virtual ~OpticalModel(); 6610447Snilay@cs.wisc.edu 6710447Snilay@cs.wisc.edu public: 6810447Snilay@cs.wisc.edu //----------------------------------------------------------------- 6910447Snilay@cs.wisc.edu // Connectivity specification 7010447Snilay@cs.wisc.edu //----------------------------------------------------------------- 7110447Snilay@cs.wisc.edu 7210447Snilay@cs.wisc.edu /* 7310447Snilay@cs.wisc.edu 7410447Snilay@cs.wisc.edu // Waveguide multiplier 7510447Snilay@cs.wisc.edu void setWaveguideMultiplier(unsigned int waveguide_multiplier_); 7610447Snilay@cs.wisc.edu unsigned int getWaveguideMultiplier(); 7710447Snilay@cs.wisc.edu 7810447Snilay@cs.wisc.edu */ 7910447Snilay@cs.wisc.edu // Input Ports 8010447Snilay@cs.wisc.edu void createOpticalInputPort(const String& name_, const WavelengthGroup& wavelengths_); 8110447Snilay@cs.wisc.edu const Map<PortInfo*>* getOpticalInputs() const; 8210447Snilay@cs.wisc.edu PortInfo* getOpticalInputPort(const String& name_); 8310447Snilay@cs.wisc.edu const PortInfo* getOpticalInputPort(const String& name_) const; 8410447Snilay@cs.wisc.edu 8510447Snilay@cs.wisc.edu // Output Ports 8610447Snilay@cs.wisc.edu void createOpticalOutputPort(const String& name_, const WavelengthGroup& wavelengths_); 8710447Snilay@cs.wisc.edu const Map<PortInfo*>* getOpticalOutputs() const; 8810447Snilay@cs.wisc.edu PortInfo* getOpticalOutputPort(const String& name_); 8910447Snilay@cs.wisc.edu const PortInfo* getOpticalOutputPort(const String& name_) const; 9010447Snilay@cs.wisc.edu 9110447Snilay@cs.wisc.edu // Optical Waveguides 9210447Snilay@cs.wisc.edu void createWaveguide(const String& name_, const WavelengthGroup& wavelengths_); 9310447Snilay@cs.wisc.edu const Map<OpticalWaveguide*>* getWaveguides() const; 9410447Snilay@cs.wisc.edu OpticalWaveguide* getWaveguide(const String& name_); 9510447Snilay@cs.wisc.edu 9610447Snilay@cs.wisc.edu // Assign a waveguide to be downstream from another waveguide 9710447Snilay@cs.wisc.edu void opticalAssign(const String& downstream_waveguide_name_, const String& upstream_waveguide_name_); 9810447Snilay@cs.wisc.edu 9910447Snilay@cs.wisc.edu // Connect a port (input or output) to some waveguide 10010447Snilay@cs.wisc.edu void opticalPortConnect(OpticalModel* connect_model_, const String& connect_port_name_, const String& connect_waveguide_name_); 10110447Snilay@cs.wisc.edu //----------------------------------------------------------------- 10210447Snilay@cs.wisc.edu 10310447Snilay@cs.wisc.edu //----------------------------------------------------------------- 10410447Snilay@cs.wisc.edu // Optical Graph Model Components 10510447Snilay@cs.wisc.edu //----------------------------------------------------------------- 10610447Snilay@cs.wisc.edu // Optical Laser Sources 10710447Snilay@cs.wisc.edu 10810447Snilay@cs.wisc.edu void createLaser(const String& name_, const WavelengthGroup& wavelengths_); 10910447Snilay@cs.wisc.edu const Map<OpticalLaser*>* getLasers() const; 11010447Snilay@cs.wisc.edu OpticalLaser* getLaser(const String& name_); 11110447Snilay@cs.wisc.edu // Optical Laser Sources 11210447Snilay@cs.wisc.edu void createFilter(const String& name_, const WavelengthGroup& wavelengths_, bool drop_all_, const WavelengthGroup& drop_wavelengths_); 11310447Snilay@cs.wisc.edu const Map<OpticalFilter*>* getFilters() const; 11410447Snilay@cs.wisc.edu OpticalFilter* getFilter(const String& name_); 11510447Snilay@cs.wisc.edu // Optical Modulators 11610447Snilay@cs.wisc.edu void createModulator(const String& name_, const WavelengthGroup& wavelengths_, bool opt_loss_, OpticalTransmitter* transmitter_); 11710447Snilay@cs.wisc.edu const Map<OpticalModulator*>* getModulators() const; 11810447Snilay@cs.wisc.edu OpticalModulator* getModulator(const String& name_); 11910447Snilay@cs.wisc.edu // Optical Detectors 12010447Snilay@cs.wisc.edu void createDetector(const String& name_, const WavelengthGroup& wavelengths_, OpticalReceiver* receiver_); 12110447Snilay@cs.wisc.edu const Map<OpticalDetector*>* getDetectors() const; 12210447Snilay@cs.wisc.edu OpticalDetector* getDetector(const String& name_); 12310447Snilay@cs.wisc.edu 12410447Snilay@cs.wisc.edu //----------------------------------------------------------------- 12510447Snilay@cs.wisc.edu 12610447Snilay@cs.wisc.edu protected: 12710447Snilay@cs.wisc.edu // In an OpticalModel, the complete optical port-to-port connectivity 12810447Snilay@cs.wisc.edu // of all sub-instances must be specified. Addition/Removal optical 12910447Snilay@cs.wisc.edu // ports or port-related nets cannot happen after this step 13010447Snilay@cs.wisc.edu //virtual void constructModel() = 0; 13110447Snilay@cs.wisc.edu // In an OpticalModel, updateModel MUST finish all necessary 13210447Snilay@cs.wisc.edu // calculations such that loss and wavelength power can be calculated 13310447Snilay@cs.wisc.edu //virtual void updateModel() = 0; 13410447Snilay@cs.wisc.edu // In an OpticalModel, evaluateModel should calculate all wavelength 13510447Snilay@cs.wisc.edu // power, updating power and energy events as necessary 13610447Snilay@cs.wisc.edu //virtual void evaluateModel() = 0; 13710447Snilay@cs.wisc.edu 13810447Snilay@cs.wisc.edu private: 13910447Snilay@cs.wisc.edu // Private copy constructor. Use clone to perform copy operation. 14010447Snilay@cs.wisc.edu OpticalModel(const OpticalModel& model_); 14110447Snilay@cs.wisc.edu 14210447Snilay@cs.wisc.edu private: 14310447Snilay@cs.wisc.edu // Map of all input ports 14410447Snilay@cs.wisc.edu Map<PortInfo*>* m_optical_input_ports_; 14510447Snilay@cs.wisc.edu // Map of all output ports 14610447Snilay@cs.wisc.edu Map<PortInfo*>* m_optical_output_ports_; 14710447Snilay@cs.wisc.edu 14810447Snilay@cs.wisc.edu // Optical graph model elements 14910447Snilay@cs.wisc.edu // Map of all waveguides 15010447Snilay@cs.wisc.edu Map<OpticalWaveguide*>* m_waveguides_; 15110447Snilay@cs.wisc.edu // Map of all laser source elements 15210447Snilay@cs.wisc.edu Map<OpticalLaser*>* m_lasers_; 15310447Snilay@cs.wisc.edu // Map of all filter elements 15410447Snilay@cs.wisc.edu Map<OpticalFilter*>* m_filters_; 15510447Snilay@cs.wisc.edu // Map of all modulator elements 15610447Snilay@cs.wisc.edu Map<OpticalModulator*>* m_modulators_; 15710447Snilay@cs.wisc.edu // Map of all photodetector elements 15810447Snilay@cs.wisc.edu Map<OpticalDetector*>* m_detectors_; 15910447Snilay@cs.wisc.edu 16010447Snilay@cs.wisc.edu }; // class OpticalModel 16110447Snilay@cs.wisc.edu} // namespace DSENT 16210447Snilay@cs.wisc.edu 16310447Snilay@cs.wisc.edu#endif // __DSENT_MODEL_OPTICALMODEL_H__ 16410447Snilay@cs.wisc.edu 165