Refine the interactions between the hooks provided by the different modules.

[lttv.git] / ltt / branches / poly / include / lttv / batchAnalysis.h

diff --git a/ltt/branches/poly/include/lttv/batchAnalysis.h b/ltt/branches/poly/include/lttv/batchAnalysis.h
new file mode 100644 (file)
index 0000000..f166178
--- /dev/null
+++ b/ltt/branches/poly/include/lttv/batchAnalysis.h
@@ -0,0 +1,44 @@
+#ifndef BATCH_ANALYSIS_H
+#define BATCH_ANALYSIS_H
+
+/* The batch analysis module defines a main traceset and command line options
+   to specify the traces in the main traceset. It then processes that
+   traceset calling hooks lists at various stages of the analysis.
+
+   The hooks lists are defined in the global attributes for these various 
+   stages of the analysis. Loaded modules may add hooks to these lists.
+   Thus, by requesting that a certain module be loaded, the analysis may
+   produce additional information as the module adds hooks and these hooks
+   are called during the analysis.
+
+   The hooks lists defined are as follows. These may be split in more
+   specific lists eventually to select the hooks applicable to state update,
+   incremental or batch processing...
+ 
+   /hooks/traceset/before
+       Before analyzing a traceset.
+
+   /hooks/traceset/after
+       After analyzing a traceset.
+
+   /hooks/trace/before
+       Before each trace.
+
+   /hooks/trace/after
+       After each trace.
+
+   /hooks/tracefile/before
+       Before each tracefile.
+
+   /hooks/tracefile/after
+       After each tracefile.
+
+   /hooks/event/before
+       Before each event.
+
+   /hooks/event/after
+       After each event.
+
+*/
+
+#endif // BATCH_ANALYSIS_H