MarlinTPC  1.2.0
PrintEventNumberProcessor.h
1 #ifndef PrintEventNumberProcessor_h
2 #define PrintEventNumberProcessor_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 
14 namespace marlintpc{
15 
16  /* the following comment is tranfered to doxygen documentation
17  * which begins with a second asterix, or in case of on line comment an extra third slash
18  */
31  class PrintEventNumberProcessor : public marlin::Processor {
32 
33  public:
34 
35  /* This method will be called by the marlin package
36  * It returns a processor of the currend type (here PrintEventNumberProcessor)
37  */
38  virtual Processor* newProcessor() { return new PrintEventNumberProcessor ; }
39 
40  /* the default constructor
41  * here the processor parameters are registered to the marlin package
42  * other initialisation should be placed in the init method
43  */
45 
46  /* Called at the beginning of the job before anything is read.
47  * Use to initialize the processor, e.g. book histograms
48  */
49  virtual void init() ;
50 
51  /* Called for every run.
52  * in this processor it is not used
53  */
54  virtual void processRunHeader( lcio::LCRunHeader* run ) ;
55 
56  /* Called for every event - the working horse.
57  * Here the real conversion take place
58  */
59  virtual void processEvent( lcio::LCEvent * evt ) ;
60 
61  /* This method is only called if the check flag is set (default) in the main processor
62  * (where the input files are given)
63  * It should be used to create check plots which are not needed in a complete analysis
64  * (where normaly the check flag is deactivated)
65  */
66  virtual void check( lcio::LCEvent * evt ) ;
67 
68 
69  /* Called after data processing for clean up.
70  * e.g. saving control histogramms, delete created objects
71  * (which are not stored in a collection/event), etc.
72  */
73  virtual void end() ;
74 
75 
76  protected:
77 
80 
81  } ;
82 
83 }
84 
85 #endif
86 
87 
88 
Prints event numbers to the screen depending on the EveryNEvents variable.
Definition: PrintEventNumberProcessor.h:31
int _everyNEvents
variable how often to print the event number
Definition: PrintEventNumberProcessor.h:79