OpticalFilter.h revision 10448
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_OPTICALGRAPH_OPTICALFILTER_H__ 2310447Snilay@cs.wisc.edu#define __DSENT_MODEL_OPTICALGRAPH_OPTICALFILTER_H__ 2410447Snilay@cs.wisc.edu 2510447Snilay@cs.wisc.edu#include "model/optical_graph/OpticalNode.h" 2610447Snilay@cs.wisc.edu#include "util/CommonType.h" 2710447Snilay@cs.wisc.edu 2810447Snilay@cs.wisc.edunamespace DSENT 2910447Snilay@cs.wisc.edu{ 3010447Snilay@cs.wisc.edu class OpticalFilter : public OpticalNode 3110447Snilay@cs.wisc.edu { 3210447Snilay@cs.wisc.edu public: 3310447Snilay@cs.wisc.edu OpticalFilter(const String& instance_name_, OpticalModel* model_, const WavelengthGroup& wavelengths_, bool drop_all_, const WavelengthGroup& drop_wavelengths_); 3410447Snilay@cs.wisc.edu ~OpticalFilter(); 3510447Snilay@cs.wisc.edu 3610447Snilay@cs.wisc.edu public: 3710447Snilay@cs.wisc.edu // Get the drop all flag 3810447Snilay@cs.wisc.edu bool getDropAll() const; 3910447Snilay@cs.wisc.edu // Get drop wavelengths 4010447Snilay@cs.wisc.edu WavelengthGroup getDropWavelengths() const; 4110447Snilay@cs.wisc.edu // Set and get the drop loss 4210447Snilay@cs.wisc.edu void setDropLoss(double drop_loss_); 4310447Snilay@cs.wisc.edu double getDropLoss() const; 4410447Snilay@cs.wisc.edu // Set and get drop port 4510447Snilay@cs.wisc.edu void setDropPort(OpticalNode* drop_port_); 4610447Snilay@cs.wisc.edu OpticalNode* getDropPort(); 4710447Snilay@cs.wisc.edu // Checks to see if a set of wavelengths will be dropped 4810447Snilay@cs.wisc.edu bool isDropped(const WavelengthGroup& wavelengths_) const; 4910447Snilay@cs.wisc.edu 5010447Snilay@cs.wisc.edu private: 5110447Snilay@cs.wisc.edu // Disable copy constructor 5210447Snilay@cs.wisc.edu OpticalFilter(const OpticalFilter& node_); 5310447Snilay@cs.wisc.edu 5410447Snilay@cs.wisc.edu private: 5510447Snilay@cs.wisc.edu // Whether to drop all the optical signal for the drop wavelengths 5610447Snilay@cs.wisc.edu // i.e. so that the drop wavelengths are not traced anymore 5710447Snilay@cs.wisc.edu const bool m_drop_all_; 5810447Snilay@cs.wisc.edu // The loss incurred from in to drop port 5910447Snilay@cs.wisc.edu double m_drop_loss_; 6010447Snilay@cs.wisc.edu // The wavelengths that are dropped 6110447Snilay@cs.wisc.edu const WavelengthGroup m_drop_wavelengths_; 6210447Snilay@cs.wisc.edu // The node at the drop port 6310447Snilay@cs.wisc.edu OpticalNode* m_drop_port_; 6410447Snilay@cs.wisc.edu }; 6510447Snilay@cs.wisc.edu 6610447Snilay@cs.wisc.edu} // namespace DSENT 6710447Snilay@cs.wisc.edu 6810447Snilay@cs.wisc.edu#endif // __DSENT_MODEL_OPTICALGRAPH_OPTICALFILTER_H__ 6910447Snilay@cs.wisc.edu 70