Changeset 298:24c67ec5cdca for src/mlx/soundsched.py

Timestamp:

07/21/12 12:43:34 (12 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Documented the non-GUI modules

File:

• src/mlx/soundsched.py (modified) (2 diffs)

src/mlx/soundsched.py

@@ -1 @@
-# Module to schedule the sounds to be played
-
-#------------------------------------------------------------------------------
 
 from sound import startSound
@@ -8 +5 @@
 
 import threading
+
+#------------------------------------------------------------------------------
+
+## @package mlx.soundsched
+#
+# Sound playback scheduling.
+#
+# The logger may play certain sound files when certain conditions hold. For
+# example, if the landing or the strobe lights are switched on during taxi, and
+# we go to the takeoff state, a voice says "Cabin crew, please take your seats
+# for takeoff". Some sounds are played only when the pilot presses a hotkey, if
+# the program is set up that way.
+#
+# Each sound is represented by an instance of a subclass of \ref Sound. If a
+# new \ref mlx.fs.AircraftState "aircraft state" comes in from the simulator,
+# the \ref Sound.shouldPlay "shouldPlay" functions of the registered sound
+# objects are called with that state, and if the function returns \c True, the
+# corresponding sound file is played.
+#
+# The \ref ChecklistScheduler class handles the playback of the checklists,
+# which are basically sequences of sound files played back one-by-one when a
+# certain hotkey is pressed.
 
 #------------------------------------------------------------------------------