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