HelpSource/Classes/AbstractResponderFunc.schelp

   1 CLASS:: AbstractResponderFunc
   2 summary:: Abstract superclass of responder func objects
   3 categories:: External Control>Abstract Classes
   4 related:: Classes/OSCFunc, Classes/OSCdef, Classes/MIDIFunc, Classes/MIDIdef, Classes/AbstractDispatcher
   5
   6 DESCRIPTION::
   7 AbstractResponderFunc is the abstract superclass of responder funcs, which are classes which register one or more functions to respond to a particular type of input. It provides some common functionality such as introspection. Its two main subclasses are link::Classes/OSCFunc::, and link::Classes/MIDIFunc::. By default responder funcs do not persist beyond Cmd-. (see link::#-permanent:: below).
   8
   9 Instances will register with a dispatcher (an instance of a subclass of link::Classes/AbstractDispatcher::), which will actually dispatch incoming messages to an instance's Function(s).
  10
  11
  12 CLASSMETHODS::
  13
  14 private:: initClass
  15
  16 METHOD:: allFuncProxies
  17 Get all current instances of this classes concrete subclasses, sorted by type.
  18
  19 returns:: An link::Classes/IdentityDictionary::.
  20
  21 METHOD:: allEnabled
  22 As allFuncProxies above, but only return those instances currently listening for input.
  23
  24 returns:: An link::Classes/IdentityDictionary::.
  25
  26 METHOD:: allDisabled
  27 As allFuncProxies above, but only return those instances currently not listening for input.
  28
  29 returns:: An link::Classes/IdentityDictionary::.
  30
  31
  32 INSTANCEMETHODS::
  33 private:: cmdPeriod, prFunc
  34
  35 METHOD:: func
  36 Get or set this objects response function.
  37
  38 returns:: The getter returns a link::Classes/Function:: or similar object.
  39
  40 METHOD:: srcID
  41 Get this object's source.
  42
  43 returns:: The return type will depend on subclass. For link::Classes/OSCFunc:: this will be a link::Classes/NetAddr::, for link::Classes/MIDIFunc:: a UID. This can can be nil, which indicates that the object will respond to any source.
  44
  45 METHOD:: enabled
  46 Check if this object is currently responding to incoming messages.
  47
  48 returns:: A link::Classes/Boolean::.
  49
  50 METHOD:: dispatcher
  51 et this object's dispatcher. This is the object which matches incoming messages with responder funcs. Instances can use custom dispatchers to support arbitrary matching schemes.
  52
  53 returns:: An instance of an appropriate subclass of link::Classes/AbstractDispatcher::. (The return type will depend on subclass.)
  54
  55 METHOD:: permanent
  56 Get or set whether this responder func is persists when the user executes Cmd-. If false this will be disabled and removed from the global lists. The default is false.
  57
  58 argument:: bool
  59 A link::Classes/Boolean:: indicating if this object is permanent.
  60
  61 returns:: The getter returns a link::Classes/Boolean::.
  62
  63 METHOD:: enable
  64 Enable this object to receive incoming messages. This is done automatically at creation time.
  65
  66 METHOD:: disable
  67 Stop this object from receiving incoming messages.
  68
  69 METHOD:: add
  70 Add a new function to the list of functions which will be executed when this object receives an incoming message.
  71
  72 argument:: newFunc
  73 A link::Classes/Function:: or similar object to be added.
  74
  75 METHOD:: remove
  76 Remove a function from the list of functions which will be executed when this object receives an incoming message.
  77
  78 argument:: removeFunc
  79 The link::Classes/Function:: to be removed.
  80
  81 METHOD:: gui
  82 Open a subclass specific GUI. (Not yet implemented)
  83
  84 returns:: The GUI object.
  85
  86 METHOD:: oneShot
  87 Indicate that this object should execute only once and then free itself.
  88
  89 METHOD:: fix
  90 A synonym for link::#permanent::
  91
  92 METHOD:: free
  93 Disable this object and remove it from the global lists. This should be done when you are finished using this object.
  94
  95 METHOD:: clear
  96 Remove all active functions from this object's function list.
  97
  98
  99 EXAMPLES::
 100
 101 See link::Classes/OSCFunc:: and link::Classe/MIDIFunc::.