README moves to markdown
[nepi.git] / src / nepi / resources / ns3 / classes / steady_state_random_waypoint_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 NS3SteadyStateRandomWaypointMobilityModel(NS3BaseMobilityModel):
26     _rtype = "ns3::SteadyStateRandomWaypointMobilityModel"
27
28     @classmethod
29     def _register_attributes(cls):
30         
31         attr_minspeed = Attribute("MinSpeed",
32             "Minimum speed value, [m/s]",
33             type = Types.Double,
34             default = "0.3",  
35             allowed = None,
36             range = None,    
37             flags = Flags.Reserved | Flags.Construct)
38
39         cls._register_attribute(attr_minspeed)
40
41         attr_maxspeed = Attribute("MaxSpeed",
42             "Maximum speed value, [m/s]",
43             type = Types.Double,
44             default = "0.7",  
45             allowed = None,
46             range = None,    
47             flags = Flags.Reserved | Flags.Construct)
48
49         cls._register_attribute(attr_maxspeed)
50
51         attr_minpause = Attribute("MinPause",
52             "Minimum pause value, [s]",
53             type = Types.Double,
54             default = "0",  
55             allowed = None,
56             range = None,    
57             flags = Flags.Reserved | Flags.Construct)
58
59         cls._register_attribute(attr_minpause)
60
61         attr_maxpause = Attribute("MaxPause",
62             "Maximum pause value, [s]",
63             type = Types.Double,
64             default = "0",  
65             allowed = None,
66             range = None,    
67             flags = Flags.Reserved | Flags.Construct)
68
69         cls._register_attribute(attr_maxpause)
70
71         attr_minx = Attribute("MinX",
72             "Minimum X value of traveling region, [m]",
73             type = Types.Double,
74             default = "1",  
75             allowed = None,
76             range = None,    
77             flags = Flags.Reserved | Flags.Construct)
78
79         cls._register_attribute(attr_minx)
80
81         attr_maxx = Attribute("MaxX",
82             "Maximum X value of traveling region, [m]",
83             type = Types.Double,
84             default = "1",  
85             allowed = None,
86             range = None,    
87             flags = Flags.Reserved | Flags.Construct)
88
89         cls._register_attribute(attr_maxx)
90
91         attr_miny = Attribute("MinY",
92             "Minimum Y value of traveling region, [m]",
93             type = Types.Double,
94             default = "1",  
95             allowed = None,
96             range = None,    
97             flags = Flags.Reserved | Flags.Construct)
98
99         cls._register_attribute(attr_miny)
100
101         attr_maxy = Attribute("MaxY",
102             "Maximum Y value of traveling region, [m]",
103             type = Types.Double,
104             default = "1",  
105             allowed = None,
106             range = None,    
107             flags = Flags.Reserved | Flags.Construct)
108
109         cls._register_attribute(attr_maxy)
110
111         attr_z = Attribute("Z",
112             "Z value of traveling region (fixed), [m]",
113             type = Types.Double,
114             default = "0",  
115             allowed = None,
116             range = None,    
117             flags = Flags.Reserved | Flags.Construct)
118
119         cls._register_attribute(attr_z)
120
121         attr_position = Attribute("Position",
122             "The current position of the mobility model.",
123             type = Types.String,
124             default = "0:0:0",  
125             allowed = None,
126             range = None,    
127             flags = Flags.Reserved)
128
129         cls._register_attribute(attr_position)
130
131         attr_velocity = Attribute("Velocity",
132             "The current velocity of the mobility model.",
133             type = Types.String,
134             default = "0:0:0",  
135             allowed = None,
136             range = None,    
137             flags = Flags.Reserved | Flags.NoWrite)
138
139         cls._register_attribute(attr_velocity)
140
141
142
143     @classmethod
144     def _register_traces(cls):
145         
146         coursechange = Trace("CourseChange", "The value of the position and/or velocity vector changed")
147
148         cls._register_trace(coursechange)
149
150
151
152     def __init__(self, ec, guid):
153         super(NS3SteadyStateRandomWaypointMobilityModel, self).__init__(ec, guid)
154         self._home = "ns3-steady-state-random-waypoint-mobility-model-%s" % self.guid