doc/sphinx/_build/html/_modules/nepi/resources/ns3/classes/base_station_net_device.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.base_station_net_device &mdash; NEPI 3.0 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.0',
  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.0 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.0 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.base_station_net_device</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.ns3netdevice</span> <span class="kn">import</span> <span class="n">NS3BaseNetDevice</span>
  89
  90 <span class="nd">@clsinit_copy</span>
  91 <div class="viewcode-block" id="NS3BaseStationNetDevice"><a class="viewcode-back" href="../../../../../_layout/nepi.resources.ns3.classes.html#nepi.resources.ns3.classes.base_station_net_device.NS3BaseStationNetDevice">[docs]</a><span class="k">class</span> <span class="nc">NS3BaseStationNetDevice</span><span class="p">(</span><span class="n">NS3BaseNetDevice</span><span class="p">):</span>
  92     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;ns3::BaseStationNetDevice&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_initialranginterval</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;InitialRangInterval&quot;</span><span class="p">,</span>
  98             <span class="s">&quot;Time between Initial Ranging regions assigned by the BS. Maximum is 2s&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">String</span><span class="p">,</span>
 100             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;+50000000.0ns&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_initialranginterval</span><span class="p">)</span>
 106
 107         <span class="n">attr_dcdinterval</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;DcdInterval&quot;</span><span class="p">,</span>
 108             <span class="s">&quot;Time between transmission of DCD messages. Maximum value is 10s.&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">String</span><span class="p">,</span>
 110             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;+3000000000.0ns&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">Construct</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_dcdinterval</span><span class="p">)</span>
 116
 117         <span class="n">attr_ucdinterval</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;UcdInterval&quot;</span><span class="p">,</span>
 118             <span class="s">&quot;Time between transmission of UCD messages. Maximum value is 10s.&quot;</span><span class="p">,</span>
 119             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">String</span><span class="p">,</span>
 120             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;+3000000000.0ns&quot;</span><span class="p">,</span>
 121             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 122             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 123             <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>
 124
 125         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_ucdinterval</span><span class="p">)</span>
 126
 127         <span class="n">attr_intervalt8</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;IntervalT8&quot;</span><span class="p">,</span>
 128             <span class="s">&quot;Wait for DSA/DSC Acknowledge timeout. Maximum 300ms.&quot;</span><span class="p">,</span>
 129             <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">String</span><span class="p">,</span>
 130             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;+50000000.0ns&quot;</span><span class="p">,</span>
 131             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 132             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 133             <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>
 134
 135         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_intervalt8</span><span class="p">)</span>
 136
 137         <span class="n">attr_rangreqoppsize</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;RangReqOppSize&quot;</span><span class="p">,</span>
 138             <span class="s">&quot;The ranging opportunity size in symbols&quot;</span><span class="p">,</span>
 139             <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>
 140             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;8&quot;</span><span class="p">,</span>
 141             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 142             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 143             <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>
 144
 145         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_rangreqoppsize</span><span class="p">)</span>
 146
 147         <span class="n">attr_bwreqoppsize</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;BwReqOppSize&quot;</span><span class="p">,</span>
 148             <span class="s">&quot;The bandwidth request opportunity size in symbols&quot;</span><span class="p">,</span>
 149             <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>
 150             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;2&quot;</span><span class="p">,</span>
 151             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 152             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 153             <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>
 154
 155         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_bwreqoppsize</span><span class="p">)</span>
 156
 157         <span class="n">attr_maxrangcorrectionretries</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;MaxRangCorrectionRetries&quot;</span><span class="p">,</span>
 158             <span class="s">&quot;Number of retries on contention Ranging Requests&quot;</span><span class="p">,</span>
 159             <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>
 160             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;16&quot;</span><span class="p">,</span>
 161             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 162             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 163             <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>
 164
 165         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_maxrangcorrectionretries</span><span class="p">)</span>
 166
 167         <span class="n">attr_mtu</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;Mtu&quot;</span><span class="p">,</span>
 168             <span class="s">&quot;The MAC-level Maximum Transmission Unit&quot;</span><span class="p">,</span>
 169             <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>
 170             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;1400&quot;</span><span class="p">,</span>
 171             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 172             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 173             <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>
 174
 175         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_mtu</span><span class="p">)</span>
 176
 177         <span class="n">attr_rtg</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;RTG&quot;</span><span class="p">,</span>
 178             <span class="s">&quot;receive/transmit transition gap.&quot;</span><span class="p">,</span>
 179             <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>
 180             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
 181             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 182             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 183             <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>
 184
 185         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_rtg</span><span class="p">)</span>
 186
 187         <span class="n">attr_ttg</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">&quot;TTG&quot;</span><span class="p">,</span>
 188             <span class="s">&quot;transmit/receive transition gap.&quot;</span><span class="p">,</span>
 189             <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>
 190             <span class="n">default</span> <span class="o">=</span> <span class="s">&quot;0&quot;</span><span class="p">,</span>
 191             <span class="n">allowed</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 192             <span class="nb">range</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 193             <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>
 194
 195         <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">attr_ttg</span><span class="p">)</span>
 196
 197
 198
 199     <span class="nd">@classmethod</span>
 200     <span class="k">def</span> <span class="nf">_register_traces</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
 201
 202         <span class="n">bstx</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;BSTx&quot;</span><span class="p">,</span> <span class="s">&quot;A packet has been received from higher layers and is being processed in preparation for queueing for transmission.&quot;</span><span class="p">)</span>
 203
 204         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">bstx</span><span class="p">)</span>
 205
 206         <span class="n">bstxdrop</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;BSTxDrop&quot;</span><span class="p">,</span> <span class="s">&quot;A packet has been dropped in the MAC layer before being queued for transmission.&quot;</span><span class="p">)</span>
 207
 208         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">bstxdrop</span><span class="p">)</span>
 209
 210         <span class="n">bspromiscrx</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;BSPromiscRx&quot;</span><span class="p">,</span> <span class="s">&quot;A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack.  This is a promiscuous trace,&quot;</span><span class="p">)</span>
 211
 212         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">bspromiscrx</span><span class="p">)</span>
 213
 214         <span class="n">bsrx</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;BSRx&quot;</span><span class="p">,</span> <span class="s">&quot;A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack.  This is a non-promiscuous trace,&quot;</span><span class="p">)</span>
 215
 216         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">bsrx</span><span class="p">)</span>
 217
 218         <span class="n">bsrxdrop</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;BSRxDrop&quot;</span><span class="p">,</span> <span class="s">&quot;A packet has been dropped in the MAC layer after it has been passed up from the physical layer.&quot;</span><span class="p">)</span>
 219
 220         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">bsrxdrop</span><span class="p">)</span>
 221
 222         <span class="n">rx</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;Rx&quot;</span><span class="p">,</span> <span class="s">&quot;Receive trace&quot;</span><span class="p">)</span>
 223
 224         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">rx</span><span class="p">)</span>
 225
 226         <span class="n">tx</span> <span class="o">=</span> <span class="n">Trace</span><span class="p">(</span><span class="s">&quot;Tx&quot;</span><span class="p">,</span> <span class="s">&quot;Transmit trace&quot;</span><span class="p">)</span>
 227
 228         <span class="n">cls</span><span class="o">.</span><span class="n">_register_trace</span><span class="p">(</span><span class="n">tx</span><span class="p">)</span>
 229
 230
 231
 232     <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>
 233         <span class="nb">super</span><span class="p">(</span><span class="n">NS3BaseStationNetDevice</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>
 234         <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">&quot;ns3-base-station-net-device-</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>
 235 </pre></div>
 236
 237           </div>
 238         </div>
 239       </div>
 240       <div class="clearer"></div>
 241     </div>
 242     <div class="related">
 243       <h3>Navigation</h3>
 244       <ul>
 245         <li class="right" style="margin-right: 10px">
 246           <a href="../../../../../genindex.html" title="General Index"
 247              >index</a></li>
 248         <li class="right" >
 249           <a href="../../../../../py-modindex.html" title="Python Module Index"
 250              >modules</a> |</li>
 251         <li><a href="../../../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 252           <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
 253       </ul>
 254     </div>
 255     <div class="footer">
 256         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 257       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 258     </div>
 259   </body>
 260 </html>