src/nepi/resources/ns3/classes/two_ray_ground_propagation_loss_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.ns3propagationlossmodel import NS3BasePropagationLossModel
  24
  25 @clsinit_copy
  26 class NS3TwoRayGroundPropagationLossModel(NS3BasePropagationLossModel):
  27     _rtype = "ns3::TwoRayGroundPropagationLossModel"
  28
  29     @classmethod
  30     def _register_attributes(cls):
  31
  32         attr_frequency = Attribute("Frequency",
  33             "The carrier frequency (in Hz) at which propagation occurs  (default is 5.15 GHz).",
  34             type = Types.Double,
  35             default = "5.15e+09",
  36             allowed = None,
  37             range = None,
  38             flags = Flags.Reserved | Flags.Construct)
  39
  40         cls._register_attribute(attr_frequency)
  41
  42         attr_systemloss = Attribute("SystemLoss",
  43             "The system loss",
  44             type = Types.Double,
  45             default = "1",
  46             allowed = None,
  47             range = None,
  48             flags = Flags.Reserved | Flags.Construct)
  49
  50         cls._register_attribute(attr_systemloss)
  51
  52         attr_mindistance = Attribute("MinDistance",
  53             "The distance under which the propagation model refuses to give results (m)",
  54             type = Types.Double,
  55             default = "0.5",
  56             allowed = None,
  57             range = None,
  58             flags = Flags.Reserved | Flags.Construct)
  59
  60         cls._register_attribute(attr_mindistance)
  61
  62         attr_heightabovez = Attribute("HeightAboveZ",
  63             "The height of the antenna (m) above the node\'s Z coordinate",
  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_heightabovez)
  71
  72
  73
  74     @classmethod
  75     def _register_traces(cls):
  76         pass
  77
  78     def __init__(self, ec, guid):
  79         super(NS3TwoRayGroundPropagationLossModel, self).__init__(ec, guid)
  80         self._home = "ns3-two-ray-ground-propagation-loss-model-%s" % self.guid