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