# HG changeset patch
# User j.forth <j.forth@gold.ac.uk>
# Date 1298546598 0
# Node ID 061ae49a0b41059920a5270a8ac478413c3e7512
# Parent  7a5618d334e4b6e8f3050f40fc7854de495cc377
add note about linked-events mixin

Ignore-this: c5677560055960b06b1689b7a89f6d39

darcs-hash:20100404210537-16a00-7ca82f871410639d74103e352ecad60979a128c9.gz

committer: Jamie Forth <j.forth@gold.ac.uk>

diff -r 7a5618d334e4 -r 061ae49a0b41 base/classes.lisp
--- a/base/classes.lisp	Thu Feb 24 11:23:18 2011 +0000
+++ b/base/classes.lisp	Thu Feb 24 11:23:18 2011 +0000
@@ -84,7 +84,19 @@
   ((composition :reader composition
 		:writer %set-composition
 		:initarg :composition))
-  (:documentation "This provides a composition slot for events."))
+  (:documentation "This provides a composition slot for events. The
+  generic function initialize-instance can be specialized on an
+  implementation composition to assign the event slots when a
+  composition instance is created. Or the slot can be assigned within
+  the composition constructor function. FIXME: Not sure about this -
+  was there a good reason why events should not know the composition
+  they belong to? MTP-events have a slot for composition-id (an
+  integer number), but here the slot is intended to be assigned the
+  composition object itself. Doing this means that potentially some
+  generic functions could loose the extra composition parameter. I
+  made this change because of SIA projection related stuff, the only
+  function that relies on it in amuse is find-next-event. JF"))
+
 (defclass pitched-event (event pitch) ()
   (:documentation "Event with pitch information"))
 (defclass standard-pitched-event (pitched-event