README moves to markdown
[nepi.git] / nepi / resources / ns3 / classes / friis_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 NS3FriisPropagationLossModel(NS3BasePropagationLossModel):
26     _rtype = "ns3::FriisPropagationLossModel"
27
28     @classmethod
29     def _register_attributes(cls):
30         
31         attr_frequency = Attribute("Frequency",
32             "The carrier frequency (in Hz) at which propagation occurs  (default is 5.15 GHz).",
33             type = Types.Double,
34             default = "5.15e+09",  
35             allowed = None,
36             range = None,    
37             flags = Flags.Reserved | Flags.Construct)
38
39         cls._register_attribute(attr_frequency)
40
41         attr_systemloss = Attribute("SystemLoss",
42             "The system loss",
43             type = Types.Double,
44             default = "1",  
45             allowed = None,
46             range = None,    
47             flags = Flags.Reserved | Flags.Construct)
48
49         cls._register_attribute(attr_systemloss)
50
51         attr_minloss = Attribute("MinLoss",
52             "The minimum value (dB) of the total loss, used at short ranges. Note: ",
53             type = Types.Double,
54             default = "0",  
55             allowed = None,
56             range = None,    
57             flags = Flags.Reserved | Flags.Construct)
58
59         cls._register_attribute(attr_minloss)
60
61
62
63     @classmethod
64     def _register_traces(cls):
65         pass
66
67     def __init__(self, ec, guid):
68         super(NS3FriisPropagationLossModel, self).__init__(ec, guid)
69         self._home = "ns3-friis-propagation-loss-model-%s" % self.guid