Help/Collections/ObjectTable.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <title></title>
   7 <meta name="Generator" content="Cocoa HTML Writer">
   8 <meta name="CocoaVersion" content="949.43">
   9 <style type="text/css">
  10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 13.0px Arial}
  11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
  12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0000ff}
  13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
  14 span.s1 {font: 18.0px Helvetica}
  15 span.s2 {color: #000000}
  16 span.s3 {color: #0039da}
  17 span.s4 {color: #0024f8}
  18 span.Apple-tab-span {white-space:pre}
  19 </style>
  20 </head>
  21 <body>
  22 <p class="p1"><span class="s1"><b>ObjectTable<span class="Apple-tab-span">      </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></b></span><b>associate objects with IDs</b></p>
  23 <p class="p2"><br></p>
  24 <p class="p3"><span class="s2"><b>Inherits from: </b><a href="../Core/Object.html"><span class="s3"><b>Object</b></span></a> : <a href="Collection.html"><span class="s4"><b>Collection</b></span></a> : <a href="TwoWayIdentityDictionary.html"><b>TwoWayIdentityDictionary</b></a></span></p>
  25 <p class="p2"><br></p>
  26 <p class="p4">An ObjectTable is used to associate an id with an object. This is useful</p>
  27 <p class="p4">for enabling references to objects on remote systems via Open Sound Control.</p>
  28 <p class="p2"><br></p>
  29 <p class="p2"><br></p>
  30 <p class="p4"><b>*init</b></p>
  31 <p class="p2"><br></p>
  32 <p class="p4">Create the main ObjectTable. This is called in Main::startUp.</p>
  33 <p class="p2"><br></p>
  34 <p class="p2"><br></p>
  35 <p class="p4"><b>*add(obj)</b></p>
  36 <p class="p2"><br></p>
  37 <p class="p4">Put an object in the main ObjectTable and generate an Integer id.</p>
  38 <p class="p4"><b>obj</b> - the object to put in the table.</p>
  39 <p class="p2"><br></p>
  40 <p class="p2"><br></p>
  41 <p class="p4"><b>add(obj)</b></p>
  42 <p class="p2"><br></p>
  43 <p class="p4">Put an object in an ObjectTable and generate an Integer id.</p>
  44 <p class="p4"><b>obj</b> - the object to put in the table.</p>
  45 <p class="p2"><br></p>
  46 <p class="p2"><br></p>
  47 <p class="p4"><b>*put(key, obj)</b></p>
  48 <p class="p2"><br></p>
  49 <p class="p4">Put an object in the main ObjectTable under a specific key.<span class="Apple-converted-space"> </span></p>
  50 <p class="p4"><b>key</b> - a Symbol.</p>
  51 <p class="p4"><b>obj</b> - the object to put in the table.</p>
  52 <p class="p2"><br></p>
  53 <p class="p2"><br></p>
  54 <p class="p4"><b>*at(id)</b></p>
  55 <p class="p2"><br></p>
  56 <p class="p4">Get an object in the main ObjectTable.</p>
  57 <p class="p4"><b>id</b> - an Integer or Symbol.</p>
  58 <p class="p2"><br></p>
  59 <p class="p2"><br></p>
  60 <p class="p4"><b>*getID(obj)</b></p>
  61 <p class="p2"><br></p>
  62 <p class="p4">Get the ID of an object in the table.</p>
  63 <p class="p4"><b>obj</b> - an object in the table.</p>
  64 <p class="p2"><br></p>
  65 </body>
  66 </html>