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