182 lines
No EOL
13 KiB
HTML
182 lines
No EOL
13 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="de" >
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Double Elimination — CompLib 0.2.3 Dokumentation</title>
|
|
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
|
<!--[if lt IE 9]>
|
|
<script src="../../_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script data-url_root="../../" id="documentation_options" 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 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" />
|
|
</head>
|
|
|
|
<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>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Dokumentation durchsuchen" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</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>
|
|
<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="../../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="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="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>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<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>
|
|
<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>
|
|
</dd></dl>
|
|
|
|
<dl class="py class">
|
|
<dt class="sig sig-object py" id="compLib.DoubleElimination.DoubleElim">
|
|
<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">DoubleElim</span></span><a class="headerlink" href="#compLib.DoubleElimination.DoubleElim" title="Link zu dieser Definition"></a></dt>
|
|
<dd><p>Klasse für die Kommunikation mit Double Elimination Api</p>
|
|
<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></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></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></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></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></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</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>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2022, Verein zur Förderung von Wissenschaft und Technik an Schulen (F-WuTS).</p>
|
|
</div>
|
|
|
|
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>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |