2122158
/
PR2-Roboterfabrik
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
PR2-Roboterfabrik/Roboterfabrik/doc/Domäne/RobotFactory.html

355 lines
22 KiB
HTML
Raw Normal View History

Javadoc für RobotFactory geschrieben
2023-01-07 21:51:09 +01:00
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Sat Jan 07 21:50:47 CET 2023 -->
<title>RobotFactory</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-01-07">
<meta name="description" content="declaration: package: Domäne, class: RobotFactory">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/RobotFactory.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-files/index-1.html">Index</a></li>
<li><a href="../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">Domäne</a></div>
<h1 title="Class RobotFactory" class="title">Class RobotFactory</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">Domäne.RobotFactory</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RobotFactory</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Factory-Klasse für R2D2 und C3PO</div>
<dl class="notes">
<dt>Author:</dt>
<dd>Kai-Niklas Dippold</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">RobotFactory</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color">
<div class="block">Benennt die RobotFactory und setzt Nexus-Roboter "Pris" ins Roboterlager</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addRobot(Dom%C3%A4ne.RobotType,java.lang.String)" class="member-name-link">addRobot</a><wbr>(<a href="RobotType.html" title="enum class in Domäne">RobotType</a>&nbsp;robotType,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Erstellt neue Roboter nach Anforderungen, speichert diese im Roboterlager und
gibt die Id des erstellten Roboters zurück</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#aufrufSpeakAndThink(int,int%5B%5D)" class="member-name-link">aufrufSpeakAndThink</a><wbr>(int&nbsp;id,
int[]&nbsp;zahlen)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Ruft die Methoden think() und speak() eines Roboters auf und gibt dessen
Ausgabe wieder.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#datenDesRoboters(int)" class="member-name-link">datenDesRoboters</a><wbr>(int&nbsp;id)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt die Daten eines Roboters wieder</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Roboter.html" title="class in Domäne">Roboter</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findeRoboter(int)" class="member-name-link">findeRoboter</a><wbr>(int&nbsp;id)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Duchsucht das Roboterlager nach einem bestimmten Roboter</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt den Namen der RobotFactory zurück.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRoboterLagerSize()" class="member-name-link">getRoboterLagerSize</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt die Größe des Roboterlagers an.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#istDieserRoboterDa(int)" class="member-name-link">istDieserRoboterDa</a><wbr>(int&nbsp;id)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Überprüft ob das Lager einen bestimmten Roboter enthält.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../tpe/exceptions/roboter/exceptions/RobotException.html" title="class in tpe.exceptions.roboter.exceptions">RobotException</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#letzterFehler(int)" class="member-name-link">letzterFehler</a><wbr>(int&nbsp;id)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt den letzten Fehler zurück, auf den der Roboter gestoßen ist</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#roboterZustand(int)" class="member-name-link">roboterZustand</a><wbr>(int&nbsp;id)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Prüft ob ein Roboter ein- oder ausgeschaltet ist</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#schalterAnAus(int)" class="member-name-link">schalterAnAus</a><wbr>(int&nbsp;id)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Schaltet einen Roboter ein wenn er ausgeschaltet ist und schaltet ihn aus
wenn er eingeschaltet ist</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String)">
<h3>RobotFactory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RobotFactory</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Benennt die RobotFactory und setzt Nexus-Roboter "Pris" ins Roboterlager</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - Name der RobotFactory</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="addRobot(Domäne.RobotType,java.lang.String)">
<h3>addRobot</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">addRobot</span><wbr><span class="parameters">(<a href="RobotType.html" title="enum class in Domäne">RobotType</a>&nbsp;robotType,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Erstellt neue Roboter nach Anforderungen, speichert diese im Roboterlager und
gibt die Id des erstellten Roboters zurück</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>robotType</code> - entweder R2D2 oder C3PO</dd>
<dd><code>name</code> - Name des Roboters</dd>
<dt>Returns:</dt>
<dd>Gibt die ID des erstellten Roboters zurück.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getName()">
<h3>getName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getName</span>()</div>
<div class="block">Gibt den Namen der RobotFactory zurück.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Name der RobotFactory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="findeRoboter(int)">
<h3>findeRoboter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Roboter.html" title="class in Domäne">Roboter</a></span>&nbsp;<span class="element-name">findeRoboter</span><wbr><span class="parameters">(int&nbsp;id)</span></div>
<div class="block">Duchsucht das Roboterlager nach einem bestimmten Roboter</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - Id des Roboters</dd>
<dt>Returns:</dt>
<dd>Instanz des Roboters mit der gefragten Id</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="roboterZustand(int)">
<h3>roboterZustand</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">roboterZustand</span><wbr><span class="parameters">(int&nbsp;id)</span></div>
<div class="block">Prüft ob ein Roboter ein- oder ausgeschaltet ist</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - Id des Roboters</dd>
<dt>Returns:</dt>
<dd>Zustand des Roboters</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="schalterAnAus(int)">
<h3>schalterAnAus</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">schalterAnAus</span><wbr><span class="parameters">(int&nbsp;id)</span></div>
<div class="block">Schaltet einen Roboter ein wenn er ausgeschaltet ist und schaltet ihn aus
wenn er eingeschaltet ist</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - Id des Roboters</dd>
<dt>Returns:</dt>
<dd>Zustand des Roboters</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="aufrufSpeakAndThink(int,int[])">
<h3>aufrufSpeakAndThink</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">aufrufSpeakAndThink</span><wbr><span class="parameters">(int&nbsp;id,
int[]&nbsp;zahlen)</span>
throws <span class="exceptions"><a href="../tpe/exceptions/roboter/exceptions/RobotException.html" title="class in tpe.exceptions.roboter.exceptions">RobotException</a></span></div>
<div class="block">Ruft die Methoden think() und speak() eines Roboters auf und gibt dessen
Ausgabe wieder.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - Id des Roboters</dd>
<dd><code>zahlen</code> - Int-Array</dd>
<dt>Returns:</dt>
<dd>String mit dem Inhalt des gegebenen Arrays, nachdem es von dem
Roboter sortiert wurde.</dd>
<dt>Throws:</dt>
<dd><code><a href="../tpe/exceptions/roboter/exceptions/RobotException.html" title="class in tpe.exceptions.roboter.exceptions">RobotException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="letzterFehler(int)">
<h3>letzterFehler</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../tpe/exceptions/roboter/exceptions/RobotException.html" title="class in tpe.exceptions.roboter.exceptions">RobotException</a></span>&nbsp;<span class="element-name">letzterFehler</span><wbr><span class="parameters">(int&nbsp;id)</span></div>
<div class="block">Gibt den letzten Fehler zurück, auf den der Roboter gestoßen ist</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - Id des Roboters</dd>
<dt>Returns:</dt>
<dd>Die RobotException welche im Roboter gespeichert ist</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="datenDesRoboters(int)">
<h3>datenDesRoboters</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">datenDesRoboters</span><wbr><span class="parameters">(int&nbsp;id)</span></div>
<div class="block">Gibt die Daten eines Roboters wieder</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - Id des Roboters</dd>
<dt>Returns:</dt>
<dd>String mit Typ, Namen und Id des Roboters</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getRoboterLagerSize()">
<h3>getRoboterLagerSize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getRoboterLagerSize</span>()</div>
<div class="block">Gibt die Größe des Roboterlagers an.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Größe des Roboterlagers</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="istDieserRoboterDa(int)">
<h3>istDieserRoboterDa</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">istDieserRoboterDa</span><wbr><span class="parameters">(int&nbsp;id)</span></div>
<div class="block">Überprüft ob das Lager einen bestimmten Roboter enthält.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>id</code> - Id des Roboters</dd>
<dt>Returns:</dt>
<dd>true oder false je nachdem ob der Roboter im Lager vorhanden ist</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>