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

#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
Commit	Line	Data
dc877563	1	#ifndef BATCH_ANALYSIS_H
	2	#define BATCH_ANALYSIS_H
	3
	4	/* The batch analysis module defines a main traceset and command line options
	5	to specify the traces in the main traceset. It then processes that
	6	traceset calling hooks lists at various stages of the analysis.
	7
	8	The hooks lists are defined in the global attributes for these various
	9	stages of the analysis. Loaded modules may add hooks to these lists.
	10	Thus, by requesting that a certain module be loaded, the analysis may
	11	produce additional information as the module adds hooks and these hooks
	12	are called during the analysis.
	13
	14	The hooks lists defined are as follows. These may be split in more
	15	specific lists eventually to select the hooks applicable to state update,
	16	incremental or batch processing...
	17
	18	/hooks/traceset/before
	19	Before analyzing a traceset.
	20
	21	/hooks/traceset/after
	22	After analyzing a traceset.
	23
	24	/hooks/trace/before
	25	Before each trace.
	26
	27	/hooks/trace/after
	28	After each trace.
	29
	30	/hooks/tracefile/before
	31	Before each tracefile.
	32
	33	/hooks/tracefile/after
	34	After each tracefile.
	35
	36	/hooks/event/before
	37	Before each event.
	38
	39	/hooks/event/after
	40	After each event.
	41
	42	*/
	43
	44	#endif // BATCH_ANALYSIS_H