6d2e75d5d8d496433f7bda7a5573f3dac5c37373
[nepi.git] / src / nepi / resources / ns3 / classes / random_direction2d_mobility_model.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
19 from nepi.execution.attribute import Attribute, Flags, Types
20 from nepi.execution.trace import Trace, TraceAttr
21 from nepi.execution.resource import ResourceManager, clsinit_copy, \
22         ResourceState, reschedule_delay
23 from nepi.resources.ns3.ns3mobilitymodel import NS3BaseMobilityModel 
24
25 @clsinit_copy
26 class NS3RandomDirection2dMobilityModel(NS3BaseMobilityModel):
27     _rtype = "ns3::RandomDirection2dMobilityModel"
28
29     @classmethod
30     def _register_attributes(cls):
31         
32         attr_bounds = Attribute("Bounds",
33             "The 2d bounding area",
34             type = Types.String,
35             default = "-100|100|-100|100",  
36             allowed = None,
37             range = None,    
38             flags = Flags.Reserved | Flags.Construct)
39
40         cls._register_attribute(attr_bounds)
41
42         attr_speed = Attribute("Speed",
43             "A random variable to control the speed (m/s).",
44             type = Types.String,
45             default = "ns3::UniformRandomVariable[Min=1.0|Max=2.0]",  
46             allowed = None,
47             range = None,    
48             flags = Flags.Reserved | Flags.Construct)
49
50         cls._register_attribute(attr_speed)
51
52         attr_pause = Attribute("Pause",
53             "A random variable to control the pause (s).",
54             type = Types.String,
55             default = "ns3::ConstantRandomVariable[Constant=2.0]",  
56             allowed = None,
57             range = None,    
58             flags = Flags.Reserved | Flags.Construct)
59
60         cls._register_attribute(attr_pause)
61
62         attr_position = Attribute("Position",
63             "The current position of the mobility model.",
64             type = Types.String,
65             default = "0:0:0",  
66             allowed = None,
67             range = None,    
68             flags = Flags.Reserved)
69
70         cls._register_attribute(attr_position)
71
72         attr_velocity = Attribute("Velocity",
73             "The current velocity of the mobility model.",
74             type = Types.String,
75             default = "0:0:0",  
76             allowed = None,
77             range = None,    
78             flags = Flags.Reserved | Flags.NoWrite)
79
80         cls._register_attribute(attr_velocity)
81
82
83
84     @classmethod
85     def _register_traces(cls):
86         
87         coursechange = Trace("CourseChange", "The value of the position and/or velocity vector changed")
88
89         cls._register_trace(coursechange)
90
91
92
93     def __init__(self, ec, guid):
94         super(NS3RandomDirection2dMobilityModel, self).__init__(ec, guid)
95         self._home = "ns3-random-direction2d-mobility-model-%s" % self.guid