Update documentation
This commit is contained in:
Joel Klimont
parent
7cd41068fc
commit
e289671c82
11 changed files with 93 additions and 242 deletions
|
|
@ -20,9 +20,7 @@
|
|||
<script src="../../_static/translations.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="Encoder" href="Encoder.html" />
|
||||
<link rel="prev" title="compLib" href="../index.html" />
|
||||
<link rel="search" title="Suche" href="../../search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
|
@ -41,26 +39,12 @@
|
|||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<ul class="current">
|
||||
<ul>
|
||||
<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>
|
||||
<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 current"><a class="current reference internal" href="#">Double Elimination</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#dokumentation-der-klasse">Dokumentation der Klasse</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#compLib.DoubleElimination.Position"><code class="docutils literal notranslate"><span class="pre">Position</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#compLib.DoubleElimination.DoubleElim"><code class="docutils literal notranslate"><span class="pre">DoubleElim</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Seeding.html">Seeding</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../index.html">compLib</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../other/hardware.html">Hardware</a></li>
|
||||
</ul>
|
||||
|
||||
|
|
@ -78,7 +62,6 @@
|
|||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../../index.html" class="icon icon-home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="../index.html">compLib</a></li>
|
||||
<li class="breadcrumb-item active">Double Elimination</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="../../_sources/lib/classes/DoubleElimination.rst.txt" rel="nofollow"> Quelltext anzeigen</a>
|
||||
|
|
@ -91,12 +74,21 @@
|
|||
|
||||
<section id="double-elimination">
|
||||
<span id="lib-doubleelim"></span><h1>Double Elimination<a class="headerlink" href="#double-elimination" title="Permalink to this heading"></a></h1>
|
||||
<section id="dokumentation-der-klasse">
|
||||
<h2>Dokumentation der Klasse<a class="headerlink" href="#dokumentation-der-klasse" title="Permalink to this heading"></a></h2>
|
||||
<section id="dokumentation-des-double-elimination-moduls">
|
||||
<h2>Dokumentation des Double Elimination Moduls<a class="headerlink" href="#dokumentation-des-double-elimination-moduls" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="compLib.DoubleElimination.Position">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">compLib.DoubleElimination.</span></span><span class="sig-name descname"><span class="pre">Position</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">degrees</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.DoubleElimination.Position" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Datenstruktur, welche eine Position representiert.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Variablen</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>x</strong> – X Position in Centimeter</p></li>
|
||||
<li><p><strong>y</strong> – Y Position in Centimeter</p></li>
|
||||
<li><p><strong>degrees</strong> – Rotation in Grad von -180 bis 180</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
|
|
@ -106,41 +98,71 @@
|
|||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim.get_goal">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_goal</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><span class="pre">Position</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim.get_goal" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Makes the /api/getGoal call to the api.
|
||||
:return: A Position object with x and y coordinates of the goal, rotation is always -1
|
||||
:rtype: Tuple[Position, int]</p>
|
||||
<dd><p>Führt den /api/getGoal Aufruf an die API aus.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Rückgabe</dt>
|
||||
<dd class="field-odd"><p>Ein Objekt der Klasse <a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><code class="xref py py-class docutils literal notranslate"><span class="pre">Position</span></code></a> mit der Position des Ziels relativ zum eigenen Roboter und der Status Code</p>
|
||||
</dd>
|
||||
<dt class="field-even">Rückgabetyp</dt>
|
||||
<dd class="field-even"><p>Tuple[<a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position">Position</a>, int]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim.get_items">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_items</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim.get_items" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Makes the /api/getItems call to the api.
|
||||
:return: A list will all items currently on the game field. Items are dictionaries that look like: {„id“: 0, „x“: 0, „y“: 0}
|
||||
:rtype: Tuple[List[Dict], int]</p>
|
||||
<dd><p>Führt den /api/getItems Aufruf an die API aus.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Rückgabe</dt>
|
||||
<dd class="field-odd"><p>Eine Liste aller Items, die sich derzeit auf dem Spielfeld befinden. Items sind „dictionaries“, die wie folgt aussehen: {„id“: 0, „x“: 0, „y“: 0}</p>
|
||||
</dd>
|
||||
<dt class="field-even">Rückgabetyp</dt>
|
||||
<dd class="field-even"><p>Tuple[List[Dict], int]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim.get_opponent">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_opponent</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><span class="pre">Position</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim.get_opponent" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Makes the /api/getOp call to the api.
|
||||
:return: A Position object with opponents robot position
|
||||
:rtype: Tuple[Position, int]</p>
|
||||
<dd><p>Führt den /api/getOp Aufruf an die API aus.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Rückgabe</dt>
|
||||
<dd class="field-odd"><p>Ein Objekt der Klasse <a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><code class="xref py py-class docutils literal notranslate"><span class="pre">Position</span></code></a> mit der Position des gegnerischen Roboters relativ zum eigenen Roboter und der Status Code</p>
|
||||
</dd>
|
||||
<dt class="field-even">Rückgabetyp</dt>
|
||||
<dd class="field-even"><p>Tuple[<a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position">Position</a>, int]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim.get_pos">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_pos</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><span class="pre">Position</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim.get_pos" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Führt den /api/getPos Aufruf an die API aus.
|
||||
:return: Ein Objekt der Klasse <a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><code class="xref py py-class docutils literal notranslate"><span class="pre">Position</span></code></a> mit der Position des Roboters und der Status Code
|
||||
:rtype: Tuple[Position, int]</p>
|
||||
<dd><p>Führt den /api/getPos Aufruf an die API aus.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Rückgabe</dt>
|
||||
<dd class="field-odd"><p>Ein Objekt der Klasse <a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position"><code class="xref py py-class docutils literal notranslate"><span class="pre">Position</span></code></a> mit der Position des Roboters und der Status Code</p>
|
||||
</dd>
|
||||
<dt class="field-even">Rückgabetyp</dt>
|
||||
<dd class="field-even"><p>Tuple[<a class="reference internal" href="#compLib.DoubleElimination.Position" title="compLib.DoubleElimination.Position">Position</a>, int]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim.get_scores">
|
||||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_scores</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim.get_scores" title="Link zu dieser Definition"></a></dt>
|
||||
<dd><p>Makes the /api/getScores call to the api.
|
||||
:return: A dictionary with all scores included like: {„self“:2,“opponent“:0}
|
||||
:rtype: Tuple[Dict, int]</p>
|
||||
<dd><p>Führt den /api/getScores Aufruf an die API aus.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Rückgabe</dt>
|
||||
<dd class="field-odd"><p>Ein „dictionary“ mit dem eignen Score und dem des Gegners: {„self“:2,“opponent“:0}</p>
|
||||
</dd>
|
||||
<dt class="field-even">Rückgabetyp</dt>
|
||||
<dd class="field-even"><p>Tuple[Dict, int]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -151,10 +173,7 @@
|
|||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="../index.html" class="btn btn-neutral float-left" title="compLib" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Zurück</a>
|
||||
<a href="Encoder.html" class="btn btn-neutral float-right" title="Encoder" accesskey="n" rel="next">Weiter <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<hr/>
|
||||
|
||||
|
|
|
|||
Reference in a new issue