Porting HLT doxygen documentation to cmake
[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 #include "TObject.h"
29 #include "TString.h"
30
31 #include "AliHLTDataTypes.h"
32
33 /**
34  * @class  AliHLTEventStatistics
35  * @brief  Base class for event statistics, for all detectors
36  *
37  * The event statistic classes hold information about certain characteristica 
38  * of the processed events. They are devided into 3 parts. A base class 
39  * @see AliHLTEventStatistics for general Information, detector specific
40  * classes like @see AliHLTTPCEventStatistics for the TPC and a summary class
41  * @see AliHLTEventStatisticsSummary which can hold several detector classes.
42  *
43  * This is the base class.
44  *
45  * Currently implemented detecor classes <br>
46  * * @see AliHLTTPCEventStatistics <br>
47  *
48  * @ingroup alihlt_run_statistics alihlt_trigger
49  */
50
51 class AliHLTEventStatistics : public TObject {
52   
53 public:
54   
55   /** constructor */
56   AliHLTEventStatistics();
57   /** destructor */
58   virtual ~AliHLTEventStatistics();
59
60   /** Get detector name
61    *  @return name of detector
62    */
63   TString GetDetectorName()                              { return fDetectorName; }
64
65   /** Set Total number of tracks 
66    *  @param s  number of tracks
67    */
68   void SetDetectorName( TString s )                      { fDetectorName = s; }
69
70 private:
71
72   /** copy constructor prohibited */
73   AliHLTEventStatistics (const AliHLTEventStatistics&);
74
75   /** assignment operator prohibited */
76   AliHLTEventStatistics& operator= (const AliHLTEventStatistics&);
77
78   /** Detector Name */
79   TString fDetectorName;                       // see above
80
81   ClassDef(AliHLTEventStatistics, 0);
82
83 };
84 #endif
85