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_OPTICALFILTER_H__
23#define __DSENT_MODEL_OPTICALGRAPH_OPTICALFILTER_H__
24
25#include "model/optical_graph/OpticalNode.h"
26#include "util/CommonType.h"
27
28namespace DSENT
29{
30    class OpticalFilter : public OpticalNode
31    {
32        public:
33            OpticalFilter(const String& instance_name_, OpticalModel* model_, const WavelengthGroup& wavelengths_, bool drop_all_, const WavelengthGroup& drop_wavelengths_);
34            ~OpticalFilter();
35
36        public:
37            // Get the drop all flag
38            bool getDropAll() const;
39            // Get drop wavelengths
40            WavelengthGroup getDropWavelengths() const;
41            // Set and get the drop loss
42            void setDropLoss(double drop_loss_);
43            double getDropLoss() const;
44            // Set and get drop port
45            void setDropPort(OpticalNode* drop_port_);
46            OpticalNode* getDropPort();
47            // Checks to see if a set of wavelengths will be dropped
48            bool isDropped(const WavelengthGroup& wavelengths_) const;
49
50        private:
51            // Disable copy constructor
52            OpticalFilter(const OpticalFilter& node_);
53
54        private:
55            // Whether to drop all the optical signal for the drop wavelengths
56            // i.e. so that the drop wavelengths are not traced anymore
57            const bool m_drop_all_;
58            // The loss incurred from in to drop port
59            double m_drop_loss_;
60            // The wavelengths that are dropped
61            const WavelengthGroup m_drop_wavelengths_;
62            // The node at the drop port
63            OpticalNode* m_drop_port_;
64    };
65
66} // namespace DSENT
67
68#endif // __DSENT_MODEL_OPTICALGRAPH_OPTICALFILTER_H__
69
70