d0487cb539bf5a815f058c2743c5250f410a2528
[u/mrichter/AliRoot.git] / HLT / BASE / AliHLTEventStatistics.h
1 //-*- Mode: C++ -*-
2 // $Id$
3 #ifndef ALIHLTEVENTSTATISTICS_H
4 #define ALIHLTEVENTSTATISTICS_H
5
6 /* This file is property of and copyright by the ALICE HLT Project        * 
7  * ALICE Experiment at CERN, All rights reserved.                         *
8  * See cxx source for full Copyright notice                               */
9
10 /** @file   AliHLTEventStatistics.h
11     @author Jochen Thaeder
12     @date   
13     @brief  Base class for event statistics, for all detectors
14 */
15
16 // see below for class documentation
17 // or
18 // refer to README to build package
19 // or
20 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt   
21
22 /**
23  * @defgroup alihlt_run_statistics Event and run statistics for the HLT
24  * This section describes the event and run statistics as well as the 
25  * event and run summary handling for the HLT chain.
26  */
27
28 /**
29  * @defgroup alihlt_trigger Trigger components for the HLT.
30  * This section describes the handling of different triggers of the HLT.
31  */
32
33 #include "TObject.h"
34 #include "TString.h"
35
36 #include "AliHLTDataTypes.h"
37
38 /**
39  * @class  AliHLTEventStatistics
40  * @brief  Base class for event statistics, for all detectors
41  *
42  * The event statistic classes hold information about certain characteristica 
43  * of the processed events. They are devided into 3 parts. A base class 
44  * @see AliHLTEventStatistics for general Information, detector specific
45  * classes like @see AliHLTTPCEventStatistics for the TPC and a summary class
46  * @see AliHLTEventStatisticsSummary which can hold several detector classes.
47  *
48  * This is the base class.
49  *
50  * Currently implemented detecor classes<BR/>
51  * * @see AliHLTTPCEventStatistics<BR/>
52  *
53  * @ingroup alihlt_run_statistics alihlt_trigger
54  */
55
56 class AliHLTEventStatistics : public TObject {
57   
58 public:
59   
60   /** constructor */
61   AliHLTEventStatistics();
62   /** destructor */
63   virtual ~AliHLTEventStatistics();
64
65   /** Get detector name
66    *  @return name of detector
67    */
68   TString GetDetectorName()                              { return fDetectorName; }
69
70   /** Set Total number of tracks 
71    *  @param s  number of tracks
72    */
73   void SetDetectorName( TString s )                      { fDetectorName = s; }
74
75 private:
76
77   /** copy constructor prohibited */
78   AliHLTEventStatistics (const AliHLTEventStatistics&);
79
80   /** assignment operator prohibited */
81   AliHLTEventStatistics& operator= (const AliHLTEventStatistics&);
82
83   /** Detector Name */
84   TString fDetectorName;                       // see above
85
86   ClassDef(AliHLTEventStatistics, 0);
87
88 };
89 #endif
90