MarlinTPC  1.2.0
TPCHitToTrackerDataConverterProcessor.h
1 #ifndef TPCHitToTrackerDataConverterProcessor_h
2 #define TPCHitToTrackerDataConverterProcessor_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 marlintpc
14 {
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  */
36  class TPCHitToTrackerDataConverterProcessor : public marlin::Processor
37  {
38 
39  public:
40 
41  /* This method will be called by the marlin package
42  * It returns a processor of the currend type (here TrackerRawDataToDataConverter)
43  */
44  virtual Processor* newProcessor() { return new TPCHitToTrackerDataConverterProcessor ; }
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 begin 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  /* Called after data processing for clean up.
75  * e.g. saving contol histograms, delete created objects
76  * (which are not stored in a collection/event), etc.
77  */
78  virtual void end() ;
79 
80  protected:
81 
82  /* normally the doxygen documentation is placed before the method/variable
83  * but for one line comments in case of variables is may be more conviened to you
84  * to place it after the variable. In this case you use an arrow to tell doxygen
85  * to which variable the commet belong to.
86  */
87 
89  std::string _inputColName ;
91  std::string _outputColName ;
92 
97 
103 
105 
106  int _nRun ;
107  int _nEvt ;
108 
109  } ;
110 
111 }
112 #endif
int _nRun
Definition: TPCHitToTrackerDataConverterProcessor.h:106
bool isFirstCollection
is true till the first output collection is written to an event used to to store parameters only in t...
Definition: TPCHitToTrackerDataConverterProcessor.h:102
int _ignoreFirstNBins
Definition: TPCHitToTrackerDataConverterProcessor.h:104
TPCHit data converting Processor of the MarlinTPC package .
Definition: TPCHitToTrackerDataConverterProcessor.h:36
std::string _inputColName
<- the name of the input collection
Definition: TPCHitToTrackerDataConverterProcessor.h:89
int _nEvt
Definition: TPCHitToTrackerDataConverterProcessor.h:107
int _outputIsTransient
give the status which is set to the transient flag of the output collection it is an int instead of a...
Definition: TPCHitToTrackerDataConverterProcessor.h:96