HelpSource/Classes/ParGroup.schelp

   1 Class:: ParGroup
   2 summary:: Client-side representation of a parallel group node on the server
   3 categories:: Server>Nodes, Server>Abstractions
   4
   5 Description:: Parallel Groups are server-side node containers that work similar to link::Classes/Group::s, but without
   6 ordering constraints for the contained nodes. This means that on parallel architectures the elements of a Parallel Group
   7 can be executed concurrently.
   8
   9 ClassMethods::
  10 private:: creationCmd
  11
  12 subsection:: Creation with Immediate Instantiation on the Server
  13
  14 copymethod:: Group *new
  15
  16 subsection:: Convenience methods for add actions
  17 The following convenience methods correspond to the add actions above:
  18
  19 copymethod:: Group *after
  20 copymethod:: Group *before
  21 copymethod:: Group *head
  22 copymethod:: Group *tail
  23 copymethod:: Group *replace
  24
  25 subsection:: Creation without Instantiation on the Server
  26
  27 Like with Groups, it is possible to create a a ParGroup object without immediately creating a parallel group in the server.
  28
  29 method:: basicNew
  30 Create and return a ParGroup object without creating a group node on the server. (This method is inherited from Node and is documented here only for convenience.)
  31 argument:: server
  32 An optional instance of Server. If nil this will default to the default Server.
  33 argument:: nodeID
  34 An optional node ID number. If not supplied one will be generated by the Server's NodeIDAllocator. Normally you should not need to supply an ID.
  35
  36 discussion::
  37 For a detailed discussion please refer to link::Classes/Group#*basicNew::.
  38
  39 InstanceMethods::
  40
  41 copymethod:: Group -asGroup
  42
  43 Examples::
  44
  45 code::
  46 fork {
  47         p = ParGroup.new;
  48         loop {
  49                 (
  50                         degree: rrand(0.0, 12.0).round(1/4),
  51                         group: p,
  52                         db: rrand(-30, -25),
  53                         pan: rrand(-1.0, 1.0)
  54                 ).play;
  55                 0.2.wait;
  56         }
  57 }
  58 ::