<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="de"> <head> <!-- Generated by javadoc (1.8.0_74) on Tue Sep 27 12:48:17 CEST 2016 --> <title>HolonSwitch</title> <meta name="date" content="2016-09-27"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <script type="text/javascript" src="../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="HolonSwitch"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/HolonSwitch.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../deprecated-list.html">Deprecated</a></li> <li><a href="../index-files/index-1.html">Index</a></li> <li><a href="../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../classes/HolonObject.html" title="class in classes"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../classes/HolonTransformer.html" title="class in classes"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?classes/HolonSwitch.html" target="_top">Frames</a></li> <li><a href="HolonSwitch.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">classes</div> <h2 title="Class HolonSwitch" class="title">Class HolonSwitch</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../classes/AbstractCpsObject.html" title="class in classes">classes.AbstractCpsObject</a></li> <li> <ul class="inheritance"> <li>classes.HolonSwitch</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">HolonSwitch</span> extends <a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a></pre> <div class="block">The class HolonSwitch represents a Switch, which can be turned on and off.</div> <dl> <dt><span class="simpleTagLabel">Author:</span></dt> <dd>Gruppe14</dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#HolonSwitch-classes.AbstractCpsObject-">HolonSwitch</a></span>(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> obj)</code> <div class="block">Create a copy of an existing HolonSwitch.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#HolonSwitch-java.lang.String-">HolonSwitch</a></span>(java.lang.String objName)</code> <div class="block">Create a new HolonSwitch with the default name ("Switch"), a default value of automatic handle and active status.</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>boolean[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#getActiveAt--">getActiveAt</a></span>()</code> <div class="block">All values of the graph for the selected Switch (only auto-Mode) get the activeAt Array.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#getActiveManual--">getActiveManual</a></span>()</code> <div class="block">Returns the ManualState.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.util.LinkedList<java.awt.Point></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#getGraphPoints--">getGraphPoints</a></span>()</code> <div class="block">For automatic use only (throught the graph).</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#getManualMode--">getManualMode</a></span>()</code> <div class="block">Get manualmode state.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#getState--">getState</a></span>()</code> <div class="block">Overall status of the switch (manual or automatic mode).</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#getState-int-">getState</a></span>(int timeStep)</code> <div class="block">Getter for the status of the Switch at a given timestep.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#setActiveAt-boolean-">setActiveAt</a></span>(boolean active)</code> <div class="block">Set the value of the Switch.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#setAutoState-boolean-">setAutoState</a></span>(boolean state)</code> <div class="block">Set the state of the Switch to automatic.</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#setGraphPoints-java.util.LinkedList-">setGraphPoints</a></span>(java.util.LinkedList<java.awt.Point> points)</code> <div class="block">Set the values of the switch in the graph (auto. mode only).</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#setManualMode-boolean-">setManualMode</a></span>(boolean mode)</code> <div class="block">Set the overall value of the Switch (manual mode).</div> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#setManualState-boolean-">setManualState</a></span>(boolean state)</code> <div class="block">Change the state of the Switch to manual.</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonSwitch.html#switchState--">switchState</a></span>()</code> <div class="block">Calculates the state of the Switch.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.classes.AbstractCpsObject"> <!-- --> </a> <h3>Methods inherited from class classes.<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a></h3> <code><a href="../classes/AbstractCpsObject.html#addConnection-classes.CpsEdge-">addConnection</a>, <a href="../classes/AbstractCpsObject.html#addPseudoTag--">addPseudoTag</a>, <a href="../classes/AbstractCpsObject.html#addTag-int-">addTag</a>, <a href="../classes/AbstractCpsObject.html#getBorderColor--">getBorderColor</a>, <a href="../classes/AbstractCpsObject.html#getConnectedTo--">getConnectedTo</a>, <a href="../classes/AbstractCpsObject.html#getConnections--">getConnections</a>, <a href="../classes/AbstractCpsObject.html#getID--">getID</a>, <a href="../classes/AbstractCpsObject.html#getImage--">getImage</a>, <a href="../classes/AbstractCpsObject.html#getName--">getName</a>, <a href="../classes/AbstractCpsObject.html#getObjName--">getObjName</a>, <a href="../classes/AbstractCpsObject.html#getPosition--">getPosition</a>, <a href="../classes/AbstractCpsObject.html#getPseudoTags--">getPseudoTags</a>, <a href="../classes/AbstractCpsObject.html#getSav--">getSav</a>, <a href="../classes/AbstractCpsObject.html#getTag--">getTag</a>, <a href="../classes/AbstractCpsObject.html#resetTags--">resetTags</a>, <a href="../classes/AbstractCpsObject.html#setBorderColor-java.awt.Color-">setBorderColor</a>, <a href="../classes/AbstractCpsObject.html#setConnections-java.util.ArrayList-">setConnections</a>, <a href="../classes/AbstractCpsObject.html#setID-int-">setID</a>, <a href="../classes/AbstractCpsObject.html#setImage-java.lang.String-">setImage</a>, <a href="../classes/AbstractCpsObject.html#setName-java.lang.String-">setName</a>, <a href="../classes/AbstractCpsObject.html#setObjName-java.lang.String-">setObjName</a>, <a href="../classes/AbstractCpsObject.html#setPosition-int-int-">setPosition</a>, <a href="../classes/AbstractCpsObject.html#setPosition-classes.Position-">setPosition</a>, <a href="../classes/AbstractCpsObject.html#setPseudoTags-java.util.ArrayList-">setPseudoTags</a>, <a href="../classes/AbstractCpsObject.html#setSav-java.lang.String-">setSav</a>, <a href="../classes/AbstractCpsObject.html#setTags-java.util.ArrayList-">setTags</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="HolonSwitch-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>HolonSwitch</h4> <pre>public HolonSwitch(java.lang.String objName)</pre> <div class="block">Create a new HolonSwitch with the default name ("Switch"), a default value of automatic handle and active status.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>objName</code> - String</dd> </dl> </li> </ul> <a name="HolonSwitch-classes.AbstractCpsObject-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>HolonSwitch</h4> <pre>public HolonSwitch(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> obj)</pre> <div class="block">Create a copy of an existing HolonSwitch.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>obj</code> - the Object to copy</dd> </dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="switchState--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>switchState</h4> <pre>public void switchState()</pre> <div class="block">Calculates the state of the Switch.</div> </li> </ul> <a name="getState-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getState</h4> <pre>public boolean getState(int timeStep)</pre> <div class="block">Getter for the status of the Switch at a given timestep.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>timeStep</code> - int</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>state value</dd> </dl> </li> </ul> <a name="getState--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getState</h4> <pre>public boolean getState()</pre> <div class="block">Overall status of the switch (manual or automatic mode).</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>boolean the State</dd> </dl> </li> </ul> <a name="setManualState-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setManualState</h4> <pre>public void setManualState(boolean state)</pre> <div class="block">Change the state of the Switch to manual.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>state</code> - the State</dd> </dl> </li> </ul> <a name="setAutoState-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setAutoState</h4> <pre>public void setAutoState(boolean state)</pre> <div class="block">Set the state of the Switch to automatic.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>state</code> - the State</dd> </dl> </li> </ul> <a name="getGraphPoints--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getGraphPoints</h4> <pre>public java.util.LinkedList<java.awt.Point> getGraphPoints()</pre> <div class="block">For automatic use only (throught the graph).</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the Graph Points</dd> </dl> </li> </ul> <a name="setGraphPoints-java.util.LinkedList-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setGraphPoints</h4> <pre>public void setGraphPoints(java.util.LinkedList<java.awt.Point> points)</pre> <div class="block">Set the values of the switch in the graph (auto. mode only).</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>points</code> - the Graph points</dd> </dl> </li> </ul> <a name="getActiveAt--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getActiveAt</h4> <pre>public boolean[] getActiveAt()</pre> <div class="block">All values of the graph for the selected Switch (only auto-Mode) get the activeAt Array.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>boolean[] the States of each Iteration</dd> </dl> </li> </ul> <a name="getActiveManual--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getActiveManual</h4> <pre>public boolean getActiveManual()</pre> <div class="block">Returns the ManualState.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>boolean Manual State</dd> </dl> </li> </ul> <a name="setActiveAt-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setActiveAt</h4> <pre>public void setActiveAt(boolean active)</pre> <div class="block">Set the value of the Switch.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>active</code> - the default value</dd> </dl> </li> </ul> <a name="setManualMode-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setManualMode</h4> <pre>public void setManualMode(boolean mode)</pre> <div class="block">Set the overall value of the Switch (manual mode).</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>mode</code> - the mode (boolean)</dd> </dl> </li> </ul> <a name="getManualMode--"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getManualMode</h4> <pre>public boolean getManualMode()</pre> <div class="block">Get manualmode state.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>boolean manual mode state</dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/HolonSwitch.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../deprecated-list.html">Deprecated</a></li> <li><a href="../index-files/index-1.html">Index</a></li> <li><a href="../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../classes/HolonObject.html" title="class in classes"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../classes/HolonTransformer.html" title="class in classes"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?classes/HolonSwitch.html" target="_top">Frames</a></li> <li><a href="HolonSwitch.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>