Changes between Version 4 and Version 5 of BoltImpl

Timestamp:

Jun 19, 2008, 12:19:02 PM (16 years ago)

Author:

davea

Comment:

--

BoltImpl

@@ -72 +72 @@
 A "course structure" is a tree of objects of the following types:
 
- * \BoltUnit
-  * BoltItem
-   * BoltLesson
-   * BoltExercise
-  * BoltSet
-   * BoltRandom
-    * BoltExerciseSet
-   * BoltSelect
+ * !BoltUnit
+  * !BoltItem
+   * !BoltLesson
+   * !BoltExercise
+  * !BoltSet
+   * !BoltRandom
+    * !BoltExerciseSet
+   * !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.
 
 === Course state ===
 
 A '''course state''' represents a student's position in a course.
-It consists of an array that maps unit names to "unit state" structures.
+It consists of an array that maps unit names to '''unit state''' structures.
 The contents of a unit state structure depends on the unit.
 Typically it includes the name of the current child,
@@ -94 +105 @@
 that the student is not currently in.
 
-Each BoltView record contains the course state when the view started.
+Each !BoltView record contains the course state when the view started.
 
-=== BoltIter ===
+=== !BoltIter ===
 
-This data structure is used within the Bolt scheduler.
+This object is used within 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
 
+These are both implemented by calling walk() on the root unit.