update NEPI version on sphinx docs
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / resources / ns3 / ns3queue.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.ns3queue &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.ns3queue</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 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
84
85 <span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">clsinit_copy</span>
86 <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3base</span> <span class="kn">import</span> <span class="n">NS3Base</span>
87
88 <span class="nd">@clsinit_copy</span>
89 <div class="viewcode-block" id="NS3BaseQueue"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3queue.NS3BaseQueue">[docs]</a><span class="k">class</span> <span class="nc">NS3BaseQueue</span><span class="p">(</span><span class="n">NS3Base</span><span class="p">):</span>
90     <span class="n">_rtype</span> <span class="o">=</span> <span class="s">&quot;abstract::ns3::Queue&quot;</span>
91
92     <span class="nd">@property</span>
93 <div class="viewcode-block" id="NS3BaseQueue.device"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3queue.NS3BaseQueue.device">[docs]</a>    <span class="k">def</span> <span class="nf">device</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
94         <span class="kn">from</span> <span class="nn">nepi.resources.ns3.ns3netdevice</span> <span class="kn">import</span> <span class="n">NS3BaseNetDevice</span>
95         <span class="n">devices</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connected</span><span class="p">(</span><span class="n">NS3BaseNetDevice</span><span class="o">.</span><span class="n">get_rtype</span><span class="p">())</span>
96
97         <span class="k">if</span> <span class="ow">not</span> <span class="n">devices</span><span class="p">:</span> 
98             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;Queue not connected to device&quot;</span>
99             <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
100             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">msg</span>
101
102         <span class="k">return</span> <span class="n">devices</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
103 </div>
104     <span class="nd">@property</span>
105 <div class="viewcode-block" id="NS3BaseQueue.node"><a class="viewcode-back" href="../../../../_layout/nepi.resources.ns3.html#nepi.resources.ns3.ns3queue.NS3BaseQueue.node">[docs]</a>    <span class="k">def</span> <span class="nf">node</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
106         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">device</span><span class="o">.</span><span class="n">node</span>
107 </div>
108     <span class="nd">@property</span>
109     <span class="k">def</span> <span class="nf">_rms_to_wait</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
110         <span class="n">rms</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
111         <span class="n">rms</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">device</span><span class="p">)</span>
112         <span class="k">return</span> <span class="n">rms</span>
113
114     <span class="k">def</span> <span class="nf">_connect_object</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
115         <span class="n">device</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">device</span>
116         <span class="k">if</span> <span class="n">device</span><span class="o">.</span><span class="n">uuid</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connected</span><span class="p">:</span>
117             <span class="bp">self</span><span class="o">.</span><span class="n">simulation</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span><span class="n">device</span><span class="o">.</span><span class="n">uuid</span><span class="p">,</span> <span class="s">&quot;SetQueue&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">uuid</span><span class="p">)</span>
118             <span class="bp">self</span><span class="o">.</span><span class="n">_connected</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">device</span><span class="o">.</span><span class="n">uuid</span><span class="p">)</span>
119             <span class="n">device</span><span class="o">.</span><span class="n">_connected</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">uuid</span><span class="p">)</span>
120 </pre></div></div>
121
122           </div>
123         </div>
124       </div>
125       <div class="clearer"></div>
126     </div>
127     <div class="related">
128       <h3>Navigation</h3>
129       <ul>
130         <li class="right" style="margin-right: 10px">
131           <a href="../../../../genindex.html" title="General Index"
132              >index</a></li>
133         <li class="right" >
134           <a href="../../../../py-modindex.html" title="Python Module Index"
135              >modules</a> |</li>
136         <li><a href="../../../../index.html">NEPI 3.2 documentation</a> &raquo;</li>
137           <li><a href="../../../index.html" >Module code</a> &raquo;</li> 
138       </ul>
139     </div>
140     <div class="footer">
141         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
142       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
143     </div>
144   </body>
145 </html>