HelpSource/Classes/LibraryBase.schelp

   1 CLASS::LibraryBase
   2 summary::Abstract global storage class
   3 categories:: Collections
   4
   5 DESCRIPTION::
   6 Base class for link::Classes/Library:: and link::Classes/Archive::
   7
   8 There is only one global instance: Archive.global, or Library.global, which is initialized automatically in the subclasses.
   9
  10 CLASSMETHODS::
  11
  12 method::global
  13 Subclass responsibility
  14
  15 method::clear
  16 Clear the dictionary
  17
  18 method::at
  19 Access the dictionary at a path with keys. The keys may be any object, but are usually link::Classes/Symbol::s.
  20
  21 method::put
  22 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 link::Classes/Symbol::s.
  23
  24 method::atList
  25 Access the dictionary at a path, given as a list of keys. The keys may be any object, but are usually link::Classes/Symbol::s.
  26
  27 method::putList
  28 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 link::Classes/Symbol::s.
  29
  30 EXAMPLES::
  31
  32 code::
  33 // an example from the subclass Library:
  34
  35 Library.put(\multi, \level, \addressing, \system, "i'm the thing you are putting in here");
  36 Library.at(\multi, \level, \addressing, \system).postln;
  37 Library.atList([\multi, \level, \addressing, \system]).postln;
  38 ::