HolonTransformer.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_74) on Tue Sep 27 12:48:17 CEST 2016 -->
  6. <title>HolonTransformer</title>
  7. <meta name="date" content="2016-09-27">
  8. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="HolonTransformer";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/HolonTransformer.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../index-files/index-1.html">Index</a></li>
  47. <li><a href="../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../classes/HolonSwitch.html" title="class in classes"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../classes/IdCounter.html" title="class in classes"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../index.html?classes/HolonTransformer.html" target="_top">Frames</a></li>
  57. <li><a href="HolonTransformer.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">classes</div>
  96. <h2 title="Class HolonTransformer" class="title">Class HolonTransformer</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li><a href="../classes/AbstractCpsObject.html" title="class in classes">classes.AbstractCpsObject</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>classes.HolonTransformer</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <hr>
  116. <br>
  117. <pre>public class <span class="typeNameLabel">HolonTransformer</span>
  118. extends <a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a></pre>
  119. <div class="block">The class HolonTransformer represents a Transformer that transforms a flow to a lower flow.
  120. Transforemer are not used in the current State of the Project but could be used the future.</div>
  121. <dl>
  122. <dt><span class="simpleTagLabel">Author:</span></dt>
  123. <dd>Gruppe14</dd>
  124. </dl>
  125. </li>
  126. </ul>
  127. </div>
  128. <div class="summary">
  129. <ul class="blockList">
  130. <li class="blockList">
  131. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="constructor.summary">
  134. <!-- -->
  135. </a>
  136. <h3>Constructor Summary</h3>
  137. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  138. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  139. <tr>
  140. <th class="colOne" scope="col">Constructor and Description</th>
  141. </tr>
  142. <tr class="altColor">
  143. <td class="colOne"><code><span class="memberNameLink"><a href="../classes/HolonTransformer.html#HolonTransformer-classes.AbstractCpsObject-">HolonTransformer</a></span>(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a>&nbsp;obj)</code>
  144. <div class="block">Copy of the Object.</div>
  145. </td>
  146. </tr>
  147. <tr class="rowColor">
  148. <td class="colOne"><code><span class="memberNameLink"><a href="../classes/HolonTransformer.html#HolonTransformer-java.lang.String-">HolonTransformer</a></span>(java.lang.String&nbsp;objName)</code>
  149. <div class="block">Constructor Set type of object (Transformer), its transform ratio and the
  150. default name ("Transformer").</div>
  151. </td>
  152. </tr>
  153. </table>
  154. </li>
  155. </ul>
  156. <!-- ========== METHOD SUMMARY =========== -->
  157. <ul class="blockList">
  158. <li class="blockList"><a name="method.summary">
  159. <!-- -->
  160. </a>
  161. <h3>Method Summary</h3>
  162. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  163. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  164. <tr>
  165. <th class="colFirst" scope="col">Modifier and Type</th>
  166. <th class="colLast" scope="col">Method and Description</th>
  167. </tr>
  168. <tr id="i0" class="altColor">
  169. <td class="colFirst"><code>float</code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonTransformer.html#getOutput--">getOutput</a></span>()</code>
  171. <div class="block">Get the Output of the Transformer.</div>
  172. </td>
  173. </tr>
  174. <tr id="i1" class="rowColor">
  175. <td class="colFirst"><code>float</code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonTransformer.html#getTransformFixed--">getTransformFixed</a></span>()</code>
  177. <div class="block">Output the actual fixed Transform Value.</div>
  178. </td>
  179. </tr>
  180. <tr id="i2" class="altColor">
  181. <td class="colFirst"><code>float</code></td>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonTransformer.html#getTransformRatio--">getTransformRatio</a></span>()</code>
  183. <div class="block">Output the actual ratio of the transformer.</div>
  184. </td>
  185. </tr>
  186. <tr id="i3" class="rowColor">
  187. <td class="colFirst"><code>void</code></td>
  188. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonTransformer.html#setTransformFixed-float-">setTransformFixed</a></span>(float&nbsp;fixed)</code>
  189. <div class="block">Set fixed Transform Value.</div>
  190. </td>
  191. </tr>
  192. <tr id="i4" class="altColor">
  193. <td class="colFirst"><code>void</code></td>
  194. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonTransformer.html#setTransformRatio-float-">setTransformRatio</a></span>(float&nbsp;ratio)</code>
  195. <div class="block">Set transform ratio.</div>
  196. </td>
  197. </tr>
  198. </table>
  199. <ul class="blockList">
  200. <li class="blockList"><a name="methods.inherited.from.class.classes.AbstractCpsObject">
  201. <!-- -->
  202. </a>
  203. <h3>Methods inherited from class&nbsp;classes.<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a></h3>
  204. <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>
  205. </ul>
  206. <ul class="blockList">
  207. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  208. <!-- -->
  209. </a>
  210. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  211. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  212. </ul>
  213. </li>
  214. </ul>
  215. </li>
  216. </ul>
  217. </div>
  218. <div class="details">
  219. <ul class="blockList">
  220. <li class="blockList">
  221. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  222. <ul class="blockList">
  223. <li class="blockList"><a name="constructor.detail">
  224. <!-- -->
  225. </a>
  226. <h3>Constructor Detail</h3>
  227. <a name="HolonTransformer-java.lang.String-">
  228. <!-- -->
  229. </a>
  230. <ul class="blockList">
  231. <li class="blockList">
  232. <h4>HolonTransformer</h4>
  233. <pre>public&nbsp;HolonTransformer(java.lang.String&nbsp;objName)</pre>
  234. <div class="block">Constructor Set type of object (Transformer), its transform ratio and the
  235. default name ("Transformer").</div>
  236. <dl>
  237. <dt><span class="paramLabel">Parameters:</span></dt>
  238. <dd><code>objName</code> - name for the Object</dd>
  239. </dl>
  240. </li>
  241. </ul>
  242. <a name="HolonTransformer-classes.AbstractCpsObject-">
  243. <!-- -->
  244. </a>
  245. <ul class="blockListLast">
  246. <li class="blockList">
  247. <h4>HolonTransformer</h4>
  248. <pre>public&nbsp;HolonTransformer(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a>&nbsp;obj)</pre>
  249. <div class="block">Copy of the Object.</div>
  250. <dl>
  251. <dt><span class="paramLabel">Parameters:</span></dt>
  252. <dd><code>obj</code> - the Object to Copy</dd>
  253. </dl>
  254. </li>
  255. </ul>
  256. </li>
  257. </ul>
  258. <!-- ============ METHOD DETAIL ========== -->
  259. <ul class="blockList">
  260. <li class="blockList"><a name="method.detail">
  261. <!-- -->
  262. </a>
  263. <h3>Method Detail</h3>
  264. <a name="setTransformRatio-float-">
  265. <!-- -->
  266. </a>
  267. <ul class="blockList">
  268. <li class="blockList">
  269. <h4>setTransformRatio</h4>
  270. <pre>public&nbsp;void&nbsp;setTransformRatio(float&nbsp;ratio)</pre>
  271. <div class="block">Set transform ratio.</div>
  272. <dl>
  273. <dt><span class="paramLabel">Parameters:</span></dt>
  274. <dd><code>ratio</code> - desired ratio</dd>
  275. </dl>
  276. </li>
  277. </ul>
  278. <a name="getTransformRatio--">
  279. <!-- -->
  280. </a>
  281. <ul class="blockList">
  282. <li class="blockList">
  283. <h4>getTransformRatio</h4>
  284. <pre>public&nbsp;float&nbsp;getTransformRatio()</pre>
  285. <div class="block">Output the actual ratio of the transformer.</div>
  286. <dl>
  287. <dt><span class="returnLabel">Returns:</span></dt>
  288. <dd>actual ratio of the transformer</dd>
  289. </dl>
  290. </li>
  291. </ul>
  292. <a name="setTransformFixed-float-">
  293. <!-- -->
  294. </a>
  295. <ul class="blockList">
  296. <li class="blockList">
  297. <h4>setTransformFixed</h4>
  298. <pre>public&nbsp;void&nbsp;setTransformFixed(float&nbsp;fixed)</pre>
  299. <div class="block">Set fixed Transform Value.</div>
  300. <dl>
  301. <dt><span class="paramLabel">Parameters:</span></dt>
  302. <dd><code>fixed</code> - desired fixed Transform Value</dd>
  303. </dl>
  304. </li>
  305. </ul>
  306. <a name="getTransformFixed--">
  307. <!-- -->
  308. </a>
  309. <ul class="blockList">
  310. <li class="blockList">
  311. <h4>getTransformFixed</h4>
  312. <pre>public&nbsp;float&nbsp;getTransformFixed()</pre>
  313. <div class="block">Output the actual fixed Transform Value.</div>
  314. <dl>
  315. <dt><span class="returnLabel">Returns:</span></dt>
  316. <dd>actual fixed Transform Value</dd>
  317. </dl>
  318. </li>
  319. </ul>
  320. <a name="getOutput--">
  321. <!-- -->
  322. </a>
  323. <ul class="blockListLast">
  324. <li class="blockList">
  325. <h4>getOutput</h4>
  326. <pre>public&nbsp;float&nbsp;getOutput()</pre>
  327. <div class="block">Get the Output of the Transformer.</div>
  328. <dl>
  329. <dt><span class="returnLabel">Returns:</span></dt>
  330. <dd>The Output</dd>
  331. </dl>
  332. </li>
  333. </ul>
  334. </li>
  335. </ul>
  336. </li>
  337. </ul>
  338. </div>
  339. </div>
  340. <!-- ========= END OF CLASS DATA ========= -->
  341. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  342. <div class="bottomNav"><a name="navbar.bottom">
  343. <!-- -->
  344. </a>
  345. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  346. <a name="navbar.bottom.firstrow">
  347. <!-- -->
  348. </a>
  349. <ul class="navList" title="Navigation">
  350. <li><a href="../overview-summary.html">Overview</a></li>
  351. <li><a href="package-summary.html">Package</a></li>
  352. <li class="navBarCell1Rev">Class</li>
  353. <li><a href="class-use/HolonTransformer.html">Use</a></li>
  354. <li><a href="package-tree.html">Tree</a></li>
  355. <li><a href="../deprecated-list.html">Deprecated</a></li>
  356. <li><a href="../index-files/index-1.html">Index</a></li>
  357. <li><a href="../help-doc.html">Help</a></li>
  358. </ul>
  359. </div>
  360. <div class="subNav">
  361. <ul class="navList">
  362. <li><a href="../classes/HolonSwitch.html" title="class in classes"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  363. <li><a href="../classes/IdCounter.html" title="class in classes"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  364. </ul>
  365. <ul class="navList">
  366. <li><a href="../index.html?classes/HolonTransformer.html" target="_top">Frames</a></li>
  367. <li><a href="HolonTransformer.html" target="_top">No&nbsp;Frames</a></li>
  368. </ul>
  369. <ul class="navList" id="allclasses_navbar_bottom">
  370. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  371. </ul>
  372. <div>
  373. <script type="text/javascript"><!--
  374. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  375. if(window==top) {
  376. allClassesLink.style.display = "block";
  377. }
  378. else {
  379. allClassesLink.style.display = "none";
  380. }
  381. //-->
  382. </script>
  383. </div>
  384. <div>
  385. <ul class="subNavList">
  386. <li>Summary:&nbsp;</li>
  387. <li>Nested&nbsp;|&nbsp;</li>
  388. <li>Field&nbsp;|&nbsp;</li>
  389. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  390. <li><a href="#method.summary">Method</a></li>
  391. </ul>
  392. <ul class="subNavList">
  393. <li>Detail:&nbsp;</li>
  394. <li>Field&nbsp;|&nbsp;</li>
  395. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  396. <li><a href="#method.detail">Method</a></li>
  397. </ul>
  398. </div>
  399. <a name="skip.navbar.bottom">
  400. <!-- -->
  401. </a></div>
  402. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  403. </body>
  404. </html>