rename src/nepi/ into just nepi/
[nepi.git] / nepi / resources / ns3 / classes / nakagami_propagation_loss_model.py
1 #
2 #    NEPI, a framework to manage network experiments
3 #    Copyright (C) 2014 INRIA
4 #
5 #    This program is free software: you can redistribute it and/or modify
6 #    it under the terms of the GNU General Public License version 2 as
7 #    published by the Free Software Foundation;
8 #
9 #    This program is distributed in the hope that it will be useful,
10 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
11 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 #    GNU General Public License for more details.
13 #
14 #    You should have received a copy of the GNU General Public License
15 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
16 #
17
18 from nepi.execution.attribute import Attribute, Flags, Types
19 from nepi.execution.trace import Trace, TraceAttr
20 from nepi.execution.resource import ResourceManager, clsinit_copy, \
21         ResourceState
22 from nepi.resources.ns3.ns3propagationlossmodel import NS3BasePropagationLossModel 
23
24 @clsinit_copy
25 class NS3NakagamiPropagationLossModel(NS3BasePropagationLossModel):
26     _rtype = "ns3::NakagamiPropagationLossModel"
27
28     @classmethod
29     def _register_attributes(cls):
30         
31         attr_distance1 = Attribute("Distance1",
32             "Beginning of the second distance field. Default is 80m.",
33             type = Types.Double,
34             default = "80",  
35             allowed = None,
36             range = None,    
37             flags = Flags.Reserved | Flags.Construct)
38
39         cls._register_attribute(attr_distance1)
40
41         attr_distance2 = Attribute("Distance2",
42             "Beginning of the third distance field. Default is 200m.",
43             type = Types.Double,
44             default = "200",  
45             allowed = None,
46             range = None,    
47             flags = Flags.Reserved | Flags.Construct)
48
49         cls._register_attribute(attr_distance2)
50
51         attr_m0 = Attribute("m0",
52             "m0 for distances smaller than Distance1. Default is 1.5.",
53             type = Types.Double,
54             default = "1.5",  
55             allowed = None,
56             range = None,    
57             flags = Flags.Reserved | Flags.Construct)
58
59         cls._register_attribute(attr_m0)
60
61         attr_m1 = Attribute("m1",
62             "m1 for distances smaller than Distance2. Default is 0.75.",
63             type = Types.Double,
64             default = "0.75",  
65             allowed = None,
66             range = None,    
67             flags = Flags.Reserved | Flags.Construct)
68
69         cls._register_attribute(attr_m1)
70
71         attr_m2 = Attribute("m2",
72             "m2 for distances greater than Distance2. Default is 0.75.",
73             type = Types.Double,
74             default = "0.75",  
75             allowed = None,
76             range = None,    
77             flags = Flags.Reserved | Flags.Construct)
78
79         cls._register_attribute(attr_m2)
80
81         attr_erlangrv = Attribute("ErlangRv",
82             "Access to the underlying ErlangRandomVariable",
83             type = Types.String,
84             default = "ns3::ErlangRandomVariable",  
85             allowed = None,
86             range = None,    
87             flags = Flags.Reserved | Flags.Construct)
88
89         cls._register_attribute(attr_erlangrv)
90
91         attr_gammarv = Attribute("GammaRv",
92             "Access to the underlying GammaRandomVariable",
93             type = Types.String,
94             default = "ns3::GammaRandomVariable",  
95             allowed = None,
96             range = None,    
97             flags = Flags.Reserved | Flags.Construct)
98
99         cls._register_attribute(attr_gammarv)
100
101
102
103     @classmethod
104     def _register_traces(cls):
105         pass
106
107     def __init__(self, ec, guid):
108         super(NS3NakagamiPropagationLossModel, self).__init__(ec, guid)
109         self._home = "ns3-nakagami-propagation-loss-model-%s" % self.guid