doc/sphinx/_build/html/_modules/nepi/resources/ns3/classes/single_model_spectrum_channel.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>nepi.resources.ns3.classes.single_model_spectrum_channel &mdash; NEPI 3.2 documentation</title>
  10
  11     <link rel="stylesheet" href="../../../../../_static/sphinxdoc.css" type="text/css" />
  12     <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
  13
  14     <script type="text/javascript">
  15       var DOCUMENTATION_OPTIONS = {
  16         URL_ROOT:    '../../../../../',
  17         VERSION:     '3.2',
  18         COLLAPSE_INDEX: false,
  19         FILE_SUFFIX: '.html',
  20         HAS_SOURCE:  true
  21       };
  22     </script>
  23     <script type="text/javascript" src="../../../../../_static/jquery.js"></script>
  24     <script type="text/javascript" src="../../../../../_static/underscore.js"></script>
  25     <script type="text/javascript" src="../../../../../_static/doctools.js"></script>
  26     <link rel="top" title="NEPI 3.2 documentation" href="../../../../../index.html" />
  27     <link rel="up" title="Module code" href="../../../../index.html" />
  28   </head>
  29   <body>
  30     <div class="related">
  31       <h3>Navigation</h3>
  32       <ul>
  33         <li class="right" style="margin-right: 10px">
  34           <a href="../../../../../genindex.html" title="General Index"
  35              accesskey="I">index</a></li>
  36         <li class="right" >
  37           <a href="../../../../../py-modindex.html" title="Python Module Index"
  38              >modules</a> |</li>
  39         <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
  40           <li><a href="../../../../index.html" accesskey="U">Module code</a> &raquo;</li>
  41       </ul>
  42     </div>
  43       <div class="sphinxsidebar">
  44         <div class="sphinxsidebarwrapper">
  45 <div id="searchbox" style="display: none">
  46   <h3>Quick search</h3>
  47     <form class="search" action="../../../../../search.html" method="get">
  48       <input type="text" name="q" />
  49       <input type="submit" value="Go" />
  50       <input type="hidden" name="check_keywords" value="yes" />
  51       <input type="hidden" name="area" value="default" />
  52     </form>
  53     <p class="searchtip" style="font-size: 90%">
  54     Enter search terms or a module, class or function name.
  55     </p>
  56 </div>
  57 <script type="text/javascript">$('#searchbox').show(0);</script>
  58         </div>
  59       </div>
  60
  61     <div class="document">
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <h1>Source code for nepi.resources.ns3.classes.single_model_spectrum_channel</h1><div class="highlight"><pre>
  67 <span class="c">#</span>
  68 <span class="c">#    NEPI, a framework to manage network experiments</span>
  69 <span class="c">#    Copyright (C) 2014 INRIA</span>
  70 <span class="c">#</span>
  71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
  72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
  73 <span class="c">#    published by the Free Software Foundation;</span>
  74 <span class="c">#</span>
  75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
  76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  78 <span class="c">#    GNU General Public License for more details.</span>
  79 <span class="c">#</span>
  80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
  81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  82 <span class="c">#</span>
  83
  84 <span class="kn">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Attribute</span><span class="p">,</span> <span class="n">Flags</span><span class="p">,</span> <span class="n">Types</span>
  85 <span class="kn">from</span> <span class="nn">nepi.execution.trace</span> <span class="kn">import</span> <span class="n">Trace</span><span class="p">,</span> <span class="n">TraceAttr</span>
  86 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">ResourceManager</span><span class="p">,</span> <span class="n">clsinit_copy</span><span class="p">,</span> \
  87         <span class="n">ResourceState</span>
  88 <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3channel</span> <span class="kn">import</span> <span class="n">NS3BaseChannel</span>
  89
  90 <span class="nd">@clsinit_copy</span>
  91 <div class="viewcode-block" id="NS3SingleModelSpectrumChannel"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.ns3.classes.html#nepi.resources.ns3.classes.single_model_spectrum_channel.NS3SingleModelSpectrumChannel">[docs]</a><span class="k">class</span> <span class="nc">NS3SingleModelSpectrumChannel</span><span class="p">(</span><span class="n">NS3BaseChannel</span><span class="p">):</span>
  92     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;ns3::SingleModelSpectrumChannel&quot;</span>
  93
  94     <span class="nd">@classmethod</span>
  95     <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
  96
  97         <span class="n">attr_maxlossdb</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;MaxLossDb&quot;</span><span class="p">,</span>
  98             <span class="s">&quot;If a single-frequency PropagationLossModel is used, this value represents the maximum loss in dB for which transmissions will be passed to the receiving PHY. Signals for which the PropagationLossModel returns a loss bigger than this value will not be propagated to the receiver. This parameter is to be used to reduce the computational load by not propagating signals that are far beyond the interference range. Note that the default value corresponds to considering all signals for reception. Tune this value with care. &quot;</span><span class="p">,</span>
  99             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Double</span><span class="p">,</span>
 100             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;1e+09&quot;</span><span class="p">,</span>
 101             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 102             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 103             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Reserved</span> <span class="o">|</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Construct</span><span class="p">)</span>
 104
 105         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_maxlossdb</span><span class="p">)</span>
 106
 107         <span class="n">attr_id</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;Id&quot;</span><span class="p">,</span>
 108             <span class="s">&quot;The id (unique integer) of this Channel.&quot;</span><span class="p">,</span>
 109             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</span><span class="p">,</span>
 110             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
 111             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 112             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 113             <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Reserved</span> <span class="o">|</span> <span class="n">Flags</span><span class="o">.</span><span class="n">NoWrite</span><span class="p">)</span>
 114
 115         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_id</span><span class="p">)</span>
 116
 117
 118
 119     <span class="nd">@classmethod</span>
 120     <span class="k">def</span> <span class="nf">_register_traces</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
 121
 122         <span class="n">pathloss</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;PathLoss&quot;</span><span class="p">,</span> <span class="s">&quot;This trace is fired whenever a new path loss value is calculated. The first and second parameters to the trace are pointers respectively to the TX and RX SpectrumPhy instances, whereas the third parameters is the loss value in dB. Note that the loss value reported by this trace is the single-frequency loss value obtained by evaluating only the TX and RX AntennaModels and the PropagationLossModel. In particular, note that SpectrumPropagationLossModel (even if present) is never used to evaluate the loss value reported in this trace. &quot;</span><span class="p">)</span>
 123
 124         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">pathloss</span><span class="p">)</span>
 125
 126
 127
 128     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
 129         <span class="nb">super</span><span class="p">(</span><span class="n">NS3SingleModelSpectrumChannel</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span>
 130         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;ns3-single-model-spectrum-channel-</span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span></div>
 131 </pre></div>
 132
 133           </div>
 134         </div>
 135       </div>
 136       <div class="clearer"></div>
 137     </div>
 138     <div class="related">
 139       <h3>Navigation</h3>
 140       <ul>
 141         <li class="right" style="margin-right: 10px">
 142           <a href="../../../../../genindex.html" title="General Index"
 143              >index</a></li>
 144         <li class="right" >
 145           <a href="../../../../../py-modindex.html" title="Python Module Index"
 146              >modules</a> |</li>
 147         <li><a href="../../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
 148           <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
 149       </ul>
 150     </div>
 151     <div class="footer">
 152         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 153       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 154     </div>
 155   </body>
 156 </html>