rparedis
/
PythonDEVS-BBL


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
							
<!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>pypdevsbbl.tracers.StatisticsTracer 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 package" href="test.html" />
    <link rel="prev" title="pypdevsbbl.tracers.ProfileTracer module" href="pypdevsbbl.tracers.ProfileTracer.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.html" title="test package"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="pypdevsbbl.tracers.ProfileTracer.html" title="pypdevsbbl.tracers.ProfileTracer 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="pypdevsbbl.html" >pypdevsbbl package</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="pypdevsbbl.tracers.html" accesskey="U">pypdevsbbl.tracers 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-pypdevsbbl.tracers.StatisticsTracer">
<span id="pypdevsbbl-tracers-statisticstracer-module"></span><h1>pypdevsbbl.tracers.StatisticsTracer module<a class="headerlink" href="#module-pypdevsbbl.tracers.StatisticsTracer" title="Permalink to this headline">¶</a></h1>
<p>This file contains the tracer for statistical data.</p>
<dl class="class">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer">
<em class="property">class </em><code class="descclassname">pypdevsbbl.tracers.StatisticsTracer.</code><code class="descname">StatisticsTracer</code><span class="sig-paren">(</span><em>uid</em>, <em>server</em>, <em>filename</em>, <em>inports</em>, <em>outports</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="pypdevsbbl.tracers.html#pypdevsbbl.tracers.BaseTracer" title="pypdevsbbl.tracers.BaseTracer"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.tracers.BaseTracer</span></code></a></p>
<p>Gathers information about the messages in a (sub)model.</p>
<dl class="docutils">
<dt>It can compute:</dt>
<dd><ul class="first last simple">
<li>The average time of messages in the system.</li>
<li>The average amount of messages in the system for a certain
time period.</li>
<li>The (amount of) messages that entered the system.</li>
<li>The (amount of) messages that left the system.</li>
<li>The (amount of) messages that were newly generated.</li>
<li>The (amount of) messages that were discarded or left behind.</li>
</ul>
</dd>
</dl>
<p>The internal depiction of a message is a tiplet:
<code class="docutils literal notranslate"><span class="pre">(message,</span> <span class="pre">arrival</span> <span class="pre">time,</span> <span class="pre">departure</span> <span class="pre">time)</span></code>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>The tracer makes use of the <code class="xref py py-meth docutils literal notranslate"><span class="pre">id()</span></code> function to determine
which message entered and left. When your messages may change
order (when using a different queueing discipline or so), make
sure the messages can be uniquely identified afterwards.</p>
<p class="last">It would also be non-sensical to have a
<a class="reference internal" href="pypdevsbbl.generic.generators.html#pypdevsbbl.generic.generators.ConstantGenerator" title="pypdevsbbl.generic.generators.ConstantGenerator"><code class="xref py py-class docutils literal notranslate"><span class="pre">pypdevsbbl.generic.generators.ConstantGenerator</span></code></a> generate a
single value and change the order in which they arrive. All
messages are the same, so how would you determine they have
a different order of arrival?</p>
</div>
<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>uid</strong> – A unique identifier for distributed simulation.
Will be set automatically.</li>
<li><strong>server</strong> – The server that runs the distributed simulation.
Will be set automatically.</li>
<li><strong>filename</strong> (<em>str</em>) – The name of the file to write the results to.
When <code class="docutils literal notranslate"><span class="pre">None</span></code>, all results will be written to the
standard output.</li>
<li><strong>inports</strong> (<em>list</em>) – A list of the input ports to listen on for events
that enter the system. These may be ports of a
coupled DEVS.</li>
<li><strong>outports</strong> (<em>list</em>) – A list of the output ports to listen on for events
that leave the system. These may be ports of a
coupled DEVS.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.startTracer">
<code class="descname">startTracer</code><span class="sig-paren">(</span><em>recover</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.startTracer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.startTracer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.stopTracer">
<code class="descname">stopTracer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.stopTracer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.stopTracer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.traceExternal">
<code class="descname">traceExternal</code><span class="sig-paren">(</span><em>aDEVS</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.traceExternal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.traceExternal" title="Permalink to this definition">¶</a></dt>
<dd><p>Trace messages that enter the system.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.traceInternal">
<code class="descname">traceInternal</code><span class="sig-paren">(</span><em>aDEVS</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.traceInternal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.traceInternal" title="Permalink to this definition">¶</a></dt>
<dd><p>Trace messages that leave the system.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.summary">
<code class="descname">summary</code><span class="sig-paren">(</span><em>prefix='\t'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.summary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.summary" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the current stats as a string.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.average_time_in_system">
<code class="descname">average_time_in_system</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.average_time_in_system"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.average_time_in_system" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports the average time a message remained in the system.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This ignores all newly created and bequeathed messages.</p>
</div>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.average_num">
<code class="descname">average_num</code><span class="sig-paren">(</span><em>dx=1.0</em>, <em>start=0</em>, <em>end=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.average_num"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.average_num" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports the average amount of messages for a certain time period.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This ignores all newly created and bequeathed messages.</p>
</div>
<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>dx</strong> (<em>numeric</em>) – The time period to look over. Defaults to 1.</li>
<li><strong>start</strong> (<em>numeric</em>) – The point in time to start measuring from.
When <code class="docutils literal notranslate"><span class="pre">None</span></code>, it will use the first seen
arrival as a starting point. Defaults to 0
(= usually the start of the simulation).</li>
<li><strong>end</strong> (<em>numeric</em>) – The point in time to end measuring at. When
<code class="docutils literal notranslate"><span class="pre">None</span></code>, it will use the last seen departure
as an end point. This point is inclusive in
the range. Defaults to <code class="docutils literal notranslate"><span class="pre">None</span></code>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.entries">
<code class="descname">entries</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.entries" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports all messages that entered the system.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_entries">
<code class="descname">n_entries</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.n_entries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_entries" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports the amount of messages that entered the system.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.exits">
<code class="descname">exits</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.exits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.exits" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports all messages that left the system.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_exits">
<code class="descname">n_exits</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.n_exits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_exits" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports the amount of messages that left the system.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.passed">
<code class="descname">passed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.passed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.passed" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports all messages that passed through the system.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_passed">
<code class="descname">n_passed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.n_passed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_passed" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports the amount of messages that passed through the system.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.new">
<code class="descname">new</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.new"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.new" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports all messages that were generated in the submodel.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_new">
<code class="descname">n_new</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.n_new"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_new" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports the amount of messages that were generated in the submodel.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.bequeathed">
<code class="descname">bequeathed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.bequeathed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.bequeathed" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports all messages that were dropped or left behind in the submodel.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_bequeathed">
<code class="descname">n_bequeathed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypdevsbbl/tracers/StatisticsTracer.html#StatisticsTracer.n_bequeathed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_bequeathed" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports the amount of messages that were dropped or left behind in the submodel.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.forgotten">
<code class="descname">forgotten</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.forgotten" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for <a class="reference internal" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.bequeathed" title="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.bequeathed"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bequeathed()</span></code></a>, because, although less accurate, it is easier to remember.</p>
</dd></dl>

<dl class="method">
<dt id="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_forgotten">
<code class="descname">n_forgotten</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_forgotten" title="Permalink to this definition">¶</a></dt>
<dd><p>Alias for <a class="reference internal" href="#pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_bequeathed" title="pypdevsbbl.tracers.StatisticsTracer.StatisticsTracer.n_bequeathed"><code class="xref py py-meth docutils literal notranslate"><span class="pre">n_bequeathed()</span></code></a>, because, although less accurate, it is easier to remember.</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="pypdevsbbl.tracers.ProfileTracer.html"
                        title="previous chapter">pypdevsbbl.tracers.ProfileTracer module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="test.html"
                        title="next chapter">test package</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.html" title="test package"
             >next</a> |</li>
        <li class="right" >
          <a href="pypdevsbbl.tracers.ProfileTracer.html" title="pypdevsbbl.tracers.ProfileTracer 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="pypdevsbbl.html" >pypdevsbbl package</a> &#187;</li>
          <li class="nav-item nav-item-2"><a href="pypdevsbbl.tracers.html" >pypdevsbbl.tracers 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>