Changeset 78b9d9 for molecuilder/src/Actions/Process.hpp

Timestamp:

Mar 3, 2010, 1:57:41 PM (16 years ago)

Author:

Tillmann Crueger <crueger@…>

Children:

14d898

Parents:

dc5413

Message:

Improved Doxygen documentation

File:

• molecuilder/src/Actions/Process.hpp (modified) (1 diff)

molecuilder/src/Actions/Process.hpp

@@ -19 +19 @@
 #include "Actions/Action.hpp"
 
+/**
+ * A Process is an Action that might take some time and therefore has special
+ * methods to allow communication with progress indicators. Indicators
+ * can sign on at a global place and will be notified when any process is doing
+ * a calculation.
+ *
+ * A Process has four states:
+ *  - starting: It is in the process of setting itself up, and wants everybody to know that it will start
+ *              the calculation soon. Indicators should set up anything they need for displaying the progress
+ *              when they are notified by a process in this state.
+ *  - active:   The process is currently doing it's thing and wants any indicator to know it's status, i.e.
+ *              the percentage done.
+ *  - stopping: The process has fullfilled it's purpose and is shutting down. Indicators recieving this status
+ *              should also use it to shut down their indication mechanism and delete any objects allocated for
+ *              this Process
+ *  - inactive: This Process is currently sleeping. If a Process is sending out any signals in this state, there
+ *              is something seriously wrong.
+ */
 class Process : public Action, public Observable
 {