nepi/resources/ns3/classes/gauss_markov_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 NS3GaussMarkovMobilityModel(NS3BaseMobilityModel):
  26     _rtype = "ns3::GaussMarkovMobilityModel"
  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 = "-100|100|-100|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_timestep = Attribute("TimeStep",
  42             "Change current direction and speed after moving for this time.",
  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_timestep)
  50
  51         attr_alpha = Attribute("Alpha",
  52             "A constant representing the tunable parameter in the Gauss-Markov model.",
  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_alpha)
  60
  61         attr_meanvelocity = Attribute("MeanVelocity",
  62             "A random variable used to assign the average velocity.",
  63             type = Types.String,
  64             default = "ns3::UniformRandomVariable[Min=0.0|Max=1.0]",
  65             allowed = None,
  66             range = None,
  67             flags = Flags.Reserved | Flags.Construct)
  68
  69         cls._register_attribute(attr_meanvelocity)
  70
  71         attr_meandirection = Attribute("MeanDirection",
  72             "A random variable used to assign the average direction.",
  73             type = Types.String,
  74             default = "ns3::UniformRandomVariable[Min=0.0|Max=6.283185307]",
  75             allowed = None,
  76             range = None,
  77             flags = Flags.Reserved | Flags.Construct)
  78
  79         cls._register_attribute(attr_meandirection)
  80
  81         attr_meanpitch = Attribute("MeanPitch",
  82             "A random variable used to assign the average pitch.",
  83             type = Types.String,
  84             default = "ns3::ConstantRandomVariable[Constant=0.0]",
  85             allowed = None,
  86             range = None,
  87             flags = Flags.Reserved | Flags.Construct)
  88
  89         cls._register_attribute(attr_meanpitch)
  90
  91         attr_normalvelocity = Attribute("NormalVelocity",
  92             "A gaussian random variable used to calculate the next velocity value.",
  93             type = Types.String,
  94             default = "ns3::NormalRandomVariable[Mean=0.0|Variance=1.0|Bound=10.0]",
  95             allowed = None,
  96             range = None,
  97             flags = Flags.Reserved | Flags.Construct)
  98
  99         cls._register_attribute(attr_normalvelocity)
 100
 101         attr_normaldirection = Attribute("NormalDirection",
 102             "A gaussian random variable used to calculate the next direction value.",
 103             type = Types.String,
 104             default = "ns3::NormalRandomVariable[Mean=0.0|Variance=1.0|Bound=10.0]",
 105             allowed = None,
 106             range = None,
 107             flags = Flags.Reserved | Flags.Construct)
 108
 109         cls._register_attribute(attr_normaldirection)
 110
 111         attr_normalpitch = Attribute("NormalPitch",
 112             "A gaussian random variable used to calculate the next pitch value.",
 113             type = Types.String,
 114             default = "ns3::NormalRandomVariable[Mean=0.0|Variance=1.0|Bound=10.0]",
 115             allowed = None,
 116             range = None,
 117             flags = Flags.Reserved | Flags.Construct)
 118
 119         cls._register_attribute(attr_normalpitch)
 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(NS3GaussMarkovMobilityModel, self).__init__(ec, guid)
 154         self._home = "ns3-gauss-markov-mobility-model-%s" % self.guid