AbstractCpsObject.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818
  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>AbstractCpsObject</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="AbstractCpsObject";
  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,"i22":10,"i23":10,"i24":10,"i25":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/AbstractCpsObject.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>Prev&nbsp;Class</li>
  53. <li><a href="../classes/Category.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/AbstractCpsObject.html" target="_top">Frames</a></li>
  57. <li><a href="AbstractCpsObject.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 AbstractCpsObject" class="title">Class AbstractCpsObject</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.AbstractCpsObject</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>Direct Known Subclasses:</dt>
  112. <dd><a href="../classes/CpsNode.html" title="class in classes">CpsNode</a>, <a href="../classes/HolonObject.html" title="class in classes">HolonObject</a>, <a href="../classes/HolonSwitch.html" title="class in classes">HolonSwitch</a>, <a href="../classes/HolonTransformer.html" title="class in classes">HolonTransformer</a></dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public abstract class <span class="typeNameLabel">AbstractCpsObject</span>
  117. extends java.lang.Object</pre>
  118. <div class="block">The abstract class "CpsObject" represents any possible object in the system
  119. (except Edges). The representation of any object contains following
  120. variables: see description of variables</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/AbstractCpsObject.html#AbstractCpsObject-classes.AbstractCpsObject-">AbstractCpsObject</a></span>(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a>&nbsp;obj)</code>
  144. <div class="block">Constructor for a new CpsObject with an unique ID (This constructor
  145. correspond to the interaction between the Categories and Canvas)-->
  146. actually the "new" Object is a copy.</div>
  147. </td>
  148. </tr>
  149. <tr class="rowColor">
  150. <td class="colOne"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#AbstractCpsObject-java.lang.String-">AbstractCpsObject</a></span>(java.lang.String&nbsp;objName)</code>
  151. <div class="block">Constructor for a CpsObejct with an unique ID.</div>
  152. </td>
  153. </tr>
  154. </table>
  155. </li>
  156. </ul>
  157. <!-- ========== METHOD SUMMARY =========== -->
  158. <ul class="blockList">
  159. <li class="blockList"><a name="method.summary">
  160. <!-- -->
  161. </a>
  162. <h3>Method Summary</h3>
  163. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  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. <tr>
  166. <th class="colFirst" scope="col">Modifier and Type</th>
  167. <th class="colLast" scope="col">Method and Description</th>
  168. </tr>
  169. <tr id="i0" class="altColor">
  170. <td class="colFirst"><code>void</code></td>
  171. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#addConnection-classes.CpsEdge-">addConnection</a></span>(<a href="../classes/CpsEdge.html" title="class in classes">CpsEdge</a>&nbsp;toConnect)</code>
  172. <div class="block">Add a new connection to the selected Object.</div>
  173. </td>
  174. </tr>
  175. <tr id="i1" class="rowColor">
  176. <td class="colFirst"><code>java.util.ArrayList&lt;java.lang.Integer&gt;</code></td>
  177. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#addPseudoTag--">addPseudoTag</a></span>()</code>
  178. <div class="block">add a pseudo tag.</div>
  179. </td>
  180. </tr>
  181. <tr id="i2" class="altColor">
  182. <td class="colFirst"><code>void</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#addTag-int-">addTag</a></span>(int&nbsp;tag)</code>
  184. <div class="block">For internal purpose (energy flow).</div>
  185. </td>
  186. </tr>
  187. <tr id="i3" class="rowColor">
  188. <td class="colFirst"><code>java.awt.Color</code></td>
  189. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getBorderColor--">getBorderColor</a></span>()</code>
  190. <div class="block">Get the color of the border.</div>
  191. </td>
  192. </tr>
  193. <tr id="i4" class="altColor">
  194. <td class="colFirst"><code>java.util.ArrayList&lt;<a href="../classes/CpsEdge.html" title="class in classes">CpsEdge</a>&gt;</code></td>
  195. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getConnectedTo--">getConnectedTo</a></span>()</code>
  196. <div class="block">List of all existing connections.</div>
  197. </td>
  198. </tr>
  199. <tr id="i5" class="rowColor">
  200. <td class="colFirst"><code>java.util.ArrayList&lt;<a href="../classes/CpsEdge.html" title="class in classes">CpsEdge</a>&gt;</code></td>
  201. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getConnections--">getConnections</a></span>()</code>
  202. <div class="block">List of all existing connections.</div>
  203. </td>
  204. </tr>
  205. <tr id="i6" class="altColor">
  206. <td class="colFirst"><code>int</code></td>
  207. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getID--">getID</a></span>()</code>
  208. <div class="block">Getter of the unique ID.</div>
  209. </td>
  210. </tr>
  211. <tr id="i7" class="rowColor">
  212. <td class="colFirst"><code>java.lang.String</code></td>
  213. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getImage--">getImage</a></span>()</code>
  214. <div class="block">Get the path of the image for the selected Object.</div>
  215. </td>
  216. </tr>
  217. <tr id="i8" class="altColor">
  218. <td class="colFirst"><code>java.lang.String</code></td>
  219. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getName--">getName</a></span>()</code>
  220. <div class="block">Getter for the user-defined name (no unique).</div>
  221. </td>
  222. </tr>
  223. <tr id="i9" class="rowColor">
  224. <td class="colFirst"><code>java.lang.String</code></td>
  225. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getObjName--">getObjName</a></span>()</code>
  226. <div class="block">Getter for the type of the Object.</div>
  227. </td>
  228. </tr>
  229. <tr id="i10" class="altColor">
  230. <td class="colFirst"><code><a href="../classes/Position.html" title="class in classes">Position</a></code></td>
  231. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getPosition--">getPosition</a></span>()</code>
  232. <div class="block">Get the actual position of the Object.</div>
  233. </td>
  234. </tr>
  235. <tr id="i11" class="rowColor">
  236. <td class="colFirst"><code>java.util.ArrayList&lt;java.lang.Integer&gt;</code></td>
  237. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getPseudoTags--">getPseudoTags</a></span>()</code>
  238. <div class="block">Get the pseudo tags.</div>
  239. </td>
  240. </tr>
  241. <tr id="i12" class="altColor">
  242. <td class="colFirst"><code>java.lang.String</code></td>
  243. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getSav--">getSav</a></span>()</code>
  244. <div class="block">For save purpose.</div>
  245. </td>
  246. </tr>
  247. <tr id="i13" class="rowColor">
  248. <td class="colFirst"><code>java.util.ArrayList&lt;java.lang.Integer&gt;</code></td>
  249. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#getTag--">getTag</a></span>()</code>
  250. <div class="block">Get the actual tags.</div>
  251. </td>
  252. </tr>
  253. <tr id="i14" class="altColor">
  254. <td class="colFirst"><code>void</code></td>
  255. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#resetTags--">resetTags</a></span>()</code>
  256. <div class="block">Rest the tags to Null.</div>
  257. </td>
  258. </tr>
  259. <tr id="i15" class="rowColor">
  260. <td class="colFirst"><code>void</code></td>
  261. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setBorderColor-java.awt.Color-">setBorderColor</a></span>(java.awt.Color&nbsp;c)</code>
  262. <div class="block">Set the Border Color of this CpsObject.</div>
  263. </td>
  264. </tr>
  265. <tr id="i16" class="altColor">
  266. <td class="colFirst"><code>void</code></td>
  267. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setConnections-java.util.ArrayList-">setConnections</a></span>(java.util.ArrayList&lt;<a href="../classes/CpsEdge.html" title="class in classes">CpsEdge</a>&gt;&nbsp;arrayList)</code>
  268. <div class="block">Set a new ArrayList of connections (Update).</div>
  269. </td>
  270. </tr>
  271. <tr id="i17" class="rowColor">
  272. <td class="colFirst"><code>void</code></td>
  273. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setID-int-">setID</a></span>(int&nbsp;id)</code>
  274. <div class="block">Set the ID to a new one.</div>
  275. </td>
  276. </tr>
  277. <tr id="i18" class="altColor">
  278. <td class="colFirst"><code>void</code></td>
  279. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setImage-java.lang.String-">setImage</a></span>(java.lang.String&nbsp;image)</code>
  280. <div class="block">Set the path of the image.</div>
  281. </td>
  282. </tr>
  283. <tr id="i19" class="rowColor">
  284. <td class="colFirst"><code>void</code></td>
  285. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setName-java.lang.String-">setName</a></span>(java.lang.String&nbsp;name)</code>
  286. <div class="block">Set the name.</div>
  287. </td>
  288. </tr>
  289. <tr id="i20" class="altColor">
  290. <td class="colFirst"><code>void</code></td>
  291. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setObjName-java.lang.String-">setObjName</a></span>(java.lang.String&nbsp;objName)</code>
  292. <div class="block">Set the type of Object.</div>
  293. </td>
  294. </tr>
  295. <tr id="i21" class="rowColor">
  296. <td class="colFirst"><code>void</code></td>
  297. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setPosition-int-int-">setPosition</a></span>(int&nbsp;x,
  298. int&nbsp;y)</code>
  299. <div class="block">Set the position of the Object in the canvas.</div>
  300. </td>
  301. </tr>
  302. <tr id="i22" class="altColor">
  303. <td class="colFirst"><code>void</code></td>
  304. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setPosition-classes.Position-">setPosition</a></span>(<a href="../classes/Position.html" title="class in classes">Position</a>&nbsp;pos)</code>
  305. <div class="block">Set the position of the Object in the canvas.</div>
  306. </td>
  307. </tr>
  308. <tr id="i23" class="rowColor">
  309. <td class="colFirst"><code>void</code></td>
  310. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setPseudoTags-java.util.ArrayList-">setPseudoTags</a></span>(java.util.ArrayList&lt;java.lang.Integer&gt;&nbsp;tags)</code>
  311. <div class="block">For internal purpose (energy flow).</div>
  312. </td>
  313. </tr>
  314. <tr id="i24" class="altColor">
  315. <td class="colFirst"><code>void</code></td>
  316. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setSav-java.lang.String-">setSav</a></span>(java.lang.String&nbsp;sav)</code>
  317. <div class="block">For save purpose.</div>
  318. </td>
  319. </tr>
  320. <tr id="i25" class="rowColor">
  321. <td class="colFirst"><code>void</code></td>
  322. <td class="colLast"><code><span class="memberNameLink"><a href="../classes/AbstractCpsObject.html#setTags-java.util.ArrayList-">setTags</a></span>(java.util.ArrayList&lt;java.lang.Integer&gt;&nbsp;tags)</code>
  323. <div class="block">For internal purpose (energy flow).</div>
  324. </td>
  325. </tr>
  326. </table>
  327. <ul class="blockList">
  328. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  329. <!-- -->
  330. </a>
  331. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  332. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  333. </ul>
  334. </li>
  335. </ul>
  336. </li>
  337. </ul>
  338. </div>
  339. <div class="details">
  340. <ul class="blockList">
  341. <li class="blockList">
  342. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  343. <ul class="blockList">
  344. <li class="blockList"><a name="constructor.detail">
  345. <!-- -->
  346. </a>
  347. <h3>Constructor Detail</h3>
  348. <a name="AbstractCpsObject-java.lang.String-">
  349. <!-- -->
  350. </a>
  351. <ul class="blockList">
  352. <li class="blockList">
  353. <h4>AbstractCpsObject</h4>
  354. <pre>public&nbsp;AbstractCpsObject(java.lang.String&nbsp;objName)</pre>
  355. <div class="block">Constructor for a CpsObejct with an unique ID.</div>
  356. <dl>
  357. <dt><span class="paramLabel">Parameters:</span></dt>
  358. <dd><code>objName</code> - of the Object</dd>
  359. </dl>
  360. </li>
  361. </ul>
  362. <a name="AbstractCpsObject-classes.AbstractCpsObject-">
  363. <!-- -->
  364. </a>
  365. <ul class="blockListLast">
  366. <li class="blockList">
  367. <h4>AbstractCpsObject</h4>
  368. <pre>public&nbsp;AbstractCpsObject(<a href="../classes/AbstractCpsObject.html" title="class in classes">AbstractCpsObject</a>&nbsp;obj)</pre>
  369. <div class="block">Constructor for a new CpsObject with an unique ID (This constructor
  370. correspond to the interaction between the Categories and Canvas)-->
  371. actually the "new" Object is a copy.</div>
  372. <dl>
  373. <dt><span class="paramLabel">Parameters:</span></dt>
  374. <dd><code>obj</code> - Object to be copied</dd>
  375. </dl>
  376. </li>
  377. </ul>
  378. </li>
  379. </ul>
  380. <!-- ============ METHOD DETAIL ========== -->
  381. <ul class="blockList">
  382. <li class="blockList"><a name="method.detail">
  383. <!-- -->
  384. </a>
  385. <h3>Method Detail</h3>
  386. <a name="getObjName--">
  387. <!-- -->
  388. </a>
  389. <ul class="blockList">
  390. <li class="blockList">
  391. <h4>getObjName</h4>
  392. <pre>public&nbsp;java.lang.String&nbsp;getObjName()</pre>
  393. <div class="block">Getter for the type of the Object.</div>
  394. <dl>
  395. <dt><span class="returnLabel">Returns:</span></dt>
  396. <dd>String</dd>
  397. </dl>
  398. </li>
  399. </ul>
  400. <a name="setObjName-java.lang.String-">
  401. <!-- -->
  402. </a>
  403. <ul class="blockList">
  404. <li class="blockList">
  405. <h4>setObjName</h4>
  406. <pre>public&nbsp;void&nbsp;setObjName(java.lang.String&nbsp;objName)</pre>
  407. <div class="block">Set the type of Object.</div>
  408. <dl>
  409. <dt><span class="paramLabel">Parameters:</span></dt>
  410. <dd><code>objName</code> - String</dd>
  411. </dl>
  412. </li>
  413. </ul>
  414. <a name="getName--">
  415. <!-- -->
  416. </a>
  417. <ul class="blockList">
  418. <li class="blockList">
  419. <h4>getName</h4>
  420. <pre>public&nbsp;java.lang.String&nbsp;getName()</pre>
  421. <div class="block">Getter for the user-defined name (no unique).</div>
  422. <dl>
  423. <dt><span class="returnLabel">Returns:</span></dt>
  424. <dd>String</dd>
  425. </dl>
  426. </li>
  427. </ul>
  428. <a name="setName-java.lang.String-">
  429. <!-- -->
  430. </a>
  431. <ul class="blockList">
  432. <li class="blockList">
  433. <h4>setName</h4>
  434. <pre>public&nbsp;void&nbsp;setName(java.lang.String&nbsp;name)</pre>
  435. <div class="block">Set the name.</div>
  436. <dl>
  437. <dt><span class="paramLabel">Parameters:</span></dt>
  438. <dd><code>name</code> - String</dd>
  439. </dl>
  440. </li>
  441. </ul>
  442. <a name="getID--">
  443. <!-- -->
  444. </a>
  445. <ul class="blockList">
  446. <li class="blockList">
  447. <h4>getID</h4>
  448. <pre>public&nbsp;int&nbsp;getID()</pre>
  449. <div class="block">Getter of the unique ID.</div>
  450. <dl>
  451. <dt><span class="returnLabel">Returns:</span></dt>
  452. <dd>int</dd>
  453. </dl>
  454. </li>
  455. </ul>
  456. <a name="setID-int-">
  457. <!-- -->
  458. </a>
  459. <ul class="blockList">
  460. <li class="blockList">
  461. <h4>setID</h4>
  462. <pre>public&nbsp;void&nbsp;setID(int&nbsp;id)</pre>
  463. <div class="block">Set the ID to a new one.</div>
  464. <dl>
  465. <dt><span class="paramLabel">Parameters:</span></dt>
  466. <dd><code>id</code> - the iD to set</dd>
  467. </dl>
  468. </li>
  469. </ul>
  470. <a name="getImage--">
  471. <!-- -->
  472. </a>
  473. <ul class="blockList">
  474. <li class="blockList">
  475. <h4>getImage</h4>
  476. <pre>public&nbsp;java.lang.String&nbsp;getImage()</pre>
  477. <div class="block">Get the path of the image for the selected Object.</div>
  478. <dl>
  479. <dt><span class="returnLabel">Returns:</span></dt>
  480. <dd>String</dd>
  481. </dl>
  482. </li>
  483. </ul>
  484. <a name="setImage-java.lang.String-">
  485. <!-- -->
  486. </a>
  487. <ul class="blockList">
  488. <li class="blockList">
  489. <h4>setImage</h4>
  490. <pre>public&nbsp;void&nbsp;setImage(java.lang.String&nbsp;image)</pre>
  491. <div class="block">Set the path of the image.</div>
  492. <dl>
  493. <dt><span class="paramLabel">Parameters:</span></dt>
  494. <dd><code>image</code> - the Image to set</dd>
  495. </dl>
  496. </li>
  497. </ul>
  498. <a name="getConnections--">
  499. <!-- -->
  500. </a>
  501. <ul class="blockList">
  502. <li class="blockList">
  503. <h4>getConnections</h4>
  504. <pre>public&nbsp;java.util.ArrayList&lt;<a href="../classes/CpsEdge.html" title="class in classes">CpsEdge</a>&gt;&nbsp;getConnections()</pre>
  505. <div class="block">List of all existing connections.</div>
  506. <dl>
  507. <dt><span class="returnLabel">Returns:</span></dt>
  508. <dd>the connections ArrayList</dd>
  509. </dl>
  510. </li>
  511. </ul>
  512. <a name="setConnections-java.util.ArrayList-">
  513. <!-- -->
  514. </a>
  515. <ul class="blockList">
  516. <li class="blockList">
  517. <h4>setConnections</h4>
  518. <pre>public&nbsp;void&nbsp;setConnections(java.util.ArrayList&lt;<a href="../classes/CpsEdge.html" title="class in classes">CpsEdge</a>&gt;&nbsp;arrayList)</pre>
  519. <div class="block">Set a new ArrayList of connections (Update).</div>
  520. <dl>
  521. <dt><span class="paramLabel">Parameters:</span></dt>
  522. <dd><code>arrayList</code> - the connections to set</dd>
  523. </dl>
  524. </li>
  525. </ul>
  526. <a name="getConnectedTo--">
  527. <!-- -->
  528. </a>
  529. <ul class="blockList">
  530. <li class="blockList">
  531. <h4>getConnectedTo</h4>
  532. <pre>public&nbsp;java.util.ArrayList&lt;<a href="../classes/CpsEdge.html" title="class in classes">CpsEdge</a>&gt;&nbsp;getConnectedTo()</pre>
  533. <div class="block">List of all existing connections.</div>
  534. <dl>
  535. <dt><span class="returnLabel">Returns:</span></dt>
  536. <dd>the connections ArrayList</dd>
  537. </dl>
  538. </li>
  539. </ul>
  540. <a name="addConnection-classes.CpsEdge-">
  541. <!-- -->
  542. </a>
  543. <ul class="blockList">
  544. <li class="blockList">
  545. <h4>addConnection</h4>
  546. <pre>public&nbsp;void&nbsp;addConnection(<a href="../classes/CpsEdge.html" title="class in classes">CpsEdge</a>&nbsp;toConnect)</pre>
  547. <div class="block">Add a new connection to the selected Object.</div>
  548. <dl>
  549. <dt><span class="paramLabel">Parameters:</span></dt>
  550. <dd><code>toConnect</code> - Edge</dd>
  551. </dl>
  552. </li>
  553. </ul>
  554. <a name="setPosition-classes.Position-">
  555. <!-- -->
  556. </a>
  557. <ul class="blockList">
  558. <li class="blockList">
  559. <h4>setPosition</h4>
  560. <pre>public&nbsp;void&nbsp;setPosition(<a href="../classes/Position.html" title="class in classes">Position</a>&nbsp;pos)</pre>
  561. <div class="block">Set the position of the Object in the canvas.</div>
  562. <dl>
  563. <dt><span class="paramLabel">Parameters:</span></dt>
  564. <dd><code>pos</code> - Coordinates</dd>
  565. </dl>
  566. </li>
  567. </ul>
  568. <a name="setPosition-int-int-">
  569. <!-- -->
  570. </a>
  571. <ul class="blockList">
  572. <li class="blockList">
  573. <h4>setPosition</h4>
  574. <pre>public&nbsp;void&nbsp;setPosition(int&nbsp;x,
  575. int&nbsp;y)</pre>
  576. <div class="block">Set the position of the Object in the canvas.</div>
  577. <dl>
  578. <dt><span class="paramLabel">Parameters:</span></dt>
  579. <dd><code>x</code> - X-Coord</dd>
  580. <dd><code>y</code> - Y-Coord</dd>
  581. </dl>
  582. </li>
  583. </ul>
  584. <a name="getPosition--">
  585. <!-- -->
  586. </a>
  587. <ul class="blockList">
  588. <li class="blockList">
  589. <h4>getPosition</h4>
  590. <pre>public&nbsp;<a href="../classes/Position.html" title="class in classes">Position</a>&nbsp;getPosition()</pre>
  591. <div class="block">Get the actual position of the Object.</div>
  592. <dl>
  593. <dt><span class="returnLabel">Returns:</span></dt>
  594. <dd>Position Position of this Object</dd>
  595. </dl>
  596. </li>
  597. </ul>
  598. <a name="getSav--">
  599. <!-- -->
  600. </a>
  601. <ul class="blockList">
  602. <li class="blockList">
  603. <h4>getSav</h4>
  604. <pre>public&nbsp;java.lang.String&nbsp;getSav()</pre>
  605. <div class="block">For save purpose.</div>
  606. <dl>
  607. <dt><span class="returnLabel">Returns:</span></dt>
  608. <dd>the stored</dd>
  609. </dl>
  610. </li>
  611. </ul>
  612. <a name="setSav-java.lang.String-">
  613. <!-- -->
  614. </a>
  615. <ul class="blockList">
  616. <li class="blockList">
  617. <h4>setSav</h4>
  618. <pre>public&nbsp;void&nbsp;setSav(java.lang.String&nbsp;sav)</pre>
  619. <div class="block">For save purpose.</div>
  620. <dl>
  621. <dt><span class="paramLabel">Parameters:</span></dt>
  622. <dd><code>sav</code> - the stored to set</dd>
  623. </dl>
  624. </li>
  625. </ul>
  626. <a name="getBorderColor--">
  627. <!-- -->
  628. </a>
  629. <ul class="blockList">
  630. <li class="blockList">
  631. <h4>getBorderColor</h4>
  632. <pre>public&nbsp;java.awt.Color&nbsp;getBorderColor()</pre>
  633. <div class="block">Get the color of the border.</div>
  634. <dl>
  635. <dt><span class="returnLabel">Returns:</span></dt>
  636. <dd>the BorderColor</dd>
  637. </dl>
  638. </li>
  639. </ul>
  640. <a name="setBorderColor-java.awt.Color-">
  641. <!-- -->
  642. </a>
  643. <ul class="blockList">
  644. <li class="blockList">
  645. <h4>setBorderColor</h4>
  646. <pre>public&nbsp;void&nbsp;setBorderColor(java.awt.Color&nbsp;c)</pre>
  647. <div class="block">Set the Border Color of this CpsObject.</div>
  648. <dl>
  649. <dt><span class="paramLabel">Parameters:</span></dt>
  650. <dd><code>c</code> - the BorderColor</dd>
  651. </dl>
  652. </li>
  653. </ul>
  654. <a name="addTag-int-">
  655. <!-- -->
  656. </a>
  657. <ul class="blockList">
  658. <li class="blockList">
  659. <h4>addTag</h4>
  660. <pre>public&nbsp;void&nbsp;addTag(int&nbsp;tag)</pre>
  661. <div class="block">For internal purpose (energy flow).</div>
  662. <dl>
  663. <dt><span class="paramLabel">Parameters:</span></dt>
  664. <dd><code>tag</code> - for internal purpose</dd>
  665. </dl>
  666. </li>
  667. </ul>
  668. <a name="getTag--">
  669. <!-- -->
  670. </a>
  671. <ul class="blockList">
  672. <li class="blockList">
  673. <h4>getTag</h4>
  674. <pre>public&nbsp;java.util.ArrayList&lt;java.lang.Integer&gt;&nbsp;getTag()</pre>
  675. <div class="block">Get the actual tags.</div>
  676. <dl>
  677. <dt><span class="returnLabel">Returns:</span></dt>
  678. <dd>ArrayList</dd>
  679. </dl>
  680. </li>
  681. </ul>
  682. <a name="resetTags--">
  683. <!-- -->
  684. </a>
  685. <ul class="blockList">
  686. <li class="blockList">
  687. <h4>resetTags</h4>
  688. <pre>public&nbsp;void&nbsp;resetTags()</pre>
  689. <div class="block">Rest the tags to Null.</div>
  690. </li>
  691. </ul>
  692. <a name="setTags-java.util.ArrayList-">
  693. <!-- -->
  694. </a>
  695. <ul class="blockList">
  696. <li class="blockList">
  697. <h4>setTags</h4>
  698. <pre>public&nbsp;void&nbsp;setTags(java.util.ArrayList&lt;java.lang.Integer&gt;&nbsp;tags)</pre>
  699. <div class="block">For internal purpose (energy flow).</div>
  700. <dl>
  701. <dt><span class="paramLabel">Parameters:</span></dt>
  702. <dd><code>tags</code> - for internal purpose</dd>
  703. </dl>
  704. </li>
  705. </ul>
  706. <a name="setPseudoTags-java.util.ArrayList-">
  707. <!-- -->
  708. </a>
  709. <ul class="blockList">
  710. <li class="blockList">
  711. <h4>setPseudoTags</h4>
  712. <pre>public&nbsp;void&nbsp;setPseudoTags(java.util.ArrayList&lt;java.lang.Integer&gt;&nbsp;tags)</pre>
  713. <div class="block">For internal purpose (energy flow).</div>
  714. <dl>
  715. <dt><span class="paramLabel">Parameters:</span></dt>
  716. <dd><code>tags</code> - for internal purpose</dd>
  717. </dl>
  718. </li>
  719. </ul>
  720. <a name="getPseudoTags--">
  721. <!-- -->
  722. </a>
  723. <ul class="blockList">
  724. <li class="blockList">
  725. <h4>getPseudoTags</h4>
  726. <pre>public&nbsp;java.util.ArrayList&lt;java.lang.Integer&gt;&nbsp;getPseudoTags()</pre>
  727. <div class="block">Get the pseudo tags.</div>
  728. <dl>
  729. <dt><span class="returnLabel">Returns:</span></dt>
  730. <dd>ArrayList</dd>
  731. </dl>
  732. </li>
  733. </ul>
  734. <a name="addPseudoTag--">
  735. <!-- -->
  736. </a>
  737. <ul class="blockListLast">
  738. <li class="blockList">
  739. <h4>addPseudoTag</h4>
  740. <pre>public&nbsp;java.util.ArrayList&lt;java.lang.Integer&gt;&nbsp;addPseudoTag()</pre>
  741. <div class="block">add a pseudo tag.</div>
  742. <dl>
  743. <dt><span class="returnLabel">Returns:</span></dt>
  744. <dd>ArrayList</dd>
  745. </dl>
  746. </li>
  747. </ul>
  748. </li>
  749. </ul>
  750. </li>
  751. </ul>
  752. </div>
  753. </div>
  754. <!-- ========= END OF CLASS DATA ========= -->
  755. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  756. <div class="bottomNav"><a name="navbar.bottom">
  757. <!-- -->
  758. </a>
  759. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  760. <a name="navbar.bottom.firstrow">
  761. <!-- -->
  762. </a>
  763. <ul class="navList" title="Navigation">
  764. <li><a href="../overview-summary.html">Overview</a></li>
  765. <li><a href="package-summary.html">Package</a></li>
  766. <li class="navBarCell1Rev">Class</li>
  767. <li><a href="class-use/AbstractCpsObject.html">Use</a></li>
  768. <li><a href="package-tree.html">Tree</a></li>
  769. <li><a href="../deprecated-list.html">Deprecated</a></li>
  770. <li><a href="../index-files/index-1.html">Index</a></li>
  771. <li><a href="../help-doc.html">Help</a></li>
  772. </ul>
  773. </div>
  774. <div class="subNav">
  775. <ul class="navList">
  776. <li>Prev&nbsp;Class</li>
  777. <li><a href="../classes/Category.html" title="class in classes"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  778. </ul>
  779. <ul class="navList">
  780. <li><a href="../index.html?classes/AbstractCpsObject.html" target="_top">Frames</a></li>
  781. <li><a href="AbstractCpsObject.html" target="_top">No&nbsp;Frames</a></li>
  782. </ul>
  783. <ul class="navList" id="allclasses_navbar_bottom">
  784. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  785. </ul>
  786. <div>
  787. <script type="text/javascript"><!--
  788. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  789. if(window==top) {
  790. allClassesLink.style.display = "block";
  791. }
  792. else {
  793. allClassesLink.style.display = "none";
  794. }
  795. //-->
  796. </script>
  797. </div>
  798. <div>
  799. <ul class="subNavList">
  800. <li>Summary:&nbsp;</li>
  801. <li>Nested&nbsp;|&nbsp;</li>
  802. <li>Field&nbsp;|&nbsp;</li>
  803. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  804. <li><a href="#method.summary">Method</a></li>
  805. </ul>
  806. <ul class="subNavList">
  807. <li>Detail:&nbsp;</li>
  808. <li>Field&nbsp;|&nbsp;</li>
  809. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  810. <li><a href="#method.detail">Method</a></li>
  811. </ul>
  812. </div>
  813. <a name="skip.navbar.bottom">
  814. <!-- -->
  815. </a></div>
  816. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  817. </body>
  818. </html>