compAIR/compLIB
compAIR/compLIB
Archived
4
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update documentation

Browse source
This commit is contained in:
Joel Klimont 2022-11-18 16:46:58 +01:00
parent 64ff14b9b1
commit 75185f19b6
36 changed files with 14537 additions and 3800 deletions
Download patch file Download diff file Expand all files Collapse all files

187
lib/classes/Seeding.html
View file

@ -1,73 +1,32 @@
<!DOCTYPE html>
<html class="writer-html5" lang="de" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Seeding &mdash; CompLib 0.2.3 Dokumentation</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Seeding &mdash; CompLib 0.2.3 Dokumentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/sphinx_highlight.js"></script>
<script src="../../_static/translations.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Stichwortverzeichnis" href="../../genindex.html" />
<link rel="search" title="Suche" href="../../search.html" />
<link rel="next" title="Double Elimination" href="DoubleElimination.html" />
<link rel="prev" title="Infrarot Sensoren" href="IRSensor.html" />
</head>
<body class="wy-body-for-nav">
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html">
<img src="../../_static/compair-logo-white.svg" class="logo" alt="Logo"/>
<a href="../../index.html"><img src="../../_static/compair-logo-white.svg" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Dokumentation durchsuchen" />
@ -75,18 +34,7 @@
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../gettingStarted/index.html">Erste Schritte</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../software/installation.html">Installationsanweisungen</a></li>
@ -98,90 +46,50 @@
<li class="toctree-l2"><a class="reference internal" href="IRSensor.html">Infrarot Sensoren</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Seeding</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#dokumentation-des-seeding-moduls">Dokumentation des Seeding Moduls</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#compLib.Seeding.Gamestate"><code class="docutils literal notranslate"><span class="pre">Gamestate</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#beispiele">Beispiele</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="DoubleElimination.html">Double Elimination</a></li>
<li class="toctree-l2"><a class="reference internal" href="Opencv.html">Camera und OpenCV</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../other/hardware.html">Hardware</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">CompLib</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../index.html">compLib</a> &raquo;</li>
<li>Seeding</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/lib/classes/Seeding.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="seeding">
<span id="lib-seeding"></span><h1>Seeding<a class="headerlink" href="#seeding" title="Permalink to this heading"></a></h1>
<span id="lib-seeding"></span><h1>Seeding<a class="headerlink" href="#seeding" title="Link zu dieser Überschrift"></a></h1>
<div class="section" id="dokumentation-des-seeding-moduls">
<h2>Dokumentation des Seeding Moduls<a class="headerlink" href="#dokumentation-des-seeding-moduls" title="Permalink to this heading"></a></h2>
<h2>Dokumentation des Seeding Moduls<a class="headerlink" href="#dokumentation-des-seeding-moduls" title="Link zu dieser Überschrift"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="compLib.Seeding.Gamestate">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compLib.Seeding.</span></span><span class="sig-name descname"><span class="pre">Gamestate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Seeding.Gamestate" title="Link zu dieser Definition"></a></dt>
<dt id="compLib.Seeding.Gamestate">
<em class="property">class </em><code class="sig-prename descclassname">compLib.Seeding.</code><code class="sig-name descname">Gamestate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">seed</span><span class="p">:</span> <span class="n">int</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Seeding.Gamestate" title="Link zu dieser Definition"></a></dt>
<dd><p>Erstellt den Seeding „Gamestate“ für den angegebenen Seed.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameter</dt>
@ -189,8 +97,8 @@
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="compLib.Seeding.Gamestate.get_heuballen">
<span class="sig-name descname"><span class="pre">get_heuballen</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#compLib.Seeding.Gamestate.get_heuballen" title="Link zu dieser Definition"></a></dt>
<dt id="compLib.Seeding.Gamestate.get_heuballen">
<code class="sig-name descname">get_heuballen</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#compLib.Seeding.Gamestate.get_heuballen" title="Link zu dieser Definition"></a></dt>
<dd><p>Die Funktion gibt entweder die Zahl „1“ oder „2“ zurück. Wenn die Funktion „1“ zurückgibt, dann liegen die Heuballen auf den gelben Linien. Wenn die Funktion „2“ zurückgibt, dann liegen sie auf den blauen Flächen.</p>
<dl class="field-list simple">
<dt class="field-odd">Rückgabe</dt>
@ -200,8 +108,8 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="compLib.Seeding.Gamestate.get_logistic_plan">
<span class="sig-name descname"><span class="pre">get_logistic_plan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.Seeding.Gamestate.get_logistic_plan" title="Link zu dieser Definition"></a></dt>
<dt id="compLib.Seeding.Gamestate.get_logistic_plan">
<code class="sig-name descname">get_logistic_plan</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <span class="p">]</span><a class="headerlink" href="#compLib.Seeding.Gamestate.get_logistic_plan" title="Link zu dieser Definition"></a></dt>
<dd><p>Die Funktion gibt den „Logistik Plan“ zurück. Also die Reihenfolge, in welcher der Roboter die Logistik Zonen Abfahren muss, um die Pakete welche dort liegen zu sortieren.</p>
<dl class="field-list simple">
<dt class="field-odd">Rückgabe</dt>
@ -211,8 +119,8 @@
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="compLib.Seeding.Gamestate.get_material_deliveries">
<span class="sig-name descname"><span class="pre">get_material_deliveries</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.Seeding.Gamestate.get_material_deliveries" title="Link zu dieser Definition"></a></dt>
<dt id="compLib.Seeding.Gamestate.get_material_deliveries">
<code class="sig-name descname">get_material_deliveries</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; <span class="p">[</span><span class="p">]</span><span class="p">]</span><a class="headerlink" href="#compLib.Seeding.Gamestate.get_material_deliveries" title="Link zu dieser Definition"></a></dt>
<dd><p>Die Funktion gibt die einzelnen „Material Lieferungen“ zurück. Da der Roboter immer zwei Paare an Materialien anliefern muss, gibt die Funktion eine Liste an Material Paaren zurück. Die Materialien werden dabei durch ihre Zonen-ID representiert. Also Holz ist z.B. „0“ und die Ziegelsteine sind „3“.</p>
<dl class="field-list simple">
<dt class="field-odd">Rückgabe</dt>
@ -224,7 +132,7 @@
</dd></dl>
<div class="section" id="beispiele">
<h3>Beispiele<a class="headerlink" href="#beispiele" title="Permalink to this heading"></a></h3>
<h3>Beispiele<a class="headerlink" href="#beispiele" title="Link zu dieser Überschrift"></a></h3>
<div class="line-block">
<div class="line">In <code class="docutils literal notranslate"><span class="pre">Zeile</span> <span class="pre">1</span></code> wird das Seeding Modul importiert.</div>
<div class="line">In <code class="docutils literal notranslate"><span class="pre">Zeile</span> <span class="pre">2</span></code> definieren wir dann eine Variable, in der wir den „Seed“ des Gamestates den wir erstellen wollten speichern.</div>
@ -252,58 +160,33 @@
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="DoubleElimination.html" class="btn btn-neutral float-right" title="Double Elimination" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right"></span></a>
<a href="IRSensor.html" class="btn btn-neutral float-left" title="Infrarot Sensoren" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Zurück</a>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="IRSensor.html" class="btn btn-neutral float-left" title="Infrarot Sensoren" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
<a href="DoubleElimination.html" class="btn btn-neutral float-right" title="Double Elimination" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS)
</p>
<p>&#169; Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS).</p>
</div>
Erstellt mit <a href="http://sphinx-doc.org/">Sphinx</a> mit einem
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
bereitgestellt von <a href="https://readthedocs.org">Read the Docs</a>.
Erstellt mit <a href="https://www.sphinx-doc.org/">Sphinx</a> mit einem
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
bereitgestellt von <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</script>
</body>
</html>