HelpSource/Classes/ObjectTable.schelp

   1 CLASS::ObjectTable
   2 summary::associate objects with IDs
   3 categories:: Collections>Unordered
   4
   5 DESCRIPTION::
   6 An ObjectTable is used to associate an id with an object. This is useful
   7 for enabling references to objects on remote systems via Open Sound Control.
   8
   9 CLASSMETHODS::
  10
  11 private::initClass
  12
  13 method::init
  14 Create the main ObjectTable. This is called in link::Classes/Main#-startUp::.
  15
  16 method::add
  17 Put an object in the main ObjectTable and generate an Integer id.
  18 argument::obj
  19 the object to put in the table.
  20
  21 method::put
  22 Put an object in the main ObjectTable under a specific key.
  23 argument::key
  24 a link::Classes/Symbol::.
  25 argument::obj
  26 the object to put in the table.
  27
  28 method::at
  29 Get an object in the main ObjectTable.
  30 argument::id
  31 an link::Classes/Integer:: or link::Classes/Symbol::.
  32
  33 method::getID
  34 Get the ID of an object in the table.
  35 argument::obj
  36 an object in the table.
  37
  38 INSTANCEMETHODS::
  39
  40 method::add
  41 Put an object in an ObjectTable and generate an Integer id.
  42 argument::obj
  43 the object to put in the table.