234 lines
12 KiB
HTML
234 lines
12 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) on Mon Jan 09 14:27:07 CET 2023 -->
|
|
<title>RobotControl</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-09">
|
|
<meta name="description" content="declaration: package: tpe.exceptions.roboter, interface: RobotControl">
|
|
<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/RobotControl.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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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> <a href="package-summary.html">tpe.exceptions.roboter</a></div>
|
|
<h1 title="Interface RobotControl" class="title">Interface RobotControl</h1>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Known Subinterfaces:</dt>
|
|
<dd><code><a href="Robot.html" title="interface in tpe.exceptions.roboter">Robot</a></code></dd>
|
|
</dl>
|
|
<dl class="notes">
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><code><a href="../../../Dom%C3%A4ne/C3PO.html" title="class in Domäne">C3PO</a></code>, <code><a href="../../../Dom%C3%A4ne/Nexus6.html" title="class in Domäne">Nexus6</a></code>, <code><a href="../../../Dom%C3%A4ne/R2D2.html" title="class in Domäne">R2D2</a></code>, <code><a href="../../../Dom%C3%A4ne/Roboter.html" title="class in Domäne">Roboter</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RobotControl</span></div>
|
|
<div class="block">Das Interface repräsentiert einen einfachen Roboter mit seinen Funktionen.
|
|
|
|
Jeder produzierte Roboter hat einen Namen, der vom Besteller frei gewählt
|
|
werden kann. Der Name bleibt über die gesamte Lebensdauer des Roboters
|
|
unveränderlich. Man kann einen Roboter jederzeit über die
|
|
<code>getName()</code>-Methode nach seinem Namen fragen.
|
|
|
|
Zusätzlich zum frei gewählten Namen, hat jeder Roboter noch eine
|
|
Seriennummer. Diese wird bei der Produktion festgelegt und hat einen vom
|
|
Roboter-Typ abhängigen Bereich möglicher Werte. Innerhalb des Bereiches wird
|
|
die Seriennummer zufällig vergeben. Die Seriennummer kann auch bei
|
|
ausgeschalteten Roboter über <code>getId()</code>gelesen werden.
|
|
|
|
Ein Roboter hat einen Hauptschalter, der mithilfe der
|
|
<code>triggerPowerSwitch()</code>-Methode bedient werden kann. Direkt nach
|
|
der Produktion ist der Roboter ausgeschaltet. Drückt man einmal auf den
|
|
Schalter, wird er eingeschaltet. Ein weiterer Druck schaltet ihn wieder aus, usw.
|
|
|
|
Die aktuelle Position des Hauptschalters kann man mit der Methode
|
|
<code>isPowerOn()</code> abfragen. Hierbei bedeutet <code>true</code>, dass
|
|
der Roboter eingeschaltet ist und <code>false</code>, dass er nicht
|
|
eingeschaltet ist.
|
|
|
|
Falls ein Fehler auftritt, kann der Nutzer des Roboters den letzten
|
|
aufgetretenen Fehler über eine Blackbox (Fehlerspeicher) auslesen. Dies
|
|
geschieht mithilfe der <code>getLastException()</code>-Methode. Der
|
|
Fehlerspeicher kann auch bei ausgeschaltetem Roboter benutzt werden. Gab es
|
|
noch keinen Fehler, ist der Fehlerspeicher leer (<code>null</code>).
|
|
|
|
Alle Methoden dieses Interfaces können auch auf einem Roboter aufgerufen
|
|
werden, der ausgeschaltet ist (d.h. wenn <code>isPowerOn()</code> == false).</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getId()" class="member-name-link">getId</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Gibt die ID (Seriennummer) des Roboters zurück.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="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-tab3"><code><a href="#getLastException()" class="member-name-link">getLastException</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Ruft die zuletzt aufgetretene Ausnahme aus der Blackbox ab.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><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-tab3">
|
|
<div class="block">Gibt den Namen des Roboter-Exemplars zurück.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isPowerOn()" class="member-name-link">isPowerOn</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Prüft ob der Roboter eingeschaltet ist.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#triggerPowerSwitch()" class="member-name-link">triggerPowerSwitch</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">Betätigen den An-/Ausschaltknopf.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="getId()">
|
|
<h3>getId</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getId</span>()</div>
|
|
<div class="block">Gibt die ID (Seriennummer) des Roboters zurück.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Eine eindeutige Identifikation in Form einer Zahl.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getName()">
|
|
<h3>getName</h3>
|
|
<div class="member-signature"><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> <span class="element-name">getName</span>()</div>
|
|
<div class="block">Gibt den Namen des Roboter-Exemplars zurück.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Der Name des Roboters.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="triggerPowerSwitch()">
|
|
<h3>triggerPowerSwitch</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">triggerPowerSwitch</span>()</div>
|
|
<div class="block">Betätigen den An-/Ausschaltknopf.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isPowerOn()">
|
|
<h3>isPowerOn</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isPowerOn</span>()</div>
|
|
<div class="block">Prüft ob der Roboter eingeschaltet ist.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd><code>true</code> bedeutet, dass der Roboter eingeschaltet ist,
|
|
<code>false</code>, dass er nicht eingeschaltet ist.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLastException()">
|
|
<h3>getLastException</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="exceptions/RobotException.html" title="class in tpe.exceptions.roboter.exceptions">RobotException</a></span> <span class="element-name">getLastException</span>()</div>
|
|
<div class="block">Ruft die zuletzt aufgetretene Ausnahme aus der Blackbox ab.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>zuletzt aufgetretene Ausnahme oder <code>null</code> falls noch
|
|
keine aufgetreten ist.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|