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