Inicio Explorar Ayuda
Iniciar sesión
jonas.rehn
/
praktikum-holons
forked de carlos.garcia/praktikum-holons
1
0
Fork 0
Archivos
Árbol: 325d5e13a6
Ramas Etiquetas
praktikum-ho...
/
doc
/
classes
/
HolonObject.html

HolonObject.html 27 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="de">
    4. 

  4. <head>
    5. 

  5. <!-- Generated by javadoc (1.8.0_74) on Tue Sep 27 12:48:17 CEST 2016 -->
    6. 

  6. <title>HolonObject</title>
    7. 

  7. <meta name="date" content="2016-09-27">
    8. 

  8. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
    9. 

  9. <script type="text/javascript" src="../script.js"></script>
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. <script type="text/javascript"><!--
    13. 

  13.     try {
    14. 

  14.         if (location.href.indexOf('is-external=true') == -1) {
    15. 

  15.             parent.document.title="HolonObject";
    16. 

  16.         }
    17. 

  17.     }
    18. 

  18.     catch(err) {
    19. 

  19.     }
    20. 

  20. //-->
    21. 

  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};
    22. 

  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
    23. 

  23. var altColor = "altColor";
    24. 

  24. var rowColor = "rowColor";
    25. 

  25. var tableTab = "tableTab";
    26. 

  26. var activeTableTab = "activeTableTab";
    27. 

  27. </script>
    28. 

  28. <noscript>
    29. 

  29. <div>JavaScript is disabled on your browser.</div>
    30. 

  30. </noscript>
    31. 

  31. <!-- ========= START OF TOP NAVBAR ======= -->
    32. 

  32. <div class="topNav"><a name="navbar.top">
    33. 

  33. <!--   -->
    34. 

  34. </a>
    35. 

  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
    36. 

  36. <a name="navbar.top.firstrow">
    37. 

  37. <!--   -->
    38. 

  38. </a>
    39. 

  39. <ul class="navList" title="Navigation">
    40. 

  40. <li><a href="../overview-summary.html">Overview</a></li>
    41. 

  41. <li><a href="package-summary.html">Package</a></li>
    42. 

  42. <li class="navBarCell1Rev">Class</li>
    43. 

  43. <li><a href="class-use/HolonObject.html">Use</a></li>
    44. 

  44. <li><a href="package-tree.html">Tree</a></li>
    45. 

  45. <li><a href="../deprecated-list.html">Deprecated</a></li>
    46. 

  46. <li><a href="../index-files/index-1.html">Index</a></li>
    47. 

  47. <li><a href="../help-doc.html">Help</a></li>
    48. 

  48. </ul>
    49. 

  49. </div>
    50. 

  50. <div class="subNav">
    51. 

  51. <ul class="navList">
    52. 

  52. <li><a href="../classes/HolonElement.html" title="class in classes"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
    53. 

  53. <li><a href="../classes/HolonSwitch.html" title="class in classes"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
    54. 

  54. </ul>
    55. 

  55. <ul class="navList">
    56. 

  56. <li><a href="../index.html?classes/HolonObject.html" target="_top">Frames</a></li>
    57. 

  57. <li><a href="HolonObject.html" target="_top">No&nbsp;Frames</a></li>
    58. 

  58. </ul>
    59. 

  59. <ul class="navList" id="allclasses_navbar_top">
    60. 

  60. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
    61. 

  61. </ul>
    62. 

  62. <div>
    63. 

  63. <script type="text/javascript"><!--
    64. 

  64.   allClassesLink = document.getElementById("allclasses_navbar_top");
    65. 

  65.   if(window==top) {
    66. 

  66.     allClassesLink.style.display = "block";
    67. 

  67.   }
    68. 

  68.   else {
    69. 

  69.     allClassesLink.style.display = "none";
    70. 

  70.   }
    71. 

  71.   //-->
    72. 

  72. </script>
    73. 

  73. </div>
    74. 

  74. <div>
    75. 

  75. <ul class="subNavList">
    76. 

  76. <li>Summary:&nbsp;</li>
    77. 

  77. <li>Nested&nbsp;|&nbsp;</li>
    78. 

  78. <li>Field&nbsp;|&nbsp;</li>
    79. 

  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
    80. 

  80. <li><a href="#method.summary">Method</a></li>
    81. 

  81. </ul>
    82. 

  82. <ul class="subNavList">
    83. 

  83. <li>Detail:&nbsp;</li>
    84. 

  84. <li>Field&nbsp;|&nbsp;</li>
    85. 

  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
    86. 

  86. <li><a href="#method.detail">Method</a></li>
    87. 

  87. </ul>
    88. 

  88. </div>
    89. 

  89. <a name="skip.navbar.top">
    90. 

  90. <!--   -->
    91. 

  91. </a></div>
    92. 

  92. <!-- ========= END OF TOP NAVBAR ========= -->
    93. 

  93. <!-- ======== START OF CLASS DATA ======== -->
    94. 

  94. <div class="header">
    95. 

  95. <div class="subTitle">classes</div>
    96. 

  96. <h2 title="Class HolonObject" class="title">Class HolonObject</h2>
    97. 

  97. </div>
    98. 

  98. <div class="contentContainer">
    99. 

  99. <ul class="inheritance">
    100. 

  100. <li>java.lang.Object</li>
    101. 

  101. <li>
    102. 

  102. <ul class="inheritance">
    103. 

  103. <li><a href="../classes/AbstractCpsObject.html" title="class in classes">classes.AbstractCpsObject</a></li>
    104. 

  104. <li>
    105. 

  105. <ul class="inheritance">
    106. 

  106. <li>classes.HolonObject</li>
    107. 

  107. </ul>
    108. 

  108. </li>
    109. 

  109. </ul>
    110. 

  110. </li>
    111. 

  111. </ul>
    112. 

  112. <div class="description">
    113. 

  113. <ul class="blockList">
    114. 

  114. <li class="blockList">
    115. 

  115. <hr>
    116. 

  116. <br>
    117. 

  117. <pre>public class <span class="typeNameLabel">HolonObject</span>
    118. 

  118. extends <a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a></pre>
    119. 

  119. <div class="block">The class HolonObject represents any Object on the system which capability of
    120. 

  120.  injecting or consuming energy on the network, for instance a house or a power
    121. 

  121.  plant.</div>
    122. 

  122. <dl>
    123. 

  123. <dt><span class="simpleTagLabel">Author:</span></dt>
    124. 

  124. <dd>Gruppe14</dd>
    125. 

  125. </dl>
    126. 

  126. </li>
    127. 

  127. </ul>
    128. 

  128. </div>
    129. 

  129. <div class="summary">
    130. 

  130. <ul class="blockList">
    131. 

  131. <li class="blockList">
    132. 

  132. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    133. 

  133. <ul class="blockList">
    134. 

  134. <li class="blockList"><a name="constructor.summary">
    135. 

  135. <!--   -->
    136. 

  136. </a>
    137. 

  137. <h3>Constructor Summary</h3>
    138. 

  138. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
    139. 

  139. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
    140. 

  140. <tr>
    141. 

  141. <th class="colOne" scope="col">Constructor and Description</th>
    142. 

  142. </tr>
    143. 

  143. <tr class="altColor">
    144. 

  144. <td class="colOne"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#HolonObject-classes.AbstractCpsObject-">HolonObject</a></span>(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a>&nbsp;obj)</code>
    145. 

  145. <div class="block">Contructor of a copy of an Object.</div>
    146. 

  146. </td>
    147. 

  147. </tr>
    148. 

  148. <tr class="rowColor">
    149. 

  149. <td class="colOne"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#HolonObject-java.lang.String-">HolonObject</a></span>(java.lang.String&nbsp;objName)</code>
    150. 

  150. <div class="block">Constructor Set by default the name of the object equals to the category
    151. 

  151.  name, until the user changes it.</div>
    152. 

  152. </td>
    153. 

  153. </tr>
    154. 

  154. </table>
    155. 

  155. </li>
    156. 

  156. </ul>
    157. 

  157. <!-- ========== METHOD SUMMARY =========== -->
    158. 

  158. <ul class="blockList">
    159. 

  159. <li class="blockList"><a name="method.summary">
    160. 

  160. <!--   -->
    161. 

  161. </a>
    162. 

  162. <h3>Method Summary</h3>
    163. 

  163. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    164. 

  164. <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>
    165. 

  165. <tr>
    166. 

  166. <th class="colFirst" scope="col">Modifier and Type</th>
    167. 

  167. <th class="colLast" scope="col">Method and Description</th>
    168. 

  168. </tr>
    169. 

  169. <tr id="i0" class="altColor">
    170. 

  170. <td class="colFirst"><code>void</code></td>
    171. 

  171. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#addElements-classes.HolonElement-">addElements</a></span>(<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&nbsp;element)</code>
    172. 

  172. <div class="block">adds an Element to the Object.</div>
    173. 

  173. </td>
    174. 

  174. </tr>
    175. 

  175. <tr id="i1" class="rowColor">
    176. 

  176. <td class="colFirst"><code>boolean</code></td>
    177. 

  177. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#checkIfPartiallySupplied-int-">checkIfPartiallySupplied</a></span>(int&nbsp;x)</code>
    178. 

  178. <div class="block">Check if Partially Supplied.</div>
    179. 

  179. </td>
    180. 

  180. </tr>
    181. 

  181. <tr id="i2" class="altColor">
    182. 

  182. <td class="colFirst"><code>java.util.ArrayList&lt;<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&gt;</code></td>
    183. 

  183. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#copyElements-java.util.ArrayList-">copyElements</a></span>(java.util.ArrayList&lt;<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&gt;&nbsp;arr)</code>
    184. 

  184. <div class="block">Copy all Elements into a New Array.</div>
    185. 

  185. </td>
    186. 

  186. </tr>
    187. 

  187. <tr id="i3" class="rowColor">
    188. 

  188. <td class="colFirst"><code>void</code></td>
    189. 

  189. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#deleteElement-int-">deleteElement</a></span>(int&nbsp;idx)</code>
    190. 

  190. <div class="block">deletes Element at a given index.</div>
    191. 

  191. </td>
    192. 

  192. </tr>
    193. 

  193. <tr id="i4" class="altColor">
    194. 

  194. <td class="colFirst"><code>java.awt.Color</code></td>
    195. 

  195. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#getColor--">getColor</a></span>()</code>
    196. 

  196. <div class="block">Get the Color.</div>
    197. 

  197. </td>
    198. 

  198. </tr>
    199. 

  199. <tr id="i5" class="rowColor">
    200. 

  200. <td class="colFirst"><code>float</code></td>
    201. 

  201. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#getCurrentEnergy--">getCurrentEnergy</a></span>()</code>
    202. 

  202. <div class="block">Doesn't take into account which timestep is watched, calculates the max
    203. 

  203.  values.</div>
    204. 

  204. </td>
    205. 

  205. </tr>
    206. 

  206. <tr id="i6" class="altColor">
    207. 

  207. <td class="colFirst"><code>float</code></td>
    208. 

  208. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#getCurrentEnergyAtTimeStep-int-">getCurrentEnergyAtTimeStep</a></span>(int&nbsp;x)</code>
    209. 

  209. <div class="block">Getter for the current energy at a given timestep.</div>
    210. 

  210. </td>
    211. 

  211. </tr>
    212. 

  212. <tr id="i7" class="rowColor">
    213. 

  213. <td class="colFirst"><code>java.util.HashMap&lt;java.lang.String,java.lang.Integer&gt;</code></td>
    214. 

  214. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#getEleIdx--">getEleIdx</a></span>()</code>
    215. 

  215. <div class="block">Getter index of all elements in the HolonObject.</div>
    216. 

  216. </td>
    217. 

  217. </tr>
    218. 

  218. <tr id="i8" class="altColor">
    219. 

  219. <td class="colFirst"><code>java.util.ArrayList&lt;<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&gt;</code></td>
    220. 

  220. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#getElements--">getElements</a></span>()</code>
    221. 

  221. <div class="block">Getter for all Elements in the HolonObject.</div>
    222. 

  222. </td>
    223. 

  223. </tr>
    224. 

  224. <tr id="i9" class="rowColor">
    225. 

  225. <td class="colFirst"><code>int</code></td>
    226. 

  226. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#getState--">getState</a></span>()</code>
    227. 

  227. <div class="block">Get the state of the Object.</div>
    228. 

  228. </td>
    229. 

  229. </tr>
    230. 

  230. <tr id="i10" class="altColor">
    231. 

  231. <td class="colFirst"><code><a href="../classes/HolonElement.html" title="class in classes">HolonElement</a></code></td>
    232. 

  232. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#searchElement-java.lang.String-">searchElement</a></span>(java.lang.String&nbsp;name)</code>
    233. 

  233. <div class="block">Search for the element with the name.</div>
    234. 

  234. </td>
    235. 

  235. </tr>
    236. 

  236. <tr id="i11" class="rowColor">
    237. 

  237. <td class="colFirst"><code><a href="../classes/HolonElement.html" title="class in classes">HolonElement</a></code></td>
    238. 

  238. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#searchElementById-int-">searchElementById</a></span>(int&nbsp;id)</code>
    239. 

  239. <div class="block">Search for the element with the id.</div>
    240. 

  240. </td>
    241. 

  241. </tr>
    242. 

  242. <tr id="i12" class="altColor">
    243. 

  243. <td class="colFirst"><code>void</code></td>
    244. 

  244. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#setColor-java.awt.Color-">setColor</a></span>(java.awt.Color&nbsp;color)</code>
    245. 

  245. <div class="block">Set the State Color.</div>
    246. 

  246. </td>
    247. 

  247. </tr>
    248. 

  248. <tr id="i13" class="rowColor">
    249. 

  249. <td class="colFirst"><code>void</code></td>
    250. 

  250. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#setEleIdx-java.util.HashMap-">setEleIdx</a></span>(java.util.HashMap&lt;java.lang.String,java.lang.Integer&gt;&nbsp;eleIdx)</code>
    251. 

  251. <div class="block">Set the indexes of all elements.</div>
    252. 

  252. </td>
    253. 

  253. </tr>
    254. 

  254. <tr id="i14" class="altColor">
    255. 

  255. <td class="colFirst"><code>void</code></td>
    256. 

  256. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#setElements-java.util.ArrayList-">setElements</a></span>(java.util.ArrayList&lt;<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&gt;&nbsp;elements)</code>
    257. 

  257. <div class="block">Set a new ArrayList with HolonElements into the HolonObject.</div>
    258. 

  258. </td>
    259. 

  259. </tr>
    260. 

  260. <tr id="i15" class="rowColor">
    261. 

  261. <td class="colFirst"><code>void</code></td>
    262. 

  262. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#setState--">setState</a></span>()</code>
    263. 

  263. <div class="block">sets the State, wether object is a producer, zero Energy, supplied or
    264. 

  264.  not.</div>
    265. 

  265. </td>
    266. 

  266. </tr>
    267. 

  267. <tr id="i16" class="altColor">
    268. 

  268. <td class="colFirst"><code>void</code></td>
    269. 

  269. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#setState-int-">setState</a></span>(int&nbsp;state)</code>
    270. 

  270. <div class="block">Set the state of the Object.</div>
    271. 

  271. </td>
    272. 

  272. </tr>
    273. 

  273. <tr id="i17" class="rowColor">
    274. 

  274. <td class="colFirst"><code>java.lang.String</code></td>
    275. 

  275. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/HolonObject.html#toStringElements--">toStringElements</a></span>()</code>
    276. 

  276. <div class="block">String of all consumers in this HolonObject.</div>
    277. 

  277. </td>
    278. 

  278. </tr>
    279. 

  279. </table>
    280. 

  280. <ul class="blockList">
    281. 

  281. <li class="blockList"><a name="methods.inherited.from.class.classes.AbstractCpsObject">
    282. 

  282. <!--   -->
    283. 

  283. </a>
    284. 

  284. <h3>Methods inherited from class&nbsp;classes.<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a></h3>
    285. 

  285. <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>
    286. 

  286. </ul>
    287. 

  287. <ul class="blockList">
    288. 

  288. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
    289. 

  289. <!--   -->
    290. 

  290. </a>
    291. 

  291. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
    292. 

  292. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
    293. 

  293. </ul>
    294. 

  294. </li>
    295. 

  295. </ul>
    296. 

  296. </li>
    297. 

  297. </ul>
    298. 

  298. </div>
    299. 

  299. <div class="details">
    300. 

  300. <ul class="blockList">
    301. 

  301. <li class="blockList">
    302. 

  302. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    303. 

  303. <ul class="blockList">
    304. 

  304. <li class="blockList"><a name="constructor.detail">
    305. 

  305. <!--   -->
    306. 

  306. </a>
    307. 

  307. <h3>Constructor Detail</h3>
    308. 

  308. <a name="HolonObject-java.lang.String-">
    309. 

  309. <!--   -->
    310. 

  310. </a>
    311. 

  311. <ul class="blockList">
    312. 

  312. <li class="blockList">
    313. 

  313. <h4>HolonObject</h4>
    314. 

  314. <pre>public&nbsp;HolonObject(java.lang.String&nbsp;objName)</pre>
    315. 

  315. <div class="block">Constructor Set by default the name of the object equals to the category
    316. 

  316.  name, until the user changes it.</div>
    317. 

  317. <dl>
    318. 

  318. <dt><span class="paramLabel">Parameters:</span></dt>
    319. 

  319. <dd><code>objName</code> - name of the Object</dd>
    320. 

  320. </dl>
    321. 

  321. </li>
    322. 

  322. </ul>
    323. 

  323. <a name="HolonObject-classes.AbstractCpsObject-">
    324. 

  324. <!--   -->
    325. 

  325. </a>
    326. 

  326. <ul class="blockListLast">
    327. 

  327. <li class="blockList">
    328. 

  328. <h4>HolonObject</h4>
    329. 

  329. <pre>public&nbsp;HolonObject(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a>&nbsp;obj)</pre>
    330. 

  330. <div class="block">Contructor of a copy of an Object.</div>
    331. 

  331. <dl>
    332. 

  332. <dt><span class="paramLabel">Parameters:</span></dt>
    333. 

  333. <dd><code>obj</code> - object to be copied</dd>
    334. 

  334. </dl>
    335. 

  335. </li>
    336. 

  336. </ul>
    337. 

  337. </li>
    338. 

  338. </ul>
    339. 

  339. <!-- ============ METHOD DETAIL ========== -->
    340. 

  340. <ul class="blockList">
    341. 

  341. <li class="blockList"><a name="method.detail">
    342. 

  342. <!--   -->
    343. 

  343. </a>
    344. 

  344. <h3>Method Detail</h3>
    345. 

  345. <a name="setState--">
    346. 

  346. <!--   -->
    347. 

  347. </a>
    348. 

  348. <ul class="blockList">
    349. 

  349. <li class="blockList">
    350. 

  350. <h4>setState</h4>
    351. 

  351. <pre>public&nbsp;void&nbsp;setState()</pre>
    352. 

  352. <div class="block">sets the State, wether object is a producer, zero Energy, supplied or
    353. 

  353.  not.</div>
    354. 

  354. </li>
    355. 

  355. </ul>
    356. 

  356. <a name="getElements--">
    357. 

  357. <!--   -->
    358. 

  358. </a>
    359. 

  359. <ul class="blockList">
    360. 

  360. <li class="blockList">
    361. 

  361. <h4>getElements</h4>
    362. 

  362. <pre>public&nbsp;java.util.ArrayList&lt;<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&gt;&nbsp;getElements()</pre>
    363. 

  363. <div class="block">Getter for all Elements in the HolonObject.</div>
    364. 

  364. <dl>
    365. 

  365. <dt><span class="returnLabel">Returns:</span></dt>
    366. 

  366. <dd>the elements ArrayList</dd>
    367. 

  367. </dl>
    368. 

  368. </li>
    369. 

  369. </ul>
    370. 

  370. <a name="setElements-java.util.ArrayList-">
    371. 

  371. <!--   -->
    372. 

  372. </a>
    373. 

  373. <ul class="blockList">
    374. 

  374. <li class="blockList">
    375. 

  375. <h4>setElements</h4>
    376. 

  376. <pre>public&nbsp;void&nbsp;setElements(java.util.ArrayList&lt;<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&gt;&nbsp;elements)</pre>
    377. 

  377. <div class="block">Set a new ArrayList with HolonElements into the HolonObject.</div>
    378. 

  378. <dl>
    379. 

  379. <dt><span class="paramLabel">Parameters:</span></dt>
    380. 

  380. <dd><code>elements</code> - the elements to set</dd>
    381. 

  381. </dl>
    382. 

  382. </li>
    383. 

  383. </ul>
    384. 

  384. <a name="addElements-classes.HolonElement-">
    385. 

  385. <!--   -->
    386. 

  386. </a>
    387. 

  387. <ul class="blockList">
    388. 

  388. <li class="blockList">
    389. 

  389. <h4>addElements</h4>
    390. 

  390. <pre>public&nbsp;void&nbsp;addElements(<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&nbsp;element)</pre>
    391. 

  391. <div class="block">adds an Element to the Object.</div>
    392. 

  392. <dl>
    393. 

  393. <dt><span class="paramLabel">Parameters:</span></dt>
    394. 

  394. <dd><code>element</code> - the Element to add</dd>
    395. 

  395. </dl>
    396. 

  396. </li>
    397. 

  397. </ul>
    398. 

  398. <a name="getCurrentEnergy--">
    399. 

  399. <!--   -->
    400. 

  400. </a>
    401. 

  401. <ul class="blockList">
    402. 

  402. <li class="blockList">
    403. 

  403. <h4>getCurrentEnergy</h4>
    404. 

  404. <pre>public&nbsp;float&nbsp;getCurrentEnergy()</pre>
    405. 

  405. <div class="block">Doesn't take into account which timestep is watched, calculates the max
    406. 

  406.  values.</div>
    407. 

  407. <dl>
    408. 

  408. <dt><span class="returnLabel">Returns:</span></dt>
    409. 

  409. <dd>the currentEnergy</dd>
    410. 

  410. </dl>
    411. 

  411. </li>
    412. 

  412. </ul>
    413. 

  413. <a name="getCurrentEnergyAtTimeStep-int-">
    414. 

  414. <!--   -->
    415. 

  415. </a>
    416. 

  416. <ul class="blockList">
    417. 

  417. <li class="blockList">
    418. 

  418. <h4>getCurrentEnergyAtTimeStep</h4>
    419. 

  419. <pre>public&nbsp;float&nbsp;getCurrentEnergyAtTimeStep(int&nbsp;x)</pre>
    420. 

  420. <div class="block">Getter for the current energy at a given timestep.</div>
    421. 

  421. <dl>
    422. 

  422. <dt><span class="paramLabel">Parameters:</span></dt>
    423. 

  423. <dd><code>x</code> - timestep</dd>
    424. 

  424. <dt><span class="returnLabel">Returns:</span></dt>
    425. 

  425. <dd>corresponding energy</dd>
    426. 

  426. </dl>
    427. 

  427. </li>
    428. 

  428. </ul>
    429. 

  429. <a name="deleteElement-int-">
    430. 

  430. <!--   -->
    431. 

  431. </a>
    432. 

  432. <ul class="blockList">
    433. 

  433. <li class="blockList">
    434. 

  434. <h4>deleteElement</h4>
    435. 

  435. <pre>public&nbsp;void&nbsp;deleteElement(int&nbsp;idx)</pre>
    436. 

  436. <div class="block">deletes Element at a given index.</div>
    437. 

  437. <dl>
    438. 

  438. <dt><span class="paramLabel">Parameters:</span></dt>
    439. 

  439. <dd><code>idx</code> - index</dd>
    440. 

  440. </dl>
    441. 

  441. </li>
    442. 

  442. </ul>
    443. 

  443. <a name="toStringElements--">
    444. 

  444. <!--   -->
    445. 

  445. </a>
    446. 

  446. <ul class="blockList">
    447. 

  447. <li class="blockList">
    448. 

  448. <h4>toStringElements</h4>
    449. 

  449. <pre>public&nbsp;java.lang.String&nbsp;toStringElements()</pre>
    450. 

  450. <div class="block">String of all consumers in this HolonObject.</div>
    451. 

  451. <dl>
    452. 

  452. <dt><span class="returnLabel">Returns:</span></dt>
    453. 

  453. <dd>all the names of this HolonObject separated by "," each object</dd>
    454. 

  454. </dl>
    455. 

  455. </li>
    456. 

  456. </ul>
    457. 

  457. <a name="getEleIdx--">
    458. 

  458. <!--   -->
    459. 

  459. </a>
    460. 

  460. <ul class="blockList">
    461. 

  461. <li class="blockList">
    462. 

  462. <h4>getEleIdx</h4>
    463. 

  463. <pre>public&nbsp;java.util.HashMap&lt;java.lang.String,java.lang.Integer&gt;&nbsp;getEleIdx()</pre>
    464. 

  464. <div class="block">Getter index of all elements in the HolonObject.</div>
    465. 

  465. <dl>
    466. 

  466. <dt><span class="returnLabel">Returns:</span></dt>
    467. 

  467. <dd>the eleIdx</dd>
    468. 

  468. </dl>
    469. 

  469. </li>
    470. 

  470. </ul>
    471. 

  471. <a name="setEleIdx-java.util.HashMap-">
    472. 

  472. <!--   -->
    473. 

  473. </a>
    474. 

  474. <ul class="blockList">
    475. 

  475. <li class="blockList">
    476. 

  476. <h4>setEleIdx</h4>
    477. 

  477. <pre>public&nbsp;void&nbsp;setEleIdx(java.util.HashMap&lt;java.lang.String,java.lang.Integer&gt;&nbsp;eleIdx)</pre>
    478. 

  478. <div class="block">Set the indexes of all elements.</div>
    479. 

  479. <dl>
    480. 

  480. <dt><span class="paramLabel">Parameters:</span></dt>
    481. 

  481. <dd><code>eleIdx</code> - the eleIdx to set</dd>
    482. 

  482. </dl>
    483. 

  483. </li>
    484. 

  484. </ul>
    485. 

  485. <a name="copyElements-java.util.ArrayList-">
    486. 

  486. <!--   -->
    487. 

  487. </a>
    488. 

  488. <ul class="blockList">
    489. 

  489. <li class="blockList">
    490. 

  490. <h4>copyElements</h4>
    491. 

  491. <pre>public&nbsp;java.util.ArrayList&lt;<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&gt;&nbsp;copyElements(java.util.ArrayList&lt;<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&gt;&nbsp;arr)</pre>
    492. 

  492. <div class="block">Copy all Elements into a New Array.</div>
    493. 

  493. <dl>
    494. 

  494. <dt><span class="paramLabel">Parameters:</span></dt>
    495. 

  495. <dd><code>arr</code> - to copy</dd>
    496. 

  496. <dt><span class="returnLabel">Returns:</span></dt>
    497. 

  497. <dd>the copy of arr</dd>
    498. 

  498. </dl>
    499. 

  499. </li>
    500. 

  500. </ul>
    501. 

  501. <a name="getState--">
    502. 

  502. <!--   -->
    503. 

  503. </a>
    504. 

  504. <ul class="blockList">
    505. 

  505. <li class="blockList">
    506. 

  506. <h4>getState</h4>
    507. 

  507. <pre>public&nbsp;int&nbsp;getState()</pre>
    508. 

  508. <div class="block">Get the state of the Object.</div>
    509. 

  509. <dl>
    510. 

  510. <dt><span class="returnLabel">Returns:</span></dt>
    511. 

  511. <dd>state the State of the Element</dd>
    512. 

  512. </dl>
    513. 

  513. </li>
    514. 

  514. </ul>
    515. 

  515. <a name="setState-int-">
    516. 

  516. <!--   -->
    517. 

  517. </a>
    518. 

  518. <ul class="blockList">
    519. 

  519. <li class="blockList">
    520. 

  520. <h4>setState</h4>
    521. 

  521. <pre>public&nbsp;void&nbsp;setState(int&nbsp;state)</pre>
    522. 

  522. <div class="block">Set the state of the Object.</div>
    523. 

  523. <dl>
    524. 

  524. <dt><span class="paramLabel">Parameters:</span></dt>
    525. 

  525. <dd><code>state</code> - boolean if the Object is fully supplied</dd>
    526. 

  526. </dl>
    527. 

  527. </li>
    528. 

  528. </ul>
    529. 

  529. <a name="searchElement-java.lang.String-">
    530. 

  530. <!--   -->
    531. 

  531. </a>
    532. 

  532. <ul class="blockList">
    533. 

  533. <li class="blockList">
    534. 

  534. <h4>searchElement</h4>
    535. 

  535. <pre>public&nbsp;<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&nbsp;searchElement(java.lang.String&nbsp;name)</pre>
    536. 

  536. <div class="block">Search for the element with the name.</div>
    537. 

  537. <dl>
    538. 

  538. <dt><span class="paramLabel">Parameters:</span></dt>
    539. 

  539. <dd><code>name</code> - name of the object to be searched</dd>
    540. 

  540. <dt><span class="returnLabel">Returns:</span></dt>
    541. 

  541. <dd>the searched HolonElement</dd>
    542. 

  542. </dl>
    543. 

  543. </li>
    544. 

  544. </ul>
    545. 

  545. <a name="searchElementById-int-">
    546. 

  546. <!--   -->
    547. 

  547. </a>
    548. 

  548. <ul class="blockList">
    549. 

  549. <li class="blockList">
    550. 

  550. <h4>searchElementById</h4>
    551. 

  551. <pre>public&nbsp;<a href="../classes/HolonElement.html" title="class in classes">HolonElement</a>&nbsp;searchElementById(int&nbsp;id)</pre>
    552. 

  552. <div class="block">Search for the element with the id.</div>
    553. 

  553. <dl>
    554. 

  554. <dt><span class="paramLabel">Parameters:</span></dt>
    555. 

  555. <dd><code>id</code> - id of the element to be founded</dd>
    556. 

  556. <dt><span class="returnLabel">Returns:</span></dt>
    557. 

  557. <dd>the element</dd>
    558. 

  558. </dl>
    559. 

  559. </li>
    560. 

  560. </ul>
    561. 

  561. <a name="checkIfPartiallySupplied-int-">
    562. 

  562. <!--   -->
    563. 

  563. </a>
    564. 

  564. <ul class="blockList">
    565. 

  565. <li class="blockList">
    566. 

  566. <h4>checkIfPartiallySupplied</h4>
    567. 

  567. <pre>public&nbsp;boolean&nbsp;checkIfPartiallySupplied(int&nbsp;x)</pre>
    568. 

  568. <div class="block">Check if Partially Supplied.</div>
    569. 

  569. <dl>
    570. 

  570. <dt><span class="paramLabel">Parameters:</span></dt>
    571. 

  571. <dd><code>x</code> - current Iteration</dd>
    572. 

  572. <dt><span class="returnLabel">Returns:</span></dt>
    573. 

  573. <dd>boolean is partially supplied</dd>
    574. 

  574. </dl>
    575. 

  575. </li>
    576. 

  576. </ul>
    577. 

  577. <a name="setColor-java.awt.Color-">
    578. 

  578. <!--   -->
    579. 

  579. </a>
    580. 

  580. <ul class="blockList">
    581. 

  581. <li class="blockList">
    582. 

  582. <h4>setColor</h4>
    583. 

  583. <pre>public&nbsp;void&nbsp;setColor(java.awt.Color&nbsp;color)</pre>
    584. 

  584. <div class="block">Set the State Color.</div>
    585. 

  585. <dl>
    586. 

  586. <dt><span class="paramLabel">Parameters:</span></dt>
    587. 

  587. <dd><code>color</code> - the Color</dd>
    588. 

  588. </dl>
    589. 

  589. </li>
    590. 

  590. </ul>
    591. 

  591. <a name="getColor--">
    592. 

  592. <!--   -->
    593. 

  593. </a>
    594. 

  594. <ul class="blockListLast">
    595. 

  595. <li class="blockList">
    596. 

  596. <h4>getColor</h4>
    597. 

  597. <pre>public&nbsp;java.awt.Color&nbsp;getColor()</pre>
    598. 

  598. <div class="block">Get the Color.</div>
    599. 

  599. <dl>
    600. 

  600. <dt><span class="returnLabel">Returns:</span></dt>
    601. 

  601. <dd>stateColor the Color</dd>
    602. 

  602. </dl>
    603. 

  603. </li>
    604. 

  604. </ul>
    605. 

  605. </li>
    606. 

  606. </ul>
    607. 

  607. </li>
    608. 

  608. </ul>
    609. 

  609. </div>
    610. 

  610. </div>
    611. 

  611. <!-- ========= END OF CLASS DATA ========= -->
    612. 

  612. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    613. 

  613. <div class="bottomNav"><a name="navbar.bottom">
    614. 

  614. <!--   -->
    615. 

  615. </a>
    616. 

  616. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
    617. 

  617. <a name="navbar.bottom.firstrow">
    618. 

  618. <!--   -->
    619. 

  619. </a>
    620. 

  620. <ul class="navList" title="Navigation">
    621. 

  621. <li><a href="../overview-summary.html">Overview</a></li>
    622. 

  622. <li><a href="package-summary.html">Package</a></li>
    623. 

  623. <li class="navBarCell1Rev">Class</li>
    624. 

  624. <li><a href="class-use/HolonObject.html">Use</a></li>
    625. 

  625. <li><a href="package-tree.html">Tree</a></li>
    626. 

  626. <li><a href="../deprecated-list.html">Deprecated</a></li>
    627. 

  627. <li><a href="../index-files/index-1.html">Index</a></li>
    628. 

  628. <li><a href="../help-doc.html">Help</a></li>
    629. 

  629. </ul>
    630. 

  630. </div>
    631. 

  631. <div class="subNav">
    632. 

  632. <ul class="navList">
    633. 

  633. <li><a href="../classes/HolonElement.html" title="class in classes"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
    634. 

  634. <li><a href="../classes/HolonSwitch.html" title="class in classes"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
    635. 

  635. </ul>
    636. 

  636. <ul class="navList">
    637. 

  637. <li><a href="../index.html?classes/HolonObject.html" target="_top">Frames</a></li>
    638. 

  638. <li><a href="HolonObject.html" target="_top">No&nbsp;Frames</a></li>
    639. 

  639. </ul>
    640. 

  640. <ul class="navList" id="allclasses_navbar_bottom">
    641. 

  641. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
    642. 

  642. </ul>
    643. 

  643. <div>
    644. 

  644. <script type="text/javascript"><!--
    645. 

  645.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    646. 

  646.   if(window==top) {
    647. 

  647.     allClassesLink.style.display = "block";
    648. 

  648.   }
    649. 

  649.   else {
    650. 

  650.     allClassesLink.style.display = "none";
    651. 

  651.   }
    652. 

  652.   //-->
    653. 

  653. </script>
    654. 

  654. </div>
    655. 

  655. <div>
    656. 

  656. <ul class="subNavList">
    657. 

  657. <li>Summary:&nbsp;</li>
    658. 

  658. <li>Nested&nbsp;|&nbsp;</li>
    659. 

  659. <li>Field&nbsp;|&nbsp;</li>
    660. 

  660. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
    661. 

  661. <li><a href="#method.summary">Method</a></li>
    662. 

  662. </ul>
    663. 

  663. <ul class="subNavList">
    664. 

  664. <li>Detail:&nbsp;</li>
    665. 

  665. <li>Field&nbsp;|&nbsp;</li>
    666. 

  666. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
    667. 

  667. <li><a href="#method.detail">Method</a></li>
    668. 

  668. </ul>
    669. 

  669. </div>
    670. 

  670. <a name="skip.navbar.bottom">
    671. 

  671. <!--   -->
    672. 

  672. </a></div>
    673. 

  673. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    674. 

  674. </body>
    675. 

  675. </html>
    676.