HolonElement.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743
  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>HolonElement</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="HolonElement";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. 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,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":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/HolonElement.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/CpsNode.html" title="class in classes"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../classes/HolonObject.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/HolonElement.html" target="_top">Frames</a></li>
  57. <li><a href="HolonElement.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 HolonElement" class="title">Class HolonElement</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>classes.HolonElement</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <hr>
  111. <br>
  112. <pre>public class <span class="typeNameLabel">HolonElement</span>
  113. extends java.lang.Object</pre>
  114. <div class="block">The class "HolonElement" represents any possible element that can be added to
  115. a CpsObject (such as TV (consumer) or any energy source/producer).</div>
  116. <dl>
  117. <dt><span class="simpleTagLabel">Author:</span></dt>
  118. <dd>Gruppe14</dd>
  119. </dl>
  120. </li>
  121. </ul>
  122. </div>
  123. <div class="summary">
  124. <ul class="blockList">
  125. <li class="blockList">
  126. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  127. <ul class="blockList">
  128. <li class="blockList"><a name="constructor.summary">
  129. <!-- -->
  130. </a>
  131. <h3>Constructor Summary</h3>
  132. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  133. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  134. <tr>
  135. <th class="colOne" scope="col">Constructor and Description</th>
  136. </tr>
  137. <tr class="altColor">
  138. <td class="colOne"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#HolonElement-classes.HolonElement-">HolonElement</a></span>(<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&nbsp;element)</code>
  139. <div class="block">Create a copy of the HolonElement given each one a new ID.</div>
  140. </td>
  141. </tr>
  142. <tr class="rowColor">
  143. <td class="colOne"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#HolonElement-java.lang.String-int-float-">HolonElement</a></span>(java.lang.String&nbsp;eleName,
  144. int&nbsp;amount,
  145. float&nbsp;energy)</code>
  146. <div class="block">Create a new HolonElement with a user-defined name, amount of the same
  147. element and energy per element.</div>
  148. </td>
  149. </tr>
  150. </table>
  151. </li>
  152. </ul>
  153. <!-- ========== METHOD SUMMARY =========== -->
  154. <ul class="blockList">
  155. <li class="blockList"><a name="method.summary">
  156. <!-- -->
  157. </a>
  158. <h3>Method Summary</h3>
  159. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  160. <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>
  161. <tr>
  162. <th class="colFirst" scope="col">Modifier and Type</th>
  163. <th class="colLast" scope="col">Method and Description</th>
  164. </tr>
  165. <tr id="i0" class="altColor">
  166. <td class="colFirst"><code>boolean</code></td>
  167. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getActive--">getActive</a></span>()</code>
  168. <div class="block">Get the Status of the Element (see description of variables).</div>
  169. </td>
  170. </tr>
  171. <tr id="i1" class="rowColor">
  172. <td class="colFirst"><code>int</code></td>
  173. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getAmount--">getAmount</a></span>()</code>
  174. <div class="block">Get the actual amount of Elements in the selected Object.</div>
  175. </td>
  176. </tr>
  177. <tr id="i2" class="altColor">
  178. <td class="colFirst"><code>java.lang.String</code></td>
  179. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getEleName--">getEleName</a></span>()</code>
  180. <div class="block">Get the user-defined Name.</div>
  181. </td>
  182. </tr>
  183. <tr id="i3" class="rowColor">
  184. <td class="colFirst"><code>float</code></td>
  185. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getEnergy--">getEnergy</a></span>()</code>
  186. <div class="block">Get the energy value of the selected Element.</div>
  187. </td>
  188. </tr>
  189. <tr id="i4" class="altColor">
  190. <td class="colFirst"><code>float[]</code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getEnergyAt--">getEnergyAt</a></span>()</code>
  192. <div class="block">Get the Array of energy (100 values).</div>
  193. </td>
  194. </tr>
  195. <tr id="i5" class="rowColor">
  196. <td class="colFirst"><code>java.util.LinkedList&lt;java.awt.Point&gt;</code></td>
  197. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getGraphPoints--">getGraphPoints</a></span>()</code>
  198. <div class="block">Get the points (values) in the graph.</div>
  199. </td>
  200. </tr>
  201. <tr id="i6" class="altColor">
  202. <td class="colFirst"><code>int</code></td>
  203. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getId--">getId</a></span>()</code>
  204. <div class="block">Get the Id of the selected HolonElement.</div>
  205. </td>
  206. </tr>
  207. <tr id="i7" class="rowColor">
  208. <td class="colFirst"><code>java.lang.String</code></td>
  209. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getObj--">getObj</a></span>()</code>
  210. <div class="block">Get the actual object.</div>
  211. </td>
  212. </tr>
  213. <tr id="i8" class="altColor">
  214. <td class="colFirst"><code>java.lang.String</code></td>
  215. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getSav--">getSav</a></span>()</code>&nbsp;</td>
  216. </tr>
  217. <tr id="i9" class="rowColor">
  218. <td class="colFirst"><code>char</code></td>
  219. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getSign--">getSign</a></span>()</code>
  220. <div class="block">Get the symbol of the value (see variable description).</div>
  221. </td>
  222. </tr>
  223. <tr id="i10" class="altColor">
  224. <td class="colFirst"><code>float</code></td>
  225. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getTotalEnergy--">getTotalEnergy</a></span>()</code>
  226. <div class="block">Multiply the amount of gadgets, given by the user, and the
  227. consumption/production.</div>
  228. </td>
  229. </tr>
  230. <tr id="i11" class="rowColor">
  231. <td class="colFirst"><code>float</code></td>
  232. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#getTotalEnergyAtTimeStep-int-">getTotalEnergyAtTimeStep</a></span>(int&nbsp;x)</code>
  233. <div class="block">Get the energy value at a selected time x.</div>
  234. </td>
  235. </tr>
  236. <tr id="i12" class="altColor">
  237. <td class="colFirst"><code>void</code></td>
  238. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#setActive-boolean-">setActive</a></span>(boolean&nbsp;active)</code>
  239. <div class="block">Set the Status of the Element (see description of variables).</div>
  240. </td>
  241. </tr>
  242. <tr id="i13" class="rowColor">
  243. <td class="colFirst"><code>void</code></td>
  244. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#setAmount-int-">setAmount</a></span>(int&nbsp;amount)</code>
  245. <div class="block">Set the amount of the Element in the selected Object.</div>
  246. </td>
  247. </tr>
  248. <tr id="i14" class="altColor">
  249. <td class="colFirst"><code>void</code></td>
  250. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#setEleName-java.lang.String-">setEleName</a></span>(java.lang.String&nbsp;name)</code>
  251. <div class="block">Set the name to any new name.</div>
  252. </td>
  253. </tr>
  254. <tr id="i15" class="rowColor">
  255. <td class="colFirst"><code>void</code></td>
  256. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#setEnergy-float-">setEnergy</a></span>(float&nbsp;energy)</code>
  257. <div class="block">Set the energy value of the selected Element.</div>
  258. </td>
  259. </tr>
  260. <tr id="i16" class="altColor">
  261. <td class="colFirst"><code>void</code></td>
  262. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#setEnergyAt-float-">setEnergyAt</a></span>(float&nbsp;energy)</code>
  263. <div class="block">Set energy to any value to the whole array.</div>
  264. </td>
  265. </tr>
  266. <tr id="i17" class="rowColor">
  267. <td class="colFirst"><code>void</code></td>
  268. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#setEnergyAt-int-float-">setEnergyAt</a></span>(int&nbsp;pos,
  269. float&nbsp;energy)</code>
  270. <div class="block">Set energy to any value at a given position.</div>
  271. </td>
  272. </tr>
  273. <tr id="i18" class="altColor">
  274. <td class="colFirst"><code>void</code></td>
  275. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#setGraphPoints-java.util.LinkedList-">setGraphPoints</a></span>(java.util.LinkedList&lt;java.awt.Point&gt;&nbsp;points)</code>
  276. <div class="block">Set the points (values) in the graph.</div>
  277. </td>
  278. </tr>
  279. <tr id="i19" class="rowColor">
  280. <td class="colFirst"><code>void</code></td>
  281. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#setObj-java.lang.String-">setObj</a></span>(java.lang.String&nbsp;obj)</code>
  282. <div class="block">Set the object to a new one.</div>
  283. </td>
  284. </tr>
  285. <tr id="i20" class="altColor">
  286. <td class="colFirst"><code>void</code></td>
  287. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#setSav-java.lang.String-">setSav</a></span>(java.lang.String&nbsp;sav)</code>
  288. <div class="block">for save purposes.</div>
  289. </td>
  290. </tr>
  291. <tr id="i21" class="rowColor">
  292. <td class="colFirst"><code>void</code></td>
  293. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonElement.html#setSign-float-">setSign</a></span>(float&nbsp;energy)</code>
  294. <div class="block">Set symbol of the value.</div>
  295. </td>
  296. </tr>
  297. </table>
  298. <ul class="blockList">
  299. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  300. <!-- -->
  301. </a>
  302. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  303. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  304. </ul>
  305. </li>
  306. </ul>
  307. </li>
  308. </ul>
  309. </div>
  310. <div class="details">
  311. <ul class="blockList">
  312. <li class="blockList">
  313. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  314. <ul class="blockList">
  315. <li class="blockList"><a name="constructor.detail">
  316. <!-- -->
  317. </a>
  318. <h3>Constructor Detail</h3>
  319. <a name="HolonElement-java.lang.String-int-float-">
  320. <!-- -->
  321. </a>
  322. <ul class="blockList">
  323. <li class="blockList">
  324. <h4>HolonElement</h4>
  325. <pre>public&nbsp;HolonElement(java.lang.String&nbsp;eleName,
  326. int&nbsp;amount,
  327. float&nbsp;energy)</pre>
  328. <div class="block">Create a new HolonElement with a user-defined name, amount of the same
  329. element and energy per element.</div>
  330. <dl>
  331. <dt><span class="paramLabel">Parameters:</span></dt>
  332. <dd><code>eleName</code> - String</dd>
  333. <dd><code>amount</code> - int</dd>
  334. <dd><code>energy</code> - float</dd>
  335. </dl>
  336. </li>
  337. </ul>
  338. <a name="HolonElement-classes.HolonElement-">
  339. <!-- -->
  340. </a>
  341. <ul class="blockListLast">
  342. <li class="blockList">
  343. <h4>HolonElement</h4>
  344. <pre>public&nbsp;HolonElement(<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&nbsp;element)</pre>
  345. <div class="block">Create a copy of the HolonElement given each one a new ID.</div>
  346. <dl>
  347. <dt><span class="paramLabel">Parameters:</span></dt>
  348. <dd><code>element</code> - element to copy</dd>
  349. </dl>
  350. </li>
  351. </ul>
  352. </li>
  353. </ul>
  354. <!-- ============ METHOD DETAIL ========== -->
  355. <ul class="blockList">
  356. <li class="blockList"><a name="method.detail">
  357. <!-- -->
  358. </a>
  359. <h3>Method Detail</h3>
  360. <a name="getEnergyAt--">
  361. <!-- -->
  362. </a>
  363. <ul class="blockList">
  364. <li class="blockList">
  365. <h4>getEnergyAt</h4>
  366. <pre>public&nbsp;float[]&nbsp;getEnergyAt()</pre>
  367. <div class="block">Get the Array of energy (100 values).</div>
  368. <dl>
  369. <dt><span class="returnLabel">Returns:</span></dt>
  370. <dd>energyAt Array of Floats</dd>
  371. </dl>
  372. </li>
  373. </ul>
  374. <a name="setEnergyAt-float-">
  375. <!-- -->
  376. </a>
  377. <ul class="blockList">
  378. <li class="blockList">
  379. <h4>setEnergyAt</h4>
  380. <pre>public&nbsp;void&nbsp;setEnergyAt(float&nbsp;energy)</pre>
  381. <div class="block">Set energy to any value to the whole array.</div>
  382. <dl>
  383. <dt><span class="paramLabel">Parameters:</span></dt>
  384. <dd><code>energy</code> - the value</dd>
  385. </dl>
  386. </li>
  387. </ul>
  388. <a name="setEnergyAt-int-float-">
  389. <!-- -->
  390. </a>
  391. <ul class="blockList">
  392. <li class="blockList">
  393. <h4>setEnergyAt</h4>
  394. <pre>public&nbsp;void&nbsp;setEnergyAt(int&nbsp;pos,
  395. float&nbsp;energy)</pre>
  396. <div class="block">Set energy to any value at a given position.</div>
  397. <dl>
  398. <dt><span class="paramLabel">Parameters:</span></dt>
  399. <dd><code>pos</code> - int</dd>
  400. <dd><code>energy</code> - float</dd>
  401. </dl>
  402. </li>
  403. </ul>
  404. <a name="getEleName--">
  405. <!-- -->
  406. </a>
  407. <ul class="blockList">
  408. <li class="blockList">
  409. <h4>getEleName</h4>
  410. <pre>public&nbsp;java.lang.String&nbsp;getEleName()</pre>
  411. <div class="block">Get the user-defined Name.</div>
  412. <dl>
  413. <dt><span class="returnLabel">Returns:</span></dt>
  414. <dd>the name String</dd>
  415. </dl>
  416. </li>
  417. </ul>
  418. <a name="setEleName-java.lang.String-">
  419. <!-- -->
  420. </a>
  421. <ul class="blockList">
  422. <li class="blockList">
  423. <h4>setEleName</h4>
  424. <pre>public&nbsp;void&nbsp;setEleName(java.lang.String&nbsp;name)</pre>
  425. <div class="block">Set the name to any new name.</div>
  426. <dl>
  427. <dt><span class="paramLabel">Parameters:</span></dt>
  428. <dd><code>name</code> - the name to set</dd>
  429. </dl>
  430. </li>
  431. </ul>
  432. <a name="getAmount--">
  433. <!-- -->
  434. </a>
  435. <ul class="blockList">
  436. <li class="blockList">
  437. <h4>getAmount</h4>
  438. <pre>public&nbsp;int&nbsp;getAmount()</pre>
  439. <div class="block">Get the actual amount of Elements in the selected Object.</div>
  440. <dl>
  441. <dt><span class="returnLabel">Returns:</span></dt>
  442. <dd>the amount int</dd>
  443. </dl>
  444. </li>
  445. </ul>
  446. <a name="setAmount-int-">
  447. <!-- -->
  448. </a>
  449. <ul class="blockList">
  450. <li class="blockList">
  451. <h4>setAmount</h4>
  452. <pre>public&nbsp;void&nbsp;setAmount(int&nbsp;amount)</pre>
  453. <div class="block">Set the amount of the Element in the selected Object.</div>
  454. <dl>
  455. <dt><span class="paramLabel">Parameters:</span></dt>
  456. <dd><code>amount</code> - the amount to set</dd>
  457. </dl>
  458. </li>
  459. </ul>
  460. <a name="getEnergy--">
  461. <!-- -->
  462. </a>
  463. <ul class="blockList">
  464. <li class="blockList">
  465. <h4>getEnergy</h4>
  466. <pre>public&nbsp;float&nbsp;getEnergy()</pre>
  467. <div class="block">Get the energy value of the selected Element.</div>
  468. <dl>
  469. <dt><span class="returnLabel">Returns:</span></dt>
  470. <dd>the energy</dd>
  471. </dl>
  472. </li>
  473. </ul>
  474. <a name="setEnergy-float-">
  475. <!-- -->
  476. </a>
  477. <ul class="blockList">
  478. <li class="blockList">
  479. <h4>setEnergy</h4>
  480. <pre>public&nbsp;void&nbsp;setEnergy(float&nbsp;energy)</pre>
  481. <div class="block">Set the energy value of the selected Element.</div>
  482. <dl>
  483. <dt><span class="paramLabel">Parameters:</span></dt>
  484. <dd><code>energy</code> - the energy to set</dd>
  485. </dl>
  486. </li>
  487. </ul>
  488. <a name="getActive--">
  489. <!-- -->
  490. </a>
  491. <ul class="blockList">
  492. <li class="blockList">
  493. <h4>getActive</h4>
  494. <pre>public&nbsp;boolean&nbsp;getActive()</pre>
  495. <div class="block">Get the Status of the Element (see description of variables).</div>
  496. <dl>
  497. <dt><span class="returnLabel">Returns:</span></dt>
  498. <dd>the active</dd>
  499. </dl>
  500. </li>
  501. </ul>
  502. <a name="setActive-boolean-">
  503. <!-- -->
  504. </a>
  505. <ul class="blockList">
  506. <li class="blockList">
  507. <h4>setActive</h4>
  508. <pre>public&nbsp;void&nbsp;setActive(boolean&nbsp;active)</pre>
  509. <div class="block">Set the Status of the Element (see description of variables).</div>
  510. <dl>
  511. <dt><span class="paramLabel">Parameters:</span></dt>
  512. <dd><code>active</code> - the active to set</dd>
  513. </dl>
  514. </li>
  515. </ul>
  516. <a name="getTotalEnergy--">
  517. <!-- -->
  518. </a>
  519. <ul class="blockList">
  520. <li class="blockList">
  521. <h4>getTotalEnergy</h4>
  522. <pre>public&nbsp;float&nbsp;getTotalEnergy()</pre>
  523. <div class="block">Multiply the amount of gadgets, given by the user, and the
  524. consumption/production. If the switch isWorking is turned off for on
  525. gadget, the energy of this gadget have to be subtracted.</div>
  526. <dl>
  527. <dt><span class="returnLabel">Returns:</span></dt>
  528. <dd>totalEnergy (actual)</dd>
  529. </dl>
  530. </li>
  531. </ul>
  532. <a name="getTotalEnergyAtTimeStep-int-">
  533. <!-- -->
  534. </a>
  535. <ul class="blockList">
  536. <li class="blockList">
  537. <h4>getTotalEnergyAtTimeStep</h4>
  538. <pre>public&nbsp;float&nbsp;getTotalEnergyAtTimeStep(int&nbsp;x)</pre>
  539. <div class="block">Get the energy value at a selected time x.</div>
  540. <dl>
  541. <dt><span class="paramLabel">Parameters:</span></dt>
  542. <dd><code>x</code> - int</dd>
  543. <dt><span class="returnLabel">Returns:</span></dt>
  544. <dd>energy value</dd>
  545. </dl>
  546. </li>
  547. </ul>
  548. <a name="getSign--">
  549. <!-- -->
  550. </a>
  551. <ul class="blockList">
  552. <li class="blockList">
  553. <h4>getSign</h4>
  554. <pre>public&nbsp;char&nbsp;getSign()</pre>
  555. <div class="block">Get the symbol of the value (see variable description).</div>
  556. <dl>
  557. <dt><span class="returnLabel">Returns:</span></dt>
  558. <dd>the sign</dd>
  559. </dl>
  560. </li>
  561. </ul>
  562. <a name="setSign-float-">
  563. <!-- -->
  564. </a>
  565. <ul class="blockList">
  566. <li class="blockList">
  567. <h4>setSign</h4>
  568. <pre>public&nbsp;void&nbsp;setSign(float&nbsp;energy)</pre>
  569. <div class="block">Set symbol of the value.</div>
  570. <dl>
  571. <dt><span class="paramLabel">Parameters:</span></dt>
  572. <dd><code>energy</code> - the sign to set</dd>
  573. </dl>
  574. </li>
  575. </ul>
  576. <a name="getSav--">
  577. <!-- -->
  578. </a>
  579. <ul class="blockList">
  580. <li class="blockList">
  581. <h4>getSav</h4>
  582. <pre>public&nbsp;java.lang.String&nbsp;getSav()</pre>
  583. <dl>
  584. <dt><span class="returnLabel">Returns:</span></dt>
  585. <dd>the stored.</dd>
  586. </dl>
  587. </li>
  588. </ul>
  589. <a name="setSav-java.lang.String-">
  590. <!-- -->
  591. </a>
  592. <ul class="blockList">
  593. <li class="blockList">
  594. <h4>setSav</h4>
  595. <pre>public&nbsp;void&nbsp;setSav(java.lang.String&nbsp;sav)</pre>
  596. <div class="block">for save purposes.</div>
  597. <dl>
  598. <dt><span class="paramLabel">Parameters:</span></dt>
  599. <dd><code>sav</code> - the stored to set</dd>
  600. </dl>
  601. </li>
  602. </ul>
  603. <a name="getObj--">
  604. <!-- -->
  605. </a>
  606. <ul class="blockList">
  607. <li class="blockList">
  608. <h4>getObj</h4>
  609. <pre>public&nbsp;java.lang.String&nbsp;getObj()</pre>
  610. <div class="block">Get the actual object.</div>
  611. <dl>
  612. <dt><span class="returnLabel">Returns:</span></dt>
  613. <dd>the obj</dd>
  614. </dl>
  615. </li>
  616. </ul>
  617. <a name="setObj-java.lang.String-">
  618. <!-- -->
  619. </a>
  620. <ul class="blockList">
  621. <li class="blockList">
  622. <h4>setObj</h4>
  623. <pre>public&nbsp;void&nbsp;setObj(java.lang.String&nbsp;obj)</pre>
  624. <div class="block">Set the object to a new one.</div>
  625. <dl>
  626. <dt><span class="paramLabel">Parameters:</span></dt>
  627. <dd><code>obj</code> - the obj to set</dd>
  628. </dl>
  629. </li>
  630. </ul>
  631. <a name="getGraphPoints--">
  632. <!-- -->
  633. </a>
  634. <ul class="blockList">
  635. <li class="blockList">
  636. <h4>getGraphPoints</h4>
  637. <pre>public&nbsp;java.util.LinkedList&lt;java.awt.Point&gt;&nbsp;getGraphPoints()</pre>
  638. <div class="block">Get the points (values) in the graph.</div>
  639. <dl>
  640. <dt><span class="returnLabel">Returns:</span></dt>
  641. <dd>the Graph Points</dd>
  642. </dl>
  643. </li>
  644. </ul>
  645. <a name="setGraphPoints-java.util.LinkedList-">
  646. <!-- -->
  647. </a>
  648. <ul class="blockList">
  649. <li class="blockList">
  650. <h4>setGraphPoints</h4>
  651. <pre>public&nbsp;void&nbsp;setGraphPoints(java.util.LinkedList&lt;java.awt.Point&gt;&nbsp;points)</pre>
  652. <div class="block">Set the points (values) in the graph.</div>
  653. <dl>
  654. <dt><span class="paramLabel">Parameters:</span></dt>
  655. <dd><code>points</code> - the Graph points</dd>
  656. </dl>
  657. </li>
  658. </ul>
  659. <a name="getId--">
  660. <!-- -->
  661. </a>
  662. <ul class="blockListLast">
  663. <li class="blockList">
  664. <h4>getId</h4>
  665. <pre>public&nbsp;int&nbsp;getId()</pre>
  666. <div class="block">Get the Id of the selected HolonElement.</div>
  667. <dl>
  668. <dt><span class="returnLabel">Returns:</span></dt>
  669. <dd>id the id</dd>
  670. </dl>
  671. </li>
  672. </ul>
  673. </li>
  674. </ul>
  675. </li>
  676. </ul>
  677. </div>
  678. </div>
  679. <!-- ========= END OF CLASS DATA ========= -->
  680. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  681. <div class="bottomNav"><a name="navbar.bottom">
  682. <!-- -->
  683. </a>
  684. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  685. <a name="navbar.bottom.firstrow">
  686. <!-- -->
  687. </a>
  688. <ul class="navList" title="Navigation">
  689. <li><a href="../overview-summary.html">Overview</a></li>
  690. <li><a href="package-summary.html">Package</a></li>
  691. <li class="navBarCell1Rev">Class</li>
  692. <li><a href="class-use/HolonElement.html">Use</a></li>
  693. <li><a href="package-tree.html">Tree</a></li>
  694. <li><a href="../deprecated-list.html">Deprecated</a></li>
  695. <li><a href="../index-files/index-1.html">Index</a></li>
  696. <li><a href="../help-doc.html">Help</a></li>
  697. </ul>
  698. </div>
  699. <div class="subNav">
  700. <ul class="navList">
  701. <li><a href="../classes/CpsNode.html" title="class in classes"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  702. <li><a href="../classes/HolonObject.html" title="class in classes"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  703. </ul>
  704. <ul class="navList">
  705. <li><a href="../index.html?classes/HolonElement.html" target="_top">Frames</a></li>
  706. <li><a href="HolonElement.html" target="_top">No&nbsp;Frames</a></li>
  707. </ul>
  708. <ul class="navList" id="allclasses_navbar_bottom">
  709. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  710. </ul>
  711. <div>
  712. <script type="text/javascript"><!--
  713. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  714. if(window==top) {
  715. allClassesLink.style.display = "block";
  716. }
  717. else {
  718. allClassesLink.style.display = "none";
  719. }
  720. //-->
  721. </script>
  722. </div>
  723. <div>
  724. <ul class="subNavList">
  725. <li>Summary:&nbsp;</li>
  726. <li>Nested&nbsp;|&nbsp;</li>
  727. <li>Field&nbsp;|&nbsp;</li>
  728. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  729. <li><a href="#method.summary">Method</a></li>
  730. </ul>
  731. <ul class="subNavList">
  732. <li>Detail:&nbsp;</li>
  733. <li>Field&nbsp;|&nbsp;</li>
  734. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  735. <li><a href="#method.detail">Method</a></li>
  736. </ul>
  737. </div>
  738. <a name="skip.navbar.bottom">
  739. <!-- -->
  740. </a></div>
  741. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  742. </body>
  743. </html>