| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|---|
| 2 | <!-- NewPage -->
|
|---|
| 3 | <html lang="en">
|
|---|
| 4 | <head>
|
|---|
| 5 | <!-- Generated by javadoc (1.8.0_112) on Thu Jun 21 12:05:56 CEST 2018 -->
|
|---|
| 6 | <title>AgentID (Genius Core Documentation)</title>
|
|---|
| 7 | <meta name="date" content="2018-06-21">
|
|---|
| 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="AgentID (Genius Core Documentation)";
|
|---|
| 16 | }
|
|---|
| 17 | }
|
|---|
| 18 | catch(err) {
|
|---|
| 19 | }
|
|---|
| 20 | //-->
|
|---|
| 21 | var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10};
|
|---|
| 22 | var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/AgentID.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-all.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="../../genius/core/AgentAdapter.html" title="class in genius.core"><span class="typeNameLink">Prev Class</span></a></li>
|
|---|
| 53 | <li><a href="../../genius/core/AgentParam.html" title="class in genius.core"><span class="typeNameLink">Next Class</span></a></li>
|
|---|
| 54 | </ul>
|
|---|
| 55 | <ul class="navList">
|
|---|
| 56 | <li><a href="../../index.html?genius/core/AgentID.html" target="_top">Frames</a></li>
|
|---|
| 57 | <li><a href="AgentID.html" target="_top">No Frames</a></li>
|
|---|
| 58 | </ul>
|
|---|
| 59 | <ul class="navList" id="allclasses_navbar_top">
|
|---|
| 60 | <li><a href="../../allclasses-noframe.html">All 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: </li>
|
|---|
| 77 | <li>Nested | </li>
|
|---|
| 78 | <li>Field | </li>
|
|---|
| 79 | <li><a href="#constructor.summary">Constr</a> | </li>
|
|---|
| 80 | <li><a href="#method.summary">Method</a></li>
|
|---|
| 81 | </ul>
|
|---|
| 82 | <ul class="subNavList">
|
|---|
| 83 | <li>Detail: </li>
|
|---|
| 84 | <li>Field | </li>
|
|---|
| 85 | <li><a href="#constructor.detail">Constr</a> | </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">genius.core</div>
|
|---|
| 96 | <h2 title="Class AgentID" class="title">Class AgentID</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>genius.core.AgentID</li>
|
|---|
| 104 | </ul>
|
|---|
| 105 | </li>
|
|---|
| 106 | </ul>
|
|---|
| 107 | <div class="description">
|
|---|
| 108 | <ul class="blockList">
|
|---|
| 109 | <li class="blockList">
|
|---|
| 110 | <dl>
|
|---|
| 111 | <dt>All Implemented Interfaces:</dt>
|
|---|
| 112 | <dd>java.io.Serializable</dd>
|
|---|
| 113 | </dl>
|
|---|
| 114 | <hr>
|
|---|
| 115 | <br>
|
|---|
| 116 | <pre>public class <span class="typeNameLabel">AgentID</span>
|
|---|
| 117 | extends java.lang.Object
|
|---|
| 118 | implements java.io.Serializable</pre>
|
|---|
| 119 | <div class="block">Unique ID for an agent. Immutable. Not guaranteed to be unique.</div>
|
|---|
| 120 | <dl>
|
|---|
| 121 | <dt><span class="seeLabel">See Also:</span></dt>
|
|---|
| 122 | <dd><a href="../../serialized-form.html#genius.core.AgentID">Serialized Form</a></dd>
|
|---|
| 123 | </dl>
|
|---|
| 124 | </li>
|
|---|
| 125 | </ul>
|
|---|
| 126 | </div>
|
|---|
| 127 | <div class="summary">
|
|---|
| 128 | <ul class="blockList">
|
|---|
| 129 | <li class="blockList">
|
|---|
| 130 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|---|
| 131 | <ul class="blockList">
|
|---|
| 132 | <li class="blockList"><a name="constructor.summary">
|
|---|
| 133 | <!-- -->
|
|---|
| 134 | </a>
|
|---|
| 135 | <h3>Constructor Summary</h3>
|
|---|
| 136 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|---|
| 137 | <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|---|
| 138 | <tr>
|
|---|
| 139 | <th class="colOne" scope="col">Constructor and Description</th>
|
|---|
| 140 | </tr>
|
|---|
| 141 | <tr class="altColor">
|
|---|
| 142 | <td class="colOne"><code><span class="memberNameLink"><a href="../../genius/core/AgentID.html#AgentID-java.lang.String-">AgentID</a></span>(java.lang.String id)</code> </td>
|
|---|
| 143 | </tr>
|
|---|
| 144 | </table>
|
|---|
| 145 | </li>
|
|---|
| 146 | </ul>
|
|---|
| 147 | <!-- ========== METHOD SUMMARY =========== -->
|
|---|
| 148 | <ul class="blockList">
|
|---|
| 149 | <li class="blockList"><a name="method.summary">
|
|---|
| 150 | <!-- -->
|
|---|
| 151 | </a>
|
|---|
| 152 | <h3>Method Summary</h3>
|
|---|
| 153 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|---|
| 154 | <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|---|
| 155 | <tr>
|
|---|
| 156 | <th class="colFirst" scope="col">Modifier and Type</th>
|
|---|
| 157 | <th class="colLast" scope="col">Method and Description</th>
|
|---|
| 158 | </tr>
|
|---|
| 159 | <tr id="i0" class="altColor">
|
|---|
| 160 | <td class="colFirst"><code>boolean</code></td>
|
|---|
| 161 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentID.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> </td>
|
|---|
| 162 | </tr>
|
|---|
| 163 | <tr id="i1" class="rowColor">
|
|---|
| 164 | <td class="colFirst"><code>static <a href="../../genius/core/AgentID.html" title="class in genius.core">AgentID</a></code></td>
|
|---|
| 165 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentID.html#generateID-java.lang.String-">generateID</a></span>(java.lang.String basename)</code>
|
|---|
| 166 | <div class="block">factory function</div>
|
|---|
| 167 | </td>
|
|---|
| 168 | </tr>
|
|---|
| 169 | <tr id="i2" class="altColor">
|
|---|
| 170 | <td class="colFirst"><code>java.lang.String</code></td>
|
|---|
| 171 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentID.html#getName--">getName</a></span>()</code> </td>
|
|---|
| 172 | </tr>
|
|---|
| 173 | <tr id="i3" class="rowColor">
|
|---|
| 174 | <td class="colFirst"><code>int</code></td>
|
|---|
| 175 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentID.html#hashCode--">hashCode</a></span>()</code> </td>
|
|---|
| 176 | </tr>
|
|---|
| 177 | <tr id="i4" class="altColor">
|
|---|
| 178 | <td class="colFirst"><code>java.lang.String</code></td>
|
|---|
| 179 | <td class="colLast"><code><span class="memberNameLink"><a href="../../genius/core/AgentID.html#toString--">toString</a></span>()</code> </td>
|
|---|
| 180 | </tr>
|
|---|
| 181 | </table>
|
|---|
| 182 | <ul class="blockList">
|
|---|
| 183 | <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|---|
| 184 | <!-- -->
|
|---|
| 185 | </a>
|
|---|
| 186 | <h3>Methods inherited from class java.lang.Object</h3>
|
|---|
| 187 | <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
|
|---|
| 188 | </ul>
|
|---|
| 189 | </li>
|
|---|
| 190 | </ul>
|
|---|
| 191 | </li>
|
|---|
| 192 | </ul>
|
|---|
| 193 | </div>
|
|---|
| 194 | <div class="details">
|
|---|
| 195 | <ul class="blockList">
|
|---|
| 196 | <li class="blockList">
|
|---|
| 197 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|---|
| 198 | <ul class="blockList">
|
|---|
| 199 | <li class="blockList"><a name="constructor.detail">
|
|---|
| 200 | <!-- -->
|
|---|
| 201 | </a>
|
|---|
| 202 | <h3>Constructor Detail</h3>
|
|---|
| 203 | <a name="AgentID-java.lang.String-">
|
|---|
| 204 | <!-- -->
|
|---|
| 205 | </a>
|
|---|
| 206 | <ul class="blockListLast">
|
|---|
| 207 | <li class="blockList">
|
|---|
| 208 | <h4>AgentID</h4>
|
|---|
| 209 | <pre>public AgentID(java.lang.String id)</pre>
|
|---|
| 210 | </li>
|
|---|
| 211 | </ul>
|
|---|
| 212 | </li>
|
|---|
| 213 | </ul>
|
|---|
| 214 | <!-- ============ METHOD DETAIL ========== -->
|
|---|
| 215 | <ul class="blockList">
|
|---|
| 216 | <li class="blockList"><a name="method.detail">
|
|---|
| 217 | <!-- -->
|
|---|
| 218 | </a>
|
|---|
| 219 | <h3>Method Detail</h3>
|
|---|
| 220 | <a name="generateID-java.lang.String-">
|
|---|
| 221 | <!-- -->
|
|---|
| 222 | </a>
|
|---|
| 223 | <ul class="blockList">
|
|---|
| 224 | <li class="blockList">
|
|---|
| 225 | <h4>generateID</h4>
|
|---|
| 226 | <pre>public static <a href="../../genius/core/AgentID.html" title="class in genius.core">AgentID</a> generateID(java.lang.String basename)</pre>
|
|---|
| 227 | <div class="block">factory function</div>
|
|---|
| 228 | <dl>
|
|---|
| 229 | <dt><span class="paramLabel">Parameters:</span></dt>
|
|---|
| 230 | <dd><code>basename</code> - the basename for the agent ID</dd>
|
|---|
| 231 | <dt><span class="returnLabel">Returns:</span></dt>
|
|---|
| 232 | <dd>a new unique AgentID based on the basename plus a unique serial
|
|---|
| 233 | number. These are unique only for a single run of the system, you
|
|---|
| 234 | can not assume new generated IDs to be different from IDs
|
|---|
| 235 | generated in earlier runs.</dd>
|
|---|
| 236 | </dl>
|
|---|
| 237 | </li>
|
|---|
| 238 | </ul>
|
|---|
| 239 | <a name="hashCode--">
|
|---|
| 240 | <!-- -->
|
|---|
| 241 | </a>
|
|---|
| 242 | <ul class="blockList">
|
|---|
| 243 | <li class="blockList">
|
|---|
| 244 | <h4>hashCode</h4>
|
|---|
| 245 | <pre>public int hashCode()</pre>
|
|---|
| 246 | <dl>
|
|---|
| 247 | <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|---|
| 248 | <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd>
|
|---|
| 249 | </dl>
|
|---|
| 250 | </li>
|
|---|
| 251 | </ul>
|
|---|
| 252 | <a name="equals-java.lang.Object-">
|
|---|
| 253 | <!-- -->
|
|---|
| 254 | </a>
|
|---|
| 255 | <ul class="blockList">
|
|---|
| 256 | <li class="blockList">
|
|---|
| 257 | <h4>equals</h4>
|
|---|
| 258 | <pre>public boolean equals(java.lang.Object obj)</pre>
|
|---|
| 259 | <dl>
|
|---|
| 260 | <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|---|
| 261 | <dd><code>equals</code> in class <code>java.lang.Object</code></dd>
|
|---|
| 262 | </dl>
|
|---|
| 263 | </li>
|
|---|
| 264 | </ul>
|
|---|
| 265 | <a name="toString--">
|
|---|
| 266 | <!-- -->
|
|---|
| 267 | </a>
|
|---|
| 268 | <ul class="blockList">
|
|---|
| 269 | <li class="blockList">
|
|---|
| 270 | <h4>toString</h4>
|
|---|
| 271 | <pre>public java.lang.String toString()</pre>
|
|---|
| 272 | <dl>
|
|---|
| 273 | <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|---|
| 274 | <dd><code>toString</code> in class <code>java.lang.Object</code></dd>
|
|---|
| 275 | </dl>
|
|---|
| 276 | </li>
|
|---|
| 277 | </ul>
|
|---|
| 278 | <a name="getName--">
|
|---|
| 279 | <!-- -->
|
|---|
| 280 | </a>
|
|---|
| 281 | <ul class="blockListLast">
|
|---|
| 282 | <li class="blockList">
|
|---|
| 283 | <h4>getName</h4>
|
|---|
| 284 | <pre>public java.lang.String getName()</pre>
|
|---|
| 285 | <dl>
|
|---|
| 286 | <dt><span class="returnLabel">Returns:</span></dt>
|
|---|
| 287 | <dd>the agent's name, but with the serial number ("@X" with X a
|
|---|
| 288 | integer) extension stripped if there is such an extension</dd>
|
|---|
| 289 | </dl>
|
|---|
| 290 | </li>
|
|---|
| 291 | </ul>
|
|---|
| 292 | </li>
|
|---|
| 293 | </ul>
|
|---|
| 294 | </li>
|
|---|
| 295 | </ul>
|
|---|
| 296 | </div>
|
|---|
| 297 | </div>
|
|---|
| 298 | <!-- ========= END OF CLASS DATA ========= -->
|
|---|
| 299 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|---|
| 300 | <div class="bottomNav"><a name="navbar.bottom">
|
|---|
| 301 | <!-- -->
|
|---|
| 302 | </a>
|
|---|
| 303 | <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|---|
| 304 | <a name="navbar.bottom.firstrow">
|
|---|
| 305 | <!-- -->
|
|---|
| 306 | </a>
|
|---|
| 307 | <ul class="navList" title="Navigation">
|
|---|
| 308 | <li><a href="../../overview-summary.html">Overview</a></li>
|
|---|
| 309 | <li><a href="package-summary.html">Package</a></li>
|
|---|
| 310 | <li class="navBarCell1Rev">Class</li>
|
|---|
| 311 | <li><a href="class-use/AgentID.html">Use</a></li>
|
|---|
| 312 | <li><a href="package-tree.html">Tree</a></li>
|
|---|
| 313 | <li><a href="../../deprecated-list.html">Deprecated</a></li>
|
|---|
| 314 | <li><a href="../../index-all.html">Index</a></li>
|
|---|
| 315 | <li><a href="../../help-doc.html">Help</a></li>
|
|---|
| 316 | </ul>
|
|---|
| 317 | </div>
|
|---|
| 318 | <div class="subNav">
|
|---|
| 319 | <ul class="navList">
|
|---|
| 320 | <li><a href="../../genius/core/AgentAdapter.html" title="class in genius.core"><span class="typeNameLink">Prev Class</span></a></li>
|
|---|
| 321 | <li><a href="../../genius/core/AgentParam.html" title="class in genius.core"><span class="typeNameLink">Next Class</span></a></li>
|
|---|
| 322 | </ul>
|
|---|
| 323 | <ul class="navList">
|
|---|
| 324 | <li><a href="../../index.html?genius/core/AgentID.html" target="_top">Frames</a></li>
|
|---|
| 325 | <li><a href="AgentID.html" target="_top">No Frames</a></li>
|
|---|
| 326 | </ul>
|
|---|
| 327 | <ul class="navList" id="allclasses_navbar_bottom">
|
|---|
| 328 | <li><a href="../../allclasses-noframe.html">All Classes</a></li>
|
|---|
| 329 | </ul>
|
|---|
| 330 | <div>
|
|---|
| 331 | <script type="text/javascript"><!--
|
|---|
| 332 | allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|---|
| 333 | if(window==top) {
|
|---|
| 334 | allClassesLink.style.display = "block";
|
|---|
| 335 | }
|
|---|
| 336 | else {
|
|---|
| 337 | allClassesLink.style.display = "none";
|
|---|
| 338 | }
|
|---|
| 339 | //-->
|
|---|
| 340 | </script>
|
|---|
| 341 | </div>
|
|---|
| 342 | <div>
|
|---|
| 343 | <ul class="subNavList">
|
|---|
| 344 | <li>Summary: </li>
|
|---|
| 345 | <li>Nested | </li>
|
|---|
| 346 | <li>Field | </li>
|
|---|
| 347 | <li><a href="#constructor.summary">Constr</a> | </li>
|
|---|
| 348 | <li><a href="#method.summary">Method</a></li>
|
|---|
| 349 | </ul>
|
|---|
| 350 | <ul class="subNavList">
|
|---|
| 351 | <li>Detail: </li>
|
|---|
| 352 | <li>Field | </li>
|
|---|
| 353 | <li><a href="#constructor.detail">Constr</a> | </li>
|
|---|
| 354 | <li><a href="#method.detail">Method</a></li>
|
|---|
| 355 | </ul>
|
|---|
| 356 | </div>
|
|---|
| 357 | <a name="skip.navbar.bottom">
|
|---|
| 358 | <!-- -->
|
|---|
| 359 | </a></div>
|
|---|
| 360 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|---|
| 361 | </body>
|
|---|
| 362 | </html>
|
|---|
![(please configure the [header_logo] section in trac.ini)](/pubtrac/Genius/chrome/site/your_project_logo.png){kind=logo}
