123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507 |
- <!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>CpsAPI</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="CpsAPI";
- }
- }
- 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};
- 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/CpsAPI.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="../api/CpsAlgorithm.html" title="interface in api"><span class="typeNameLink">Prev Class</span></a></li>
- <li>Next Class</li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?api/CpsAPI.html" target="_top">Frames</a></li>
- <li><a href="CpsAPI.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">api</div>
- <h2 title="Class CpsAPI" class="title">Class CpsAPI</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>api.CpsAPI</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <hr>
- <br>
- <pre>public class <span class="typeNameLabel">CpsAPI</span>
- extends java.lang.Object</pre>
- <div class="block">Api Class for the Cps Controller.</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="../api/CpsAPI.html#CpsAPI-ui.controller.Control-">CpsAPI</a></span>(<a href="../ui/controller/Control.html" title="class in ui.controller">Control</a> cont)</code>
- <div class="block">Constructor.</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="../api/CpsAPI.html#consolePrint-java.lang.String-">consolePrint</a></span>(java.lang.String text)</code>
- <div class="block">prints a given text on the console.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../api/CpsAPI.html#consolePrint-java.lang.String-java.awt.Color-int-boolean-boolean-boolean-">consolePrint</a></span>(java.lang.String text,
- java.awt.Color color,
- int p,
- boolean bold,
- boolean italic,
- boolean nl)</code>
- <div class="block">prints a given text on the console with more details.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>java.util.ArrayList<<a href="../classes/CpsEdge.html" title="class in classes">CpsEdge</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../api/CpsAPI.html#getAllEdges--">getAllEdges</a></span>()</code>
- <div class="block">Reutn all Edges on the Canvas in no specific order.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>java.util.ArrayList<<a href="../classes/HolonObject.html" title="class in classes">HolonObject</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../api/CpsAPI.html#getAllHolonObjects--">getAllHolonObjects</a></span>()</code>
- <div class="block">Return all Holon Objects on the Canvas in no specific order.</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>java.util.ArrayList<<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../api/CpsAPI.html#getAllObjOnCanvas--">getAllObjOnCanvas</a></span>()</code>
- <div class="block">Return all Objects on the Canvas in no Specific order.</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>java.util.ArrayList<<a href="../classes/HolonSwitch.html" title="class in classes">HolonSwitch</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../api/CpsAPI.html#getAllSwitches--">getAllSwitches</a></span>()</code>
- <div class="block">Return all Swtiches on the Canvas in no specific order.</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>java.util.ArrayList<<a href="../classes/SubNet.html" title="class in classes">SubNet</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../api/CpsAPI.html#getSubNets--">getSubNets</a></span>()</code>
- <div class="block">a SubNet contains all Components.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../api/CpsAPI.html#resetBorderColor-classes.AbstractCpsObject-">resetBorderColor</a></span>(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> toReset)</code>
- <div class="block">resets the bordercolor of given object to default (white).</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../api/CpsAPI.html#resetBorderColorForAll--">resetBorderColorForAll</a></span>()</code>
- <div class="block">resets the bordercolor for all objects on canvas.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../api/CpsAPI.html#setBorderColorForMultObj-java.util.ArrayList-java.awt.Color-">setBorderColorForMultObj</a></span>(java.util.ArrayList<<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a>> objects,
- java.awt.Color color)</code>
- <div class="block">changes the borderColor for all objects in List to given color.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../api/CpsAPI.html#setBorderColorForObj-classes.AbstractCpsObject-java.awt.Color-">setBorderColorForObj</a></span>(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> toChange,
- java.awt.Color color)</code>
- <div class="block">changes the border color of given object to given color.</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="CpsAPI-ui.controller.Control-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>CpsAPI</h4>
- <pre>public CpsAPI(<a href="../ui/controller/Control.html" title="class in ui.controller">Control</a> cont)</pre>
- <div class="block">Constructor.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>cont</code> - Controller</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="getSubNets--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSubNets</h4>
- <pre>public java.util.ArrayList<<a href="../classes/SubNet.html" title="class in classes">SubNet</a>> getSubNets()</pre>
- <div class="block">a SubNet contains all Components.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>all SubNets on Canvas</dd>
- </dl>
- </li>
- </ul>
- <a name="getAllObjOnCanvas--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getAllObjOnCanvas</h4>
- <pre>public java.util.ArrayList<<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a>> getAllObjOnCanvas()</pre>
- <div class="block">Return all Objects on the Canvas in no Specific order.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>all Objects on Canvas in no specific order</dd>
- </dl>
- </li>
- </ul>
- <a name="getAllEdges--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getAllEdges</h4>
- <pre>public java.util.ArrayList<<a href="../classes/CpsEdge.html" title="class in classes">CpsEdge</a>> getAllEdges()</pre>
- <div class="block">Reutn all Edges on the Canvas in no specific order.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>all Edges on Canvas</dd>
- </dl>
- </li>
- </ul>
- <a name="getAllSwitches--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getAllSwitches</h4>
- <pre>public java.util.ArrayList<<a href="../classes/HolonSwitch.html" title="class in classes">HolonSwitch</a>> getAllSwitches()</pre>
- <div class="block">Return all Swtiches on the Canvas in no specific order.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>all Switches on Canvas.</dd>
- </dl>
- </li>
- </ul>
- <a name="getAllHolonObjects--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getAllHolonObjects</h4>
- <pre>public java.util.ArrayList<<a href="../classes/HolonObject.html" title="class in classes">HolonObject</a>> getAllHolonObjects()</pre>
- <div class="block">Return all Holon Objects on the Canvas in no specific order.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>all Holon Objects</dd>
- </dl>
- </li>
- </ul>
- <a name="consolePrint-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>consolePrint</h4>
- <pre>public void consolePrint(java.lang.String text)</pre>
- <div class="block">prints a given text on the console.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>text</code> - Text</dd>
- </dl>
- </li>
- </ul>
- <a name="consolePrint-java.lang.String-java.awt.Color-int-boolean-boolean-boolean-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>consolePrint</h4>
- <pre>public void consolePrint(java.lang.String text,
- java.awt.Color color,
- int p,
- boolean bold,
- boolean italic,
- boolean nl)</pre>
- <div class="block">prints a given text on the console with more details.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>text</code> - the text that will be printed</dd>
- <dd><code>color</code> - the color the text will have</dd>
- <dd><code>p</code> - font size</dd>
- <dd><code>bold</code> - true or false</dd>
- <dd><code>italic</code> - true or false</dd>
- <dd><code>nl</code> - new line after text</dd>
- </dl>
- </li>
- </ul>
- <a name="setBorderColorForObj-classes.AbstractCpsObject-java.awt.Color-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setBorderColorForObj</h4>
- <pre>public void setBorderColorForObj(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> toChange,
- java.awt.Color color)</pre>
- <div class="block">changes the border color of given object to given color.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>toChange</code> - CpsObject</dd>
- <dd><code>color</code> - Color</dd>
- </dl>
- </li>
- </ul>
- <a name="setBorderColorForMultObj-java.util.ArrayList-java.awt.Color-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setBorderColorForMultObj</h4>
- <pre>public void setBorderColorForMultObj(java.util.ArrayList<<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a>> objects,
- java.awt.Color color)</pre>
- <div class="block">changes the borderColor for all objects in List to given color.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>objects</code> - AttayList of CpsObject</dd>
- <dd><code>color</code> - Color</dd>
- </dl>
- </li>
- </ul>
- <a name="resetBorderColor-classes.AbstractCpsObject-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>resetBorderColor</h4>
- <pre>public void resetBorderColor(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a> toReset)</pre>
- <div class="block">resets the bordercolor of given object to default (white).</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>toReset</code> - CpsObject</dd>
- </dl>
- </li>
- </ul>
- <a name="resetBorderColorForAll--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>resetBorderColorForAll</h4>
- <pre>public void resetBorderColorForAll()</pre>
- <div class="block">resets the bordercolor for all objects on canvas.</div>
- </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/CpsAPI.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="../api/CpsAlgorithm.html" title="interface in api"><span class="typeNameLink">Prev Class</span></a></li>
- <li>Next Class</li>
- </ul>
- <ul class="navList">
- <li><a href="../index.html?api/CpsAPI.html" target="_top">Frames</a></li>
- <li><a href="CpsAPI.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>
|