jexelmans
/
drawio2py


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
							
<!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>How to Execute DrawioConvert? &#8212; DrawioConvert 0.2 documentation</title>
    <link rel="stylesheet" href="_static/haiku.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" type="text/css" href="_static/styles.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>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="How To Create Custom Formalisms?" href="formalisms/create.html" />
    <link rel="prev" title="Welcome to DrawioConvert’s documentation!" href="index.html" /> 
  </head><body>
      <div class="header" role="banner"><h1 class="heading"><a href="index.html">
          <span>DrawioConvert 0.2 documentation</span></a></h1>
        <h2 class="heading"><span>How to Execute DrawioConvert?</span></h2>
      </div>
      <div class="topnav" role="navigation" aria-label="top navigation">
      
        <p>
        «&#160;&#160;<a href="index.html">Welcome to DrawioConvert’s documentation!</a>
        &#160;&#160;::&#160;&#160;
        <a class="uplink" href="index.html">Contents</a>
        &#160;&#160;::&#160;&#160;
        <a href="formalisms/create.html">How To Create Custom Formalisms?</a>&#160;&#160;»
        </p>

      </div>
      <div class="content">
        
        
  <div class="section" id="how-to-execute-drawioconvert">
<h1>How to Execute <code class="code docutils literal notranslate"><span class="pre">DrawioConvert</span></code>?<a class="headerlink" href="#how-to-execute-drawioconvert" title="Permalink to this headline">¶</a></h1>
<p>The execution for <code class="code docutils literal notranslate"><span class="pre">DrawioConvert</span></code> is simple:</p>
<div class="code highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span> <span class="n">__main__</span><span class="o">.</span><span class="n">py</span> <span class="o">&lt;</span><span class="n">INPUT</span><span class="o">&gt;</span> <span class="p">[</span><span class="n">ARGS</span><span class="p">]</span>
</pre></div>
</div>
<p>Where <code class="code docutils literal notranslate"><span class="pre">&lt;INPUT&gt;</span></code> represents the drawio file to parse and <code class="code docutils literal notranslate"><span class="pre">[ARGS]</span></code>
any combination of the commandline arguments that can be used with this tool.</p>
<div class="section" id="commandline-arguments">
<h2>Commandline Arguments<a class="headerlink" href="#commandline-arguments" title="Permalink to this headline">¶</a></h2>
<table border="1" class="colwidths-given docutils">
<colgroup>
<col width="18%" />
<col width="27%" />
<col width="55%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Short Flag</th>
<th class="head">Long Flag</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">-F</span></code></td>
<td><code class="code docutils literal notranslate"><span class="pre">--formalism</span></code></td>
<td>The formalism for which files must be generated. This argument is
required.</td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">-e</span></code></td>
<td><code class="code docutils literal notranslate"><span class="pre">--entry</span></code></td>
<td>The topmost class to use in the simulation. May be required for some
formalisms, where simulation is top-level dependent.</td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">t</span></code></td>
<td><code class="code docutils literal notranslate"><span class="pre">--time</span></code></td>
<td>Total simulation time to use. Should only be set for experiment
files. Defaults to <code class="code docutils literal notranslate"><span class="pre">10</span></code> (time-units). While this flag is meant
to indicate the total time, some formalisms may use this as the
allowed amount of simulation steps.</td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">-L</span></code></td>
<td><code class="code docutils literal notranslate"><span class="pre">--list</span></code></td>
<td>Lists the available formalisms that can be used.</td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">-s</span></code></td>
<td><code class="code docutils literal notranslate"><span class="pre">--skip</span></code></td>
<td>Sometimes a visual model has some “placeholders” for future classes.
By default, these are generated as well, even if no contents are given.
The <code class="code docutils literal notranslate"><span class="pre">--skip</span></code> flag changes this behaviour by skipping empty blocks
in the generation.</td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">-d</span></code></td>
<td><code class="code docutils literal notranslate"><span class="pre">--directory</span></code></td>
<td>The location where the files should be generated. Defaults to <code class="code docutils literal notranslate"><span class="pre">./</span></code>
(the current directory).</td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">-f</span></code></td>
<td><code class="code docutils literal notranslate"><span class="pre">--force</span></code></td>
<td>Some formalisms may mark certain files as “protected”. This is usually
done to prevent accidental removal of user code when programming
experiments. Hence, these files cannot be overwritten by the tool, unless
this flag is set.</td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">-a</span></code></td>
<td><code class="code docutils literal notranslate"><span class="pre">--all</span></code></td>
<td>Each formalism has their default set of files to be generated. However,
there may be some experimental or additional files that not all users
need. This flag allows the generation of <strong>all</strong> files of the formalism.</td>
</tr>
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">-v</span></code></td>
<td><code class="code docutils literal notranslate"><span class="pre">--verbose</span></code></td>
<td>Prints additional debugging information.</td>
</tr>
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">-E</span></code></td>
<td><code class="code docutils literal notranslate"><span class="pre">--enviroment</span></code></td>
<td>Occasionally, formalisms need other properties that can be set by the
user. This flag takes a comma-separated list of <code class="code docutils literal notranslate"><span class="pre">key=value</span></code> pairs
and applies them to the formalism specifics.</td>
</tr>
</tbody>
</table>
</div>
</div>


      </div>
      <div class="bottomnav" role="navigation" aria-label="bottom navigation">
      
        <p>
        «&#160;&#160;<a href="index.html">Welcome to DrawioConvert’s documentation!</a>
        &#160;&#160;::&#160;&#160;
        <a class="uplink" href="index.html">Contents</a>
        &#160;&#160;::&#160;&#160;
        <a href="formalisms/create.html">How To Create Custom Formalisms?</a>&#160;&#160;»
        </p>

      </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>