e8ab8b6348d4979d7ae529012a690e4178d72f6e
[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 as published by
7 #    the Free Software Foundation, either version 3 of the License, or
8 #    (at your option) any later version.
9 #
10 #    This program is distributed in the hope that it will be useful,
11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 #    GNU General Public License for more details.
14 #
15 #    You should have received a copy of the GNU General Public License
16 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 #
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19
20 from nepi.execution.attribute import Attribute, Flags, Types
21 from nepi.execution.resource import clsinit_copy
22 from nepi.resources.ns3.ns3base import NS3Base
23 from nepi.resources.ns3.ns3wifinetdevice import WIFI_STANDARDS
24
25 @clsinit_copy
26 class NS3BaseWifiMac(NS3Base):
27     _rtype = "abstract::ns3::WifiMac"
28
29     @classmethod
30     def _register_attributes(cls):
31         standard = Attribute("Standard", "Wireless standard",
32                 default = "WIFI_PHY_STANDARD_80211a",
33                 allowed = WIFI_STANDARDS.keys(),
34                 type = Types.Enumerate,
35                 flags = Flags.Design)
36
37         cls._register_attribute(standard)
38
39     @property
40     def node(self):
41         return self.device.node
42
43     @property
44     def device(self):
45         from nepi.resources.ns3.ns3wifinetdevice import NS3BaseWifiNetDevice
46         devices = self.get_connected(NS3BaseWifiNetDevice.get_rtype())
47
48         if not devices: 
49             msg = "WifiMac not connected to device"
50             self.error(msg)
51             raise RuntimeError, msg
52
53         return devices[0]
54
55     @property
56     def _rms_to_wait(self):
57         rms = set()
58         rms.add(self.device)
59         return rms
60
61     def _connect_object(self):
62         device = self.device
63         if device.uuid not in self.connected:
64             self._connected.add(device.uuid)
65
66             self.simulation.invoke(device.uuid, "SetMac", self.uuid)
67
68             standard = self.get("Standard")
69             self.simulation.invoke(self.uuid, "ConfigureStandard", WIFI_STANDARDS[standard])
70
71             # Delayed configuration of MAC address
72             mac = device.get("mac")
73             if mac:
74                 mac_uuid = self.simulation.create("Mac48Address", mac)
75             else:
76                 mac_uuid = self.simulation.invoke("singleton::Mac48Address", "Allocate")
77
78             self.simulation.invoke(self.uuid, "SetAddress", mac_uuid)
79
80