README moves to markdown
[nepi.git] / src / nepi / resources / ns3 / ns3wifimac.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 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
18
19 from six import PY3
20
21 from nepi.execution.attribute import Attribute, Flags, Types
22 from nepi.execution.resource import clsinit_copy
23 from nepi.resources.ns3.ns3base import NS3Base
24 from nepi.resources.ns3.ns3wifinetdevice import WIFI_STANDARDS
25
26 @clsinit_copy
27 class NS3BaseWifiMac(NS3Base):
28     _rtype = "abstract::ns3::WifiMac"
29
30     @classmethod
31     def _register_attributes(cls):
32         # stay safe and keep extra list() added by 2to3
33         allowed = WIFI_STANDARDS.keys()
34         if PY3: allowed = list(allowed)
35         standard = Attribute("Standard", "Wireless standard",
36                 default = "WIFI_PHY_STANDARD_80211a",
37                 allowed = allowed,
38                 type = Types.Enumerate,
39                 flags = Flags.Design)
40
41         cls._register_attribute(standard)
42
43     @property
44     def node(self):
45         return self.device.node
46
47     @property
48     def device(self):
49         from nepi.resources.ns3.ns3wifinetdevice import NS3BaseWifiNetDevice
50         devices = self.get_connected(NS3BaseWifiNetDevice.get_rtype())
51
52         if not devices: 
53             msg = "WifiMac not connected to device"
54             self.error(msg)
55             raise RuntimeError(msg)
56
57         return devices[0]
58
59     @property
60     def _rms_to_wait(self):
61         rms = set()
62         rms.add(self.device)
63         return rms
64
65     def _connect_object(self):
66         device = self.device
67         if device.uuid not in self.connected:
68             self._connected.add(device.uuid)
69
70             self.simulation.invoke(device.uuid, "SetMac", self.uuid)
71
72             standard = self.get("Standard")
73             self.simulation.invoke(self.uuid, "ConfigureStandard", WIFI_STANDARDS[standard])
74
75             # Delayed configuration of MAC address
76             mac = device.get("mac")
77             if mac:
78                 mac_uuid = self.simulation.create("Mac48Address", mac)
79             else:
80                 mac_uuid = self.simulation.invoke("singleton::Mac48Address", "Allocate")
81
82             self.simulation.invoke(self.uuid, "SetAddress", mac_uuid)
83
84