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