PythonDEVS-BBL/docs/_build/html/test.generic.test_queues.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>test.generic.test_queues module &#8212; Python(P)DEVS-BBL  documentation</title>
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" type="text/css" href="_static/custom.css" />
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/language_data.js"></script>
    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="test.generic.test_routing module" href="test.generic.test_routing.html" />
    <link rel="prev" title="test.generic.test_math module" href="test.generic.test_math.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="test.generic.test_routing.html" title="test.generic.test_routing module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="test.generic.test_math.html" title="test.generic.test_math module"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Python(P)DEVS-BBL  documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="test.html" >test package</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="test.generic.html" accesskey="U">test.generic package</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="module-test.generic.test_queues">
<span id="test-generic-test-queues-module"></span><h1>test.generic.test_queues module<a class="headerlink" href="#module-test.generic.test_queues" title="Permalink to this headline">¶</a></h1>
<p>Tests the Queue building blocks to prove validity w.r.t. these tests.</p>
<p>Every test will run a PythonPDEVS simulation on a model. This model will
afterwards be analyzed against the expected measures. The model has a
general shape of</p>
<p class="centered">
<strong><code class="docutils literal notranslate"><span class="pre">TableGenerator</span> <span class="pre">-&gt;</span> <span class="pre">Queue</span> <span class="pre">-&gt;</span> <span class="pre">TableCollector</span></code></strong></p><div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Whereas not all blocks seem to be tested, because the
<a class="reference internal" href="pypdevsbbl.generic.queues.html#pypdevsbbl.generic.queues.Queue" title="pypdevsbbl.generic.queues.Queue"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues.Queue</span></code></a> is a coupled DEVS made up of other
blocks, all will be tested in general.</p>
<p class="last">As far as the <a class="reference internal" href="pypdevsbbl.generic.queues.html#pypdevsbbl.generic.queues.QueueTracker" title="pypdevsbbl.generic.queues.QueueTracker"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues.QueueTracker</span></code></a> is concerned,
the edgecases will not be tested, because it is only meant to be used
in as a part of the <a class="reference internal" href="pypdevsbbl.generic.queues.html#pypdevsbbl.generic.queues.Queue" title="pypdevsbbl.generic.queues.Queue"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues.Queue</span></code></a>.</p>
</div>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="pypdevsbbl.generic.queues.html#module-pypdevsbbl.generic.queues" title="pypdevsbbl.generic.queues"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues</span></code></a></p>
</div>
<dl class="class">
<dt id="test.generic.test_queues.QModel">
<em class="property">class </em><code class="descclassname">test.generic.test_queues.</code><code class="descname">QModel</code><span class="sig-paren">(</span><em>table</em>, <em>queue</em>, <em>qport</em>, <em>cport</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic/test_queues.html#QModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.test_queues.QModel" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevs.DEVS.CoupledDEVS</span></code></p>
<p>Simple model constructor for the tests.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>table</strong> (<em>list</em>) – A list with all events that should happen.</li>
<li><strong>queue</strong> – The queue to test.</li>
<li><strong>qport</strong> – The input port of the queue.</li>
<li><strong>cport</strong> – The output port of the queue.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="test.generic.test_queues.simulate">
<code class="descclassname">test.generic.test_queues.</code><code class="descname">simulate</code><span class="sig-paren">(</span><em>table</em>, <em>queue</em>, <em>qport=None</em>, <em>cport=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic/test_queues.html#simulate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.test_queues.simulate" title="Permalink to this definition">¶</a></dt>
<dd><p>Simulates the model.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>table</strong> (<em>list</em>) – A list with all events that should happen.</li>
<li><strong>queue</strong> – The queue to test.</li>
<li><strong>qport</strong> – The input port of the queue.</li>
<li><strong>cport</strong> – The output port of the queue.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="test.generic.test_queues.TestQueue">
<em class="property">class </em><code class="descclassname">test.generic.test_queues.</code><code class="descname">TestQueue</code><span class="sig-paren">(</span><em>methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic/test_queues.html#TestQueue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.test_queues.TestQueue" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">unittest.case.TestCase</span></code></p>
<dl class="method">
<dt id="test.generic.test_queues.TestQueue.test_discipline">
<code class="descname">test_discipline</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic/test_queues.html#TestQueue.test_discipline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.test_queues.TestQueue.test_discipline" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests the queueing discipline (<code class="docutils literal notranslate"><span class="pre">fc</span></code>) of the <a class="reference internal" href="pypdevsbbl.generic.queues.html#pypdevsbbl.generic.queues.Queue" title="pypdevsbbl.generic.queues.Queue"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues.Queue</span></code></a>.</p>
</dd></dl>

<dl class="method">
<dt id="test.generic.test_queues.TestQueue.test_contents">
<code class="descname">test_contents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic/test_queues.html#TestQueue.test_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.test_queues.TestQueue.test_contents" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests the startup contents (<code class="docutils literal notranslate"><span class="pre">contents</span></code>) of the <a class="reference internal" href="pypdevsbbl.generic.queues.html#pypdevsbbl.generic.queues.SimpleQueue" title="pypdevsbbl.generic.queues.SimpleQueue"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues.SimpleQueue</span></code></a>.</p>
</dd></dl>

<dl class="method">
<dt id="test.generic.test_queues.TestQueue.test_reneging">
<code class="descname">test_reneging</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic/test_queues.html#TestQueue.test_reneging"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.test_queues.TestQueue.test_reneging" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests the reneging of the <a class="reference internal" href="pypdevsbbl.generic.queues.html#pypdevsbbl.generic.queues.Queue" title="pypdevsbbl.generic.queues.Queue"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues.Queue</span></code></a>.</p>
</dd></dl>

<dl class="method">
<dt id="test.generic.test_queues.TestQueue.test_overflow">
<code class="descname">test_overflow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic/test_queues.html#TestQueue.test_overflow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.test_queues.TestQueue.test_overflow" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests the overflow of the <a class="reference internal" href="pypdevsbbl.generic.queues.html#pypdevsbbl.generic.queues.Queue" title="pypdevsbbl.generic.queues.Queue"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues.Queue</span></code></a>.</p>
</dd></dl>

<dl class="method">
<dt id="test.generic.test_queues.TestQueue.test_retain_individual">
<code class="descname">test_retain_individual</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic/test_queues.html#TestQueue.test_retain_individual"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.test_queues.TestQueue.test_retain_individual" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests the <a class="reference internal" href="pypdevsbbl.generic.queues.html#pypdevsbbl.generic.queues.Retain" title="pypdevsbbl.generic.queues.Retain"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues.Retain</span></code></a> block.</p>
</dd></dl>

<dl class="method">
<dt id="test.generic.test_queues.TestQueue.test_retain_collection">
<code class="descname">test_retain_collection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic/test_queues.html#TestQueue.test_retain_collection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.test_queues.TestQueue.test_retain_collection" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests the <a class="reference internal" href="pypdevsbbl.generic.queues.html#pypdevsbbl.generic.queues.Retain" title="pypdevsbbl.generic.queues.Retain"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues.Retain</span></code></a> block in <em>collection</em> mode.</p>
</dd></dl>

<dl class="method">
<dt id="test.generic.test_queues.TestQueue.test_advance">
<code class="descname">test_advance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic/test_queues.html#TestQueue.test_advance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.test_queues.TestQueue.test_advance" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests the <a class="reference internal" href="pypdevsbbl.generic.queues.html#pypdevsbbl.generic.queues.Advance" title="pypdevsbbl.generic.queues.Advance"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.queues.Advance</span></code></a> block.</p>
</dd></dl>

</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="test.generic.test_math.html"
                        title="previous chapter">test.generic.test_math module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="test.generic.test_routing.html"
                        title="next chapter">test.generic.test_routing module</a></p>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="test.generic.test_routing.html" title="test.generic.test_routing module"
             >next</a> |</li>
        <li class="right" >
          <a href="test.generic.test_math.html" title="test.generic.test_math module"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Python(P)DEVS-BBL  documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="test.html" >test package</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="test.generic.html" >test.generic package</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2020, Randy Paredis.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
    </div>
  </body>
</html>