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_OPTICALLINKBACKENDRX_H__
23#define __DSENT_MODEL_OPTICAL_OPTICALLINKBACKENDRX_H__
24
25#include "util/CommonType.h"
26#include "model/ElectricalModel.h"
27
28namespace DSENT
29{
30    class OpticalLinkBackendRx : public ElectricalModel
31    {
32        // An optical link backend rx contains everything needed for thermal
33        // tuning of rings, bit-reshuffling (if necessary), and deserialization (if necessary)
34        public:
35            OpticalLinkBackendRx(const String& instance_name_, const TechModel* tech_model_);
36            virtual ~OpticalLinkBackendRx();
37
38        public:
39            // Set a list of properties' name needed to construct model
40            void initParameters();
41            // Set a list of properties' name needed to construct model
42            void initProperties();
43
44        protected:
45            // Build the model
46            virtual void constructModel();
47            virtual void updateModel();
48            virtual void propagateTransitionInfo();
49
50        private:
51            // Calculate ring tuning power
52            double getRingTuningPower();
53            // Calculate the degree of bit re-order muxing (for the bit-reshuffler)
54            unsigned int getBitReorderDegree();
55
56    }; // class OpticalLinkBackendRx
57} // namespace DSENT
58
59#endif // __DSENT_MODEL_OPTICAL_OPTICALLINKBACKENDRX_H__
60
61