Changes between Version 5 and Version 6 of BoltImpl

Timestamp:

Jun 19, 2008, 1:14:36 PM (16 years ago)

Author:

davea

Comment:

--

BoltImpl

@@ -81 +81 @@
    * !BoltSelect
 
-!BoltUnit has an abstract function
-{{{
-walk(&$iter, $incr, &$frac_done);
-}}}
-where $iter is a !BoltIter object (see below).
-This does the following:
-
- * Add a unit state structure for this unit to $iter->state.
- *
-It is implemented in different ways in the different derived classes.
+Each !BoltUnit implements an abstract interface (see below).
 
 === Course state ===
@@ -109 +100 @@
 === !BoltIter ===
 
-This object is used within the Bolt scheduler.
+This object is the central data structure of the Bolt scheduler.
 It includes:
 
- '''top''':: the root of the course structure.
+'''top''': the root of the course structure.
 
- '''state''':: the course state (from the latest !BoltView record).
+'''state''': the course state (from the latest !BoltView record).
 
- '''xset''':: the xset we're currently in, if any.
+'''xset''': the xset we're currently in, if any.
 
- '''item''':: the current item
+'''item''': the current item
 
- '''frac_done''':: fraction of course completed so far
+'''frac_done''': fraction of course completed so far
 
 Its member functions are:
 
- '''at()''':: get current item and fraction done
- '''next()''':: move to next item
+'''at()''': get current item and fraction done
+
+'''next()''': move to next item
 
 These are both implemented by calling walk() on the root unit.
+
+=== The interface of !BoltUnit ===
+
+!BoltUnit has an abstract function
+{{{
+walk(&$iter, $incr, &$frac_done);
+}}}
+where $iter is a !BoltIter object (see below).
+It is implemented in different ways in the different derived classes.
+For !BoltSet it does the following:
+
+ * If there's no unit state record in the course state, set an initial state.
+ * Otherwise, look up the current child unit, first by name, then by array index.
+ * Add or replace a unit state record in the $iter->state
+ * If child is a !BoltItem, set $iter->item; otherwise call child->walk().