Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUONCheck.h
1 #ifndef ALIMUONCHECK_H
2 #define ALIMUONCHECK_H
3
4 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
5 * See cxx source for full Copyright notice                               */
6
7 // $Id$
8
9 /// \ingroup base
10 /// \class AliMUONCheck
11 /// \brief A helper class to dump data from AliRoot-generated root files.
12 /// 
13 /// Only implemented for digits so far, it is meant as a replacement
14 /// of the MUONCheck.C macro, or to be used by this macro to simplify it.
15 ///
16 /// \author Laurent Aphecetche
17
18 #ifndef ROOT_TObject
19 #  include "TObject.h"
20 #endif
21 #ifndef ROOT_TString
22 #  include "TString.h"
23 #endif
24
25 class AliMUONData;
26 class AliRunLoader;
27
28 class AliMUONCheck : public TObject
29 {
30 public:
31   AliMUONCheck(const char* galiceFile, Int_t firstEvent=0, Int_t lastEvent=-1);
32   virtual ~AliMUONCheck();
33   
34   Bool_t IsValid() const { return (fData!=0); }
35   
36   void DumpDigits(Option_t* opt="") const;
37   
38 private:
39   AliMUONCheck(const AliMUONCheck& rhs);
40   AliMUONCheck& operator=(const AliMUONCheck& rhs);
41   
42 private:
43   TString fFileName;   //!< File (galice.root) to read from
44   Int_t   fFirstEvent; //!< First event to consider
45   Int_t   fLastEvent;  //!< Last event to consider
46   AliRunLoader* fRunLoader; //!< AliRunLoader pointer
47   AliMUONData*  fData; //!< AliMUONData pointer (to access containers)
48
49   ClassDef(AliMUONCheck,0) // Dumper of MUON related data
50 };
51
52 #endif