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