Fix #122 [NS3] Implement wireless model scenarios with mobility
[nepi.git] / src / nepi / resources / ns3 / ns3node.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.resource import clsinit_copy
21 from nepi.resources.ns3.ns3base import NS3Base
22
23 @clsinit_copy
24 class NS3BaseNode(NS3Base):
25     _rtype = "abstract::ns3::Node"
26
27     @property
28     def simulation(self):
29         from nepi.resources.ns3.ns3simulation import NS3Simulation
30         for guid in self.connections:
31             rm = self.ec.get_resource(guid)
32             if isinstance(rm, NS3Simulation):
33                 return rm
34
35         msg = "Node not connected to simulation"
36         self.error(msg)
37         raise RuntimeError, msg
38  
39     @property
40     def ipv4(self):
41         from nepi.resources.ns3.ns3ipv4l3protocol import NS3BaseIpv4L3Protocol
42         ipv4s = self.get_connected(NS3BaseIpv4L3Protocol.get_rtype())
43         if ipv4s: return ipv4s[0]
44         return None
45
46     @property
47     def mobility(self):
48         from nepi.resources.ns3.ns3mobilitymodel import NS3BaseMobilityModel
49         mobility = self.get_connected(NS3BaseMobilityModel.get_rtype())
50         if mobility: return mobility[0]
51         return None
52
53     @property
54     def _rms_to_wait(self):
55         rms = set()
56         rms.add(self.simulation)
57
58         ipv4 = self.ipv4
59         if ipv4:
60             rms.add(ipv4)
61
62         mobility = self.mobility
63         if mobility:
64             rms.add(mobility)
65
66         return rms
67
68     def _configure_object(self):
69         ### node.AggregateObject(PacketSocketFactory())
70         uuid_packet_socket_factory = self.simulation.create("PacketSocketFactory")
71         self.simulation.invoke(self.uuid, "AggregateObject", uuid_packet_socket_factory)
72
73     def _connect_object(self):
74         ipv4 = self.ipv4
75         if ipv4:
76             self.simulation.invoke(self.uuid, "AggregateObject", ipv4.uuid)
77
78         mobility = self.mobility
79         if mobility:
80             self.simulation.invoke(self.uuid, "AggregateObject", mobility.uuid)
81
82