test.generic.html 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <title>test.generic package &#8212; Python(P)DEVS-BBL documentation</title>
  8. <link rel="stylesheet" href="_static/nature.css" type="text/css" />
  9. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  10. <link rel="stylesheet" type="text/css" href="_static/custom.css" />
  11. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  12. <script type="text/javascript" src="_static/jquery.js"></script>
  13. <script type="text/javascript" src="_static/underscore.js"></script>
  14. <script type="text/javascript" src="_static/doctools.js"></script>
  15. <script type="text/javascript" src="_static/language_data.js"></script>
  16. <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>
  17. <link rel="index" title="Index" href="genindex.html" />
  18. <link rel="search" title="Search" href="search.html" />
  19. <link rel="next" title="test.generic.test_collectors module" href="test.generic.test_collectors.html" />
  20. <link rel="prev" title="test.extra.test_packaging module" href="test.extra.test_packaging.html" />
  21. </head><body>
  22. <div class="related" role="navigation" aria-label="related navigation">
  23. <h3>Navigation</h3>
  24. <ul>
  25. <li class="right" style="margin-right: 10px">
  26. <a href="genindex.html" title="General Index"
  27. accesskey="I">index</a></li>
  28. <li class="right" >
  29. <a href="py-modindex.html" title="Python Module Index"
  30. >modules</a> |</li>
  31. <li class="right" >
  32. <a href="test.generic.test_collectors.html" title="test.generic.test_collectors module"
  33. accesskey="N">next</a> |</li>
  34. <li class="right" >
  35. <a href="test.extra.test_packaging.html" title="test.extra.test_packaging module"
  36. accesskey="P">previous</a> |</li>
  37. <li class="nav-item nav-item-0"><a href="index.html">Python(P)DEVS-BBL documentation</a> &#187;</li>
  38. <li class="nav-item nav-item-1"><a href="test.html" accesskey="U">test package</a> &#187;</li>
  39. </ul>
  40. </div>
  41. <div class="document">
  42. <div class="documentwrapper">
  43. <div class="bodywrapper">
  44. <div class="body" role="main">
  45. <div class="section" id="module-test.generic">
  46. <span id="test-generic-package"></span><h1>test.generic package<a class="headerlink" href="#module-test.generic" title="Permalink to this headline">¶</a></h1>
  47. <p>Tests for the generic building blocks.</p>
  48. <dl class="class">
  49. <dt id="test.generic.Model">
  50. <em class="property">class </em><code class="descclassname">test.generic.</code><code class="descname">Model</code><span class="sig-paren">(</span><em>nodes</em>, <em>connections</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic.html#Model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.Model" title="Permalink to this definition">¶</a></dt>
  51. <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevs.DEVS.CoupledDEVS</span></code></p>
  52. <p>Simple model constructor for the tests.</p>
  53. <table class="docutils field-list" frame="void" rules="none">
  54. <col class="field-name" />
  55. <col class="field-body" />
  56. <tbody valign="top">
  57. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  58. <li><strong>nodes</strong> (<em>iter</em>) – An iterable with all submodels to add.</li>
  59. <li><strong>connections</strong> (<em>iter</em>) – An iterable with all port connections.
  60. Each entry is in the form of (from, to)</li>
  61. </ul>
  62. </td>
  63. </tr>
  64. </tbody>
  65. </table>
  66. </dd></dl>
  67. <dl class="function">
  68. <dt id="test.generic.simulate">
  69. <code class="descclassname">test.generic.</code><code class="descname">simulate</code><span class="sig-paren">(</span><em>model</em>, <em>tt=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/test/generic.html#simulate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#test.generic.simulate" title="Permalink to this definition">¶</a></dt>
  70. <dd><p>Simulates the model.</p>
  71. <table class="docutils field-list" frame="void" rules="none">
  72. <col class="field-name" />
  73. <col class="field-body" />
  74. <tbody valign="top">
  75. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  76. <li><strong>model</strong> (<em>MModel</em>) – The <a class="reference internal" href="#test.generic.Model" title="test.generic.Model"><code class="xref py py-class docutils literal notranslate"><span class="pre">Model</span></code></a> to simulate.</li>
  77. <li><strong>tt</strong> (<em>numeric</em>) – The termination time or <code class="docutils literal notranslate"><span class="pre">None</span></code> if
  78. no termination time needs to be set.
  79. Defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</li>
  80. </ul>
  81. </td>
  82. </tr>
  83. </tbody>
  84. </table>
  85. </dd></dl>
  86. <div class="section" id="submodules">
  87. <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
  88. <div class="toctree-wrapper compound">
  89. <ul>
  90. <li class="toctree-l1"><a class="reference internal" href="test.generic.test_collectors.html">test.generic.test_collectors module</a></li>
  91. <li class="toctree-l1"><a class="reference internal" href="test.generic.test_generators.html">test.generic.test_generators module</a></li>
  92. <li class="toctree-l1"><a class="reference internal" href="test.generic.test_io.html">test.generic.test_io module</a></li>
  93. <li class="toctree-l1"><a class="reference internal" href="test.generic.test_math.html">test.generic.test_math module</a></li>
  94. <li class="toctree-l1"><a class="reference internal" href="test.generic.test_queues.html">test.generic.test_queues module</a></li>
  95. <li class="toctree-l1"><a class="reference internal" href="test.generic.test_routing.html">test.generic.test_routing module</a></li>
  96. <li class="toctree-l1"><a class="reference internal" href="test.generic.test_transformers.html">test.generic.test_transformers module</a></li>
  97. </ul>
  98. </div>
  99. </div>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  105. <div class="sphinxsidebarwrapper">
  106. <h4>Previous topic</h4>
  107. <p class="topless"><a href="test.extra.test_packaging.html"
  108. title="previous chapter">test.extra.test_packaging module</a></p>
  109. <h4>Next topic</h4>
  110. <p class="topless"><a href="test.generic.test_collectors.html"
  111. title="next chapter">test.generic.test_collectors module</a></p>
  112. <div id="searchbox" style="display: none" role="search">
  113. <h3>Quick search</h3>
  114. <div class="searchformwrapper">
  115. <form class="search" action="search.html" method="get">
  116. <input type="text" name="q" />
  117. <input type="submit" value="Go" />
  118. <input type="hidden" name="check_keywords" value="yes" />
  119. <input type="hidden" name="area" value="default" />
  120. </form>
  121. </div>
  122. </div>
  123. <script type="text/javascript">$('#searchbox').show(0);</script>
  124. </div>
  125. </div>
  126. <div class="clearer"></div>
  127. </div>
  128. <div class="related" role="navigation" aria-label="related navigation">
  129. <h3>Navigation</h3>
  130. <ul>
  131. <li class="right" style="margin-right: 10px">
  132. <a href="genindex.html" title="General Index"
  133. >index</a></li>
  134. <li class="right" >
  135. <a href="py-modindex.html" title="Python Module Index"
  136. >modules</a> |</li>
  137. <li class="right" >
  138. <a href="test.generic.test_collectors.html" title="test.generic.test_collectors module"
  139. >next</a> |</li>
  140. <li class="right" >
  141. <a href="test.extra.test_packaging.html" title="test.extra.test_packaging module"
  142. >previous</a> |</li>
  143. <li class="nav-item nav-item-0"><a href="index.html">Python(P)DEVS-BBL documentation</a> &#187;</li>
  144. <li class="nav-item nav-item-1"><a href="test.html" >test package</a> &#187;</li>
  145. </ul>
  146. </div>
  147. <div class="footer" role="contentinfo">
  148. &#169; Copyright 2020, Randy Paredis.
  149. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
  150. </div>
  151. </body>
  152. </html>