nepi/resources/ns3/classes/random_walk2d_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 NS3RandomWalk2dMobilityModel(NS3BaseMobilityModel):
  26     _rtype = "ns3::RandomWalk2dMobilityModel"
  27
  28     @classmethod
  29     def _register_attributes(cls):
  30
  31         attr_bounds = Attribute("Bounds",
  32             "Bounds of the area to cruise.",
  33             type = Types.String,
  34             default = "0|100|0|100",
  35             allowed = None,
  36             range = None,
  37             flags = Flags.Reserved | Flags.Construct)
  38
  39         cls._register_attribute(attr_bounds)
  40
  41         attr_time = Attribute("Time",
  42             "Change current direction and speed after moving for this delay.",
  43             type = Types.String,
  44             default = "+1000000000.0ns",
  45             allowed = None,
  46             range = None,
  47             flags = Flags.Reserved | Flags.Construct)
  48
  49         cls._register_attribute(attr_time)
  50
  51         attr_distance = Attribute("Distance",
  52             "Change current direction and speed after moving for this distance.",
  53             type = Types.Double,
  54             default = "1",
  55             allowed = None,
  56             range = None,
  57             flags = Flags.Reserved | Flags.Construct)
  58
  59         cls._register_attribute(attr_distance)
  60
  61         attr_mode = Attribute("Mode",
  62             "The mode indicates the condition used to change the current speed and direction",
  63             type = Types.Enumerate,
  64             default = "Distance",
  65             allowed = ["Distance","Time"],
  66             range = None,
  67             flags = Flags.Reserved | Flags.Construct)
  68
  69         cls._register_attribute(attr_mode)
  70
  71         attr_direction = Attribute("Direction",
  72             "A random variable used to pick the direction (gradients).",
  73             type = Types.String,
  74             default = "ns3::UniformRandomVariable[Min=0.0|Max=6.283184]",
  75             allowed = None,
  76             range = None,
  77             flags = Flags.Reserved | Flags.Construct)
  78
  79         cls._register_attribute(attr_direction)
  80
  81         attr_speed = Attribute("Speed",
  82             "A random variable used to pick the speed (m/s).",
  83             type = Types.String,
  84             default = "ns3::UniformRandomVariable[Min=2.0|Max=4.0]",
  85             allowed = None,
  86             range = None,
  87             flags = Flags.Reserved | Flags.Construct)
  88
  89         cls._register_attribute(attr_speed)
  90
  91         attr_position = Attribute("Position",
  92             "The current position of the mobility model.",
  93             type = Types.String,
  94             default = "0:0:0",
  95             allowed = None,
  96             range = None,
  97             flags = Flags.Reserved)
  98
  99         cls._register_attribute(attr_position)
 100
 101         attr_velocity = Attribute("Velocity",
 102             "The current velocity of the mobility model.",
 103             type = Types.String,
 104             default = "0:0:0",
 105             allowed = None,
 106             range = None,
 107             flags = Flags.Reserved | Flags.NoWrite)
 108
 109         cls._register_attribute(attr_velocity)
 110
 111
 112
 113     @classmethod
 114     def _register_traces(cls):
 115
 116         coursechange = Trace("CourseChange", "The value of the position and/or velocity vector changed")
 117
 118         cls._register_trace(coursechange)
 119
 120
 121
 122     def __init__(self, ec, guid):
 123         super(NS3RandomWalk2dMobilityModel, self).__init__(ec, guid)
 124         self._home = "ns3-random-walk2d-mobility-model-%s" % self.guid