PythonDEVS-BBL/docs/_build/html/_modules/pypdevsbbl/extra.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>pypdevsbbl.extra &#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" /> 
  </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="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="../index.html" accesskey="U">Module code</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <h1>Source code for pypdevsbbl.extra</h1><div class="highlight"><pre>
<span></span><span class="c1">#  Copyright 2020 Modelling, Simulation and Design Lab (MSDL) at</span>
<span class="c1">#  McGill University and the University of Antwerp (http://msdl.cs.mcgill.ca/)</span>
<span class="c1">#</span>
<span class="c1">#  Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<span class="c1">#  you may not use this file except in compliance with the License.</span>
<span class="c1">#  You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1">#     http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1">#  Unless required by applicable law or agreed to in writing, software</span>
<span class="c1">#  distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1">#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1">#  See the License for the specific language governing permissions and</span>
<span class="c1">#  limitations under the License.</span>

<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Within this package, you will be able to find a set of classes and functions</span>
<span class="sd">that allow for additional functionality that can be used in the building blocks.</span>

<span class="sd">This goes about file handing, mathematical helper functions, an implementation</span>
<span class="sd">for a `heap`, a set of packaging classes as required for the</span>
<span class="sd">:class:`pypdevsbbl.generic.transformers.Pack` and :class:`pypdevsbbl.generic.transformers.Unpack`</span>
<span class="sd">blocks and a set of inverse cumulative distribution functions that can</span>
<span class="sd">be used in the :class:`pypdevsbbl.generic.generators.RandomNumberGenerator`.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">pypdevs.DEVS</span> <span class="kn">import</span> <span class="n">CoupledDEVS</span>

<div class="viewcode-block" id="toDot"><a class="viewcode-back" href="../../pypdevsbbl.extra.html#pypdevsbbl.extra.toDot">[docs]</a><span class="k">def</span> <span class="nf">toDot</span><span class="p">(</span><span class="n">model</span><span class="p">:</span> <span class="n">CoupledDEVS</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Simple function for creating a Graphviz file for a Coupled DEVS.</span>

<span class="sd">    The submodels become the nodes and the connections become the directed</span>
<span class="sd">    edges.</span>

<span class="sd">    Note:</span>
<span class="sd">        The graphical representation that will be created is not a valid</span>
<span class="sd">        visual concrete syntax and should therefore only be used as confirmation</span>
<span class="sd">        on the validity of models.</span>

<span class="sd">    Args:</span>
<span class="sd">        model (CoupledDEVS):    A :class:`CoupledDEVS` model.</span>
<span class="sd">        filename (str):         The filename to write the graph to.</span>
<span class="sd">    &quot;&quot;&quot;</span>
    <span class="n">res</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
    <span class="c1"># Create a node for each component</span>
    <span class="k">for</span> <span class="n">submodel</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">component_set</span><span class="p">:</span>
        <span class="n">res</span> <span class="o">+=</span> <span class="s1">&#39;</span><span class="se">\n\t</span><span class="s1">&quot;</span><span class="si">%s</span><span class="s1">&quot; [label=&quot;</span><span class="si">%s</span><span class="s1">(</span><span class="si">%s</span><span class="s1">)&quot;];&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">submodel</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">submodel</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="n">submodel</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>

    <span class="n">res</span> <span class="o">+=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span>

    <span class="k">for</span> <span class="n">submodel</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">component_set</span><span class="p">:</span>
        <span class="k">for</span> <span class="n">out</span> <span class="ow">in</span> <span class="n">submodel</span><span class="o">.</span><span class="n">OPorts</span><span class="p">:</span>
            <span class="k">for</span> <span class="n">inp</span> <span class="ow">in</span> <span class="n">out</span><span class="o">.</span><span class="n">outline</span><span class="p">:</span>
                <span class="n">res</span> <span class="o">+=</span> <span class="s1">&#39;</span><span class="se">\n\t</span><span class="si">%s</span><span class="s1"> -&gt; </span><span class="si">%s</span><span class="s1"> [label=&quot;</span><span class="si">%s</span><span class="s1"> / </span><span class="si">%s</span><span class="s1">&quot;];&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">host_DEVS</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">inp</span><span class="o">.</span><span class="n">host_DEVS</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">out</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">inp</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>

    <span class="n">res</span> <span class="o">=</span> <span class="s2">&quot;digraph Model {</span><span class="si">%s</span><span class="se">\n</span><span class="s2">}&quot;</span> <span class="o">%</span> <span class="n">res</span>

    <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span>
        <span class="n">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">res</span><span class="p">)</span></div>
</pre></div>

          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<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="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="../index.html" >Module code</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>