README moves to markdown
[nepi.git] / nepi / resources / ns3 / classes / lte_enb_net_device.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.ns3netdevice import NS3BaseNetDevice 
23
24 @clsinit_copy
25 class NS3LteEnbNetDevice(NS3BaseNetDevice):
26     _rtype = "ns3::LteEnbNetDevice"
27
28     @classmethod
29     def _register_attributes(cls):
30         
31         attr_ulbandwidth = Attribute("UlBandwidth",
32             "Uplink Transmission Bandwidth Configuration in number of Resource Blocks",
33             type = Types.Integer,
34             default = "25",  
35             allowed = None,
36             range = None,    
37             flags = Flags.Reserved | Flags.Construct)
38
39         cls._register_attribute(attr_ulbandwidth)
40
41         attr_dlbandwidth = Attribute("DlBandwidth",
42             "Downlink Transmission Bandwidth Configuration in number of Resource Blocks",
43             type = Types.Integer,
44             default = "25",  
45             allowed = None,
46             range = None,    
47             flags = Flags.Reserved | Flags.Construct)
48
49         cls._register_attribute(attr_dlbandwidth)
50
51         attr_cellid = Attribute("CellId",
52             "Cell Identifier",
53             type = Types.Integer,
54             default = "0",  
55             allowed = None,
56             range = None,    
57             flags = Flags.Reserved | Flags.Construct)
58
59         cls._register_attribute(attr_cellid)
60
61         attr_dlearfcn = Attribute("DlEarfcn",
62             "Downlink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) as per 3GPP 36.101 Section 5.7.3. ",
63             type = Types.Integer,
64             default = "100",  
65             allowed = None,
66             range = None,    
67             flags = Flags.Reserved | Flags.Construct)
68
69         cls._register_attribute(attr_dlearfcn)
70
71         attr_ulearfcn = Attribute("UlEarfcn",
72             "Uplink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) as per 3GPP 36.101 Section 5.7.3. ",
73             type = Types.Integer,
74             default = "18100",  
75             allowed = None,
76             range = None,    
77             flags = Flags.Reserved | Flags.Construct)
78
79         cls._register_attribute(attr_ulearfcn)
80
81         attr_csgid = Attribute("CsgId",
82             "The Closed Subscriber Group (CSG) identity that this eNodeB belongs to",
83             type = Types.Integer,
84             default = "0",  
85             allowed = None,
86             range = None,    
87             flags = Flags.Reserved | Flags.Construct)
88
89         cls._register_attribute(attr_csgid)
90
91         attr_csgindication = Attribute("CsgIndication",
92             "If true, only UEs which are members of the CSG (i.e. same CSG ID) can gain access to the eNodeB, therefore enforcing closed access mode. Otherwise, the eNodeB operates as a non-CSG cell and implements open access mode.",
93             type = Types.Bool,
94             default = "False",  
95             allowed = None,
96             range = None,    
97             flags = Flags.Reserved | Flags.Construct)
98
99         cls._register_attribute(attr_csgindication)
100
101         attr_mtu = Attribute("Mtu",
102             "The MAC-level Maximum Transmission Unit",
103             type = Types.Integer,
104             default = "30000",  
105             allowed = None,
106             range = None,    
107             flags = Flags.Reserved | Flags.Construct)
108
109         cls._register_attribute(attr_mtu)
110
111
112
113     @classmethod
114     def _register_traces(cls):
115         pass
116
117     def __init__(self, ec, guid):
118         super(NS3LteEnbNetDevice, self).__init__(ec, guid)
119         self._home = "ns3-lte-enb-net-device-%s" % self.guid