Help/Collections/LibraryBase.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: 12.0px Helvetica}
  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: #0000bf}
  13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
  14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
  15 p.p6 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; min-height: 12.0px}
  16 p.p7 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica}
  17 p.p8 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica; min-height: 14.0px}
  18 p.p9 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 14.0px Helvetica}
  19 p.p10 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
  20 p.p11 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000; min-height: 12.0px}
  21 p.p12 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #606060}
  22 p.p13 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #007300}
  23 span.s1 {font: 18.0px Helvetica}
  24 span.s2 {color: #000000}
  25 span.s3 {color: #0000bf}
  26 span.s4 {color: #0000bf}
  27 span.s5 {color: #0000bf}
  28 span.s6 {color: #007300}
  29 span.Apple-tab-span {white-space:pre}
  30 </style>
  31 </head>
  32 <body>
  33 <p class="p1"><span class="s1"><b>LibraryBase<span class="Apple-tab-span">      </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></b></span><b>global storage base class</b><span class="s1"><b><span class="Apple-tab-span">     </span></b></span></p>
  34 <p class="p2"><br></p>
  35 <p class="p3"><span class="s2"><b>Inherits from: </b><a href="../Core/Object.html"><span class="s3"><b>Object</b></span></a><b> : </b><a href="Collection.html"><b>Collection</b></a><b> : </b><a href="MultiLevelIdentityDictionary.html"><b>MultiLevelIdentityDictionary</b></a></span></p>
  36 <p class="p4"><br></p>
  37 <p class="p1">Base class for <a href="Library.html"><span class="s4">Library</span></a> and <a href="Archive.html"><span class="s4">Archive</span></a></p>
  38 <p class="p2"><br></p>
  39 <p class="p1">There is only one global instance: Archive.global, or Library.global, which is initialized automatically in the subclasses.</p>
  40 <p class="p2"><br></p>
  41 <p class="p5"><b>Class Methods</b></p>
  42 <p class="p6"><br></p>
  43 <p class="p7"><b><span class="Apple-tab-span">  </span>*global</b></p>
  44 <p class="p7"><b><span class="Apple-tab-span">  </span>*global_(obj)</b></p>
  45 <p class="p7"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>subclass responsibility</p>
  46 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  47 <p class="p7"><span class="Apple-tab-span">     </span><b>*clear</b></p>
  48 <p class="p7"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>clear the dictionary</p>
  49 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  50 <p class="p7"><span class="Apple-tab-span">     </span><b>*at(key1, key2, ...)</b></p>
  51 <p class="p7"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>access the dictionary at a path with keys. The keys may be any object, but are usually <a href="../Core/Symbol.html"><span class="s4">Symbol</span></a>s</p>
  52 <p class="p8"><span class="Apple-tab-span">     </span></p>
  53 <p class="p7"><span class="Apple-tab-span">     </span><b>*put(key1, key2, ... obj)</b></p>
  54 <p class="p7"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>store an object in the dictionary at a path, given as a list of keys and the object to be stored as last argument. The keys may be any object, but are usually Symbols.</p>
  55 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  56 <p class="p7"><span class="Apple-tab-span">     </span><b>*atList(args)</b></p>
  57 <p class="p7"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>access the dictionary at a path, given as a list of keys. The keys may be any object, but are usually Symbols.</p>
  58 <p class="p8"><b><span class="Apple-tab-span">  </span></b></p>
  59 <p class="p7"><b><span class="Apple-tab-span">  </span>*putList(args)</b></p>
  60 <p class="p7"><b><span class="Apple-tab-span">  </span><span class="Apple-tab-span">    </span></b>store an object in the dictionary at a path, given as a list of keys and the object to be stored as last argument. The keys may be any object, but are usually Symbols.</p>
  61 <p class="p8"><span class="Apple-tab-span">     </span></p>
  62 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></p>
  63 <p class="p2"><br></p>
  64 <p class="p9"><b>Examples</b></p>
  65 <p class="p4"><br></p>
  66 <p class="p10">// an example from the subclass Library:</p>
  67 <p class="p11"><br></p>
  68 <p class="p12"><span class="s5">Library</span><span class="s2">.put(</span><span class="s6">\multi</span><span class="s2">, </span><span class="s6">\level</span><span class="s2">, </span><span class="s6">\addressing</span><span class="s2">, </span><span class="s6">\system</span><span class="s2">, </span>"i'm the thing you are putting in here"<span class="s2">);</span></p>
  69 <p class="p11"><br></p>
  70 <p class="p13"><span class="s5">Library</span><span class="s2">.at(</span>\multi<span class="s2">, </span>\level<span class="s2">, </span>\addressing<span class="s2">, </span>\system<span class="s2">).postln;</span></p>
  71 <p class="p11"><br></p>
  72 <p class="p13"><span class="s5">Library</span><span class="s2">.atList([</span>\multi<span class="s2">, </span>\level<span class="s2">, </span>\addressing<span class="s2">, </span>\system<span class="s2">]).postln;</span></p>
  73 <p class="p4"><br></p>
  74 </body>
  75 </html>