<!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>CpsEdge</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="CpsEdge"; } } 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,"i12":10,"i13":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/CpsEdge.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/Category.html" title="class in classes"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../classes/CpsNode.html" title="class in classes"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?classes/CpsEdge.html" target="_top">Frames</a></li> <li><a href="CpsEdge.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 CpsEdge" class="title">Class CpsEdge</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>classes.CpsEdge</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">CpsEdge</span> extends java.lang.Object</pre> <div class="block">The class "CpsEdge" represents the connections on the GUI. Each connection contains a max. capacity, a flow, a status (isWorking), tags (for internal use of electricity flow), source and destination</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/CpsEdge.html#CpsEdge-classes.AbstractCpsObject-classes.AbstractCpsObject-">CpsEdge</a></span>(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> a, <a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> b)</code> <div class="block">Constructor without max. capacity (by default as 100)</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#CpsEdge-classes.AbstractCpsObject-classes.AbstractCpsObject-float-">CpsEdge</a></span>(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> a, <a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> b, float maxCap)</code> <div class="block">Constructor with a user-defined max. capacity</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>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#addTag-int-">addTag</a></span>(int tag)</code> <div class="block">Add a new tag to the ArrayList.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#calculateState-boolean-">calculateState</a></span>(boolean simMode)</code> <div class="block">Calculates the state of the edge (see description of isWorking).</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#getA--">getA</a></span>()</code> <div class="block">Getter for the Source.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#getB--">getB</a></span>()</code> <div class="block">Getter for the destination.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>float</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#getCapacity--">getCapacity</a></span>()</code> <div class="block">Getter for the max. capacity</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>float</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#getFlow--">getFlow</a></span>()</code> <div class="block">Getter fot the current flow.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#getState--">getState</a></span>()</code> <div class="block">Getter for the status.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>java.util.ArrayList<java.lang.Integer></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#getTags--">getTags</a></span>()</code> <div class="block">Getter for the ArrayList of tags.</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/CpsEdge.html#setA-classes.AbstractCpsObject-">setA</a></span>(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> a)</code> <div class="block">Set the Source to a new one.</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/CpsEdge.html#setB-classes.AbstractCpsObject-">setB</a></span>(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> b)</code> <div class="block">Set the Destination to a new one.</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/CpsEdge.html#setCapacity-float-">setCapacity</a></span>(float cap)</code> <div class="block">Setter for the max. capacity</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/CpsEdge.html#setFlow-float-">setFlow</a></span>(float flow)</code> <div class="block">Set the flow into a new one.</div> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#setState-boolean-">setState</a></span>(boolean state)</code> <div class="block">Set the state manually to a new one.</div> </td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../classes/CpsEdge.html#setTags-java.util.ArrayList-">setTags</a></span>(java.util.ArrayList<java.lang.Integer> tags)</code> <div class="block">set the tags into a new set of tags.</div> </td> </tr> </table> <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="CpsEdge-classes.AbstractCpsObject-classes.AbstractCpsObject-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>CpsEdge</h4> <pre>public CpsEdge(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> a, <a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> b)</pre> <div class="block">Constructor without max. capacity (by default as 100)</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>a</code> - Source</dd> <dd><code>b</code> - Destination</dd> </dl> </li> </ul> <a name="CpsEdge-classes.AbstractCpsObject-classes.AbstractCpsObject-float-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>CpsEdge</h4> <pre>public CpsEdge(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> a, <a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> b, float maxCap)</pre> <div class="block">Constructor with a user-defined max. capacity</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>a</code> - Source</dd> <dd><code>b</code> - Destination</dd> <dd><code>maxCap</code> - Maximum Capacity</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="getCapacity--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCapacity</h4> <pre>public float getCapacity()</pre> <div class="block">Getter for the max. capacity</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the capacity</dd> </dl> </li> </ul> <a name="setCapacity-float-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setCapacity</h4> <pre>public void setCapacity(float cap)</pre> <div class="block">Setter for the max. capacity</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>cap</code> - the Capacity to set</dd> </dl> </li> </ul> <a name="getFlow--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getFlow</h4> <pre>public float getFlow()</pre> <div class="block">Getter fot the current flow.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the flow</dd> </dl> </li> </ul> <a name="setFlow-float-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setFlow</h4> <pre>public void setFlow(float flow)</pre> <div class="block">Set the flow into a new one.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>flow</code> - the flow to set</dd> </dl> </li> </ul> <a name="calculateState-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>calculateState</h4> <pre>public void calculateState(boolean simMode)</pre> <div class="block">Calculates the state of the edge (see description of isWorking).</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>simMode</code> - Simulation Mode</dd> </dl> </li> </ul> <a name="getA--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getA</h4> <pre>public <a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> getA()</pre> <div class="block">Getter for the Source.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the a</dd> </dl> </li> </ul> <a name="setA-classes.AbstractCpsObject-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setA</h4> <pre>public void setA(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> a)</pre> <div class="block">Set the Source to a new one.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>a</code> - the a to set</dd> </dl> </li> </ul> <a name="getB--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getB</h4> <pre>public <a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> getB()</pre> <div class="block">Getter for the destination.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the b</dd> </dl> </li> </ul> <a name="setB-classes.AbstractCpsObject-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setB</h4> <pre>public void setB(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> b)</pre> <div class="block">Set the Destination to a new one.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>b</code> - the b to set</dd> </dl> </li> </ul> <a name="setState-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setState</h4> <pre>public void setState(boolean state)</pre> <div class="block">Set the state manually to a new one.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>state</code> - the state</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">Getter for the status.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the state</dd> </dl> </li> </ul> <a name="setTags-java.util.ArrayList-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setTags</h4> <pre>public void setTags(java.util.ArrayList<java.lang.Integer> tags)</pre> <div class="block">set the tags into a new set of tags.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>tags</code> - tags for this edge</dd> </dl> </li> </ul> <a name="getTags--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTags</h4> <pre>public java.util.ArrayList<java.lang.Integer> getTags()</pre> <div class="block">Getter for the ArrayList of tags.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>tags tags for this edge</dd> </dl> </li> </ul> <a name="addTag-int-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>addTag</h4> <pre>public void addTag(int tag)</pre> <div class="block">Add a new tag to the ArrayList.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>tag</code> - tag for the ArrayList</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/CpsEdge.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/Category.html" title="class in classes"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../classes/CpsNode.html" title="class in classes"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?classes/CpsEdge.html" target="_top">Frames</a></li> <li><a href="CpsEdge.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>