README moves to markdown
[nepi.git] / nepi / resources / ns3 / ns3wifiphy.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 NS3BaseWifiPhy(NS3Base):
28     _rtype = "abstract::ns3::WifiPhy"
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 = "WifiPhy not connected to device"
54             self.error(msg)
55             raise RuntimeError(msg)
56
57         return devices[0]
58
59     @property
60     def channel(self):
61         from nepi.resources.ns3.ns3wifichannel import NS3BaseWifiChannel
62         channels = self.get_connected(NS3BaseWifiChannel.get_rtype())
63
64         if not channels: 
65             msg = "WifiPhy not connected to channel"
66             self.error(msg)
67             raise RuntimeError(msg)
68
69         return channels[0]
70
71     @property
72     def _rms_to_wait(self):
73         rms = set()
74         rms.add(self.device)
75         return rms
76
77     def _connect_object(self):
78         device = self.device
79         if device.uuid not in self.connected:
80             self._connected.add(device.uuid)
81
82             self.simulation.invoke(self.uuid, "SetMobility", self.node.uuid)
83
84             standard = self.get("Standard")
85             self.simulation.invoke(self.uuid, "ConfigureStandard", WIFI_STANDARDS[standard])
86
87             self.simulation.invoke(self.uuid, "SetDevice", device.uuid)
88
89             self.simulation.invoke(self.uuid, "SetChannel", self.channel.uuid)
90             
91             self.simulation.invoke(device.uuid, "SetPhy", self.uuid)
92