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-09 02:13:43 +01:00
parent cab339c556
commit a4839b8121
10 changed files with 285 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

36
lib/classes/Seeding.html
View file

@ -47,6 +47,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../other/usage.html">Beispiele</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">compLib</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="DoubleElimination.html">Double Elimination</a></li>
<li class="toctree-l2"><a class="reference internal" href="Encoder.html">Encoder</a></li>
<li class="toctree-l2"><a class="reference internal" href="IRSensor.html">Infrarot Sensoren</a></li>
<li class="toctree-l2"><a class="reference internal" href="Motor.html">Motoren</a></li>
@ -94,7 +95,40 @@
<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>
<dd></dd></dl>
<dd><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>
<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>
<dd class="field-odd"><p>Gibt entweder die Zahl 1 oder 2 zurück.</p>
</dd>
</dl>
</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>
<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>
<dd class="field-odd"><p>Eine Liste an Zahlen zwischen 10 und 13.</p>
</dd>
</dl>
</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>
<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>
<dd class="field-odd"><p>Eine Liste and Material Paaren.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
</section>