MarlinTPC  1.2.0
DumpEventProcessor.h
1 #ifndef DumpEventProcessor_h
2 #define DumpEventProcessor_h 1
3 
4 // C++
5 #include <string>
6 
7 // LCIO
8 #include "lcio.h"
9 
10 // Marlin
11 #include "marlin/Processor.h"
12 
13 namespace AIDA{
14  class IAnalysisFactory ;
15  class ITreeFactory ;
16  class ITree ;
17  class IHistogramFactory ;
18  class ITupleFactory ;
19  class IDataPointSetFactory ;
20 }
21 
22 namespace marlintpc{
23 
24  /* the following comment is tranfered to doxygen documentation
25  * which begins with a second asterix, or in case of on line comment an extra third slash
26  */
37  class DumpEventProcessor : public marlin::Processor {
38 
39  public:
40 
41  /* This method will be called by the marlin package
42  * It returns a processor of the currend type (here DumpEventProcessor)
43  */
44  virtual Processor* newProcessor() { return new DumpEventProcessor ; }
45 
46  /* the default constructor
47  * here the processor parameters are registered to the marlin package
48  * other initialisation should be placed in the init method
49  */
51 
52  /* Called at the beginning of the job before anything is read.
53  * Use to initialize the processor, e.g. book histograms
54  */
55  virtual void init() ;
56 
57  /* Called for every run.
58  * in this processor it is not used
59  */
60  virtual void processRunHeader( lcio::LCRunHeader* run ) ;
61 
62  /* Called for every event - the working horse.
63  * Here the real conversion take place
64  */
65  virtual void processEvent( lcio::LCEvent * evt ) ;
66 
67  /* This method is only called if the check flag is set (default) in the main processor
68  * (where the input files are given)
69  * It should be used to create check plots which are not needed in a complete analysis
70  * (where normaly the check flag is deactivated)
71  */
72  virtual void check( lcio::LCEvent * evt ) ;
73 
74 
75  /* Called after data processing for clean up.
76  * e.g. saving control histogramms, delete created objects
77  * (which are not stored in a collection/event), etc.
78  */
79  virtual void end() ;
80 
81 
82  protected:
83 
84  /* normally the doxygen documentation is palced before the method/variable
85  * but for one line comments in case of variables it may be more convenied for you
86  * to place it after the variable. In this case you use an arrow to tell doxygen
87  * to which variable the commet belongs to.
88  */
89 
90 
91  } ;
92 
93 }
94 
95 #endif
96 
97 
98 
dumps events to shell
Definition: DumpEventProcessor.h:37