Movin AliQA from STEER to STEERBase
[u/mrichter/AliRoot.git] / STEER / AliQA.h
1 #ifndef ALIQA_H
2 #define ALIQA_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4  * See cxx source for full Copyright notice                               */
5
6 /* $Id$ */
7
8 //
9 // Quality Assurance Object
10 //
11
12 #include <TNamed.h> 
13 class TFile ; 
14
15 #include "AliLog.h"
16
17 class AliQA : public TNamed {
18 public:
19
20         enum DETECTORINDEX {
21     kNULLDET=-1, kITS, kTPC, kTRD, kTOF, kPHOS, kHMPID, kEMCAL, kMUON, kFMD,
22     kZDC, kPMD, kT0, kVZERO, kACORDE, kHLT, kNDET };
23         enum ALITASK {
24     kNULLTASK=-1, kRAW, kSIM, kREC, kESD, kANA, kNTASK };
25         enum QABIT {
26     kNULLBit=-1, kINFO, kWARNING, kERROR, kFATAL, kNBIT };
27   
28         enum TASKINDEX {
29     kRAWS, kHITS, kSDIGITS, kDIGITS, kRECPOINTS, kTRACKSEGMENTS, kRECPARTICLES, kESDS, kNTASKINDEX };
30   
31         // Creators - destructors
32         AliQA(); // beware singleton, not to be used
33         AliQA(const ALITASK tsk) ;
34         AliQA(const DETECTORINDEX det) ;
35         AliQA(const AliQA& qa) ;   
36         AliQA& operator = (const AliQA& qa) ;
37         virtual ~AliQA();
38  
39         static  AliQA *   Instance() ;
40         static  AliQA *   Instance(const DETECTORINDEX det) ;
41         static  AliQA *   Instance(const ALITASK tsk) ;
42         const Bool_t           CheckFatal() const ;
43         static void            Close() ; 
44         static const char *    GetAliTaskName(ALITASK tsk) ;
45     static const TString   GetLabLocalFile() { return fkgLabLocalFile ; } 
46     static const TString   GetLabLocalOCDB() { return fkgLabLocalOCDB ; } 
47     static const TString   GetLabAliEnOCDB() { return fkgLabAliEnOCDB ; } 
48         static const TString   GetDetName(DETECTORINDEX det) { return fgDetNames[det] ; }
49         static const TString   GetTaskName(TASKINDEX tsk) { return fgTaskNames[tsk] ; }
50         static const char *    GetDetName(Int_t det) ;
51         static const char *    GetQADataFileName() { return fgQADataFileName.Data() ; }
52         static TFile *         GetQADataFile(const char * name, const Int_t run, const Int_t cycle) ; 
53         static TFile *             GetQADataFile(const char * fileName) ;
54         static TFile *         GetQAResultFile() ; 
55         static const char  *   GetQAResultFileName() { return (fgQAResultDirName + fgQAResultFileName).Data() ; }
56         static const char  *   GetQARefDefaultStorage() { return fkgQARefOCDBDefault.Data() ; }
57         static const char  *   GetQARefFileName() { return fgQARefFileName ; }
58         static const char  *   GetQARefStorage() { return fgQARefDirName.Data() ; }
59         static const char  *   GetQAOCDBDirName() { return fkgQAOCDBDirName.Data() ; }
60         static const char  *   GetRefOCDBDirName() { return fkgRefOCDBDirName.Data() ; }
61         const Bool_t           IsSet(DETECTORINDEX det, ALITASK tsk, QABIT bit) const ;
62         void                   Set(QABIT bit) ;
63         static void                        SetQAResultDirName(const char * name) ; 
64         static void            SetQARefStorage(const char * name) ; 
65         void                   Show() const { ShowStatus(fDet) ; }
66         void                   ShowAll() const ;
67
68 private:      
69
70         const Bool_t         CheckRange(DETECTORINDEX det) const ;
71         const Bool_t         CheckRange(ALITASK tsk) const ;
72         const Bool_t         CheckRange(QABIT bit) const ;
73         const char *         GetBitName(QABIT bit) const ;
74         const ULong_t        GetStatus(DETECTORINDEX det) const  { return fQA[det] ;}
75         void                 Finish() const ;  
76         const ULong_t        Offset(ALITASK tsk) const ;
77         virtual void         ShowStatus(DETECTORINDEX det) const ;
78         void                 ResetStatus(DETECTORINDEX det) { fQA[det] = 0 ; }
79         void                 Set(DETECTORINDEX det) { fDet = det ;}
80         void                 Set(ALITASK tsk) { fTask = tsk ; AliInfo(Form("Ready to set QA status in %s", GetAliTaskName(tsk) )) ; }
81         void                 SetStatus(DETECTORINDEX det, UShort_t status) { fQA[det] = status ; }
82         void                 SetStatusBit(DETECTORINDEX det, ALITASK tsk, QABIT bit) ;
83
84         static AliQA *fgQA                                          ; // pointer to the instance of the singleton
85         Int_t                fNdet                          ; // number of detectors
86         ULong_t    *         fQA                            ; //[fNdet] the status word 4 bits for SIM, REC, ESD, ANA each
87         DETECTORINDEX        fDet                           ; //!  the current detector (ITS, TPC, ....)
88         ALITASK              fTask                      ; //!  the current environment (SIM, REC, ESD, ANA)
89         static TString       fgDetNames[]           ; //! list of detector names   
90         static TFile *       fgQADataFile           ; //! the output file where the quality assurance maker store their results
91         static TString       fgQADataFileName   ; //! the name of the file where the quality assurance maker store their results
92         static TFile *       fgQARefFile            ; //! the output file where the quality assurance maker store their results
93         static TString       fgQARefDirName         ; //! name of directory where to find the reference data file
94         static TString       fgQARefFileName    ; //! file name where to find the reference data
95         static TFile *       fgQAResultFile     ; //! File where to find the QA result
96         static TString       fgQAResultDirName  ; //! the location of the output file where the QA results are stored  
97         static TString       fgQAResultFileName ; //! the output file where the QA results are stored  
98         static TString       fgTaskNames[]          ; //! list of tasks names   
99         static const TString fkgLabLocalFile    ; //! label to identify a file as local 
100         static const TString fkgLabLocalOCDB    ; //! label to identify a file as local OCDB 
101         static const TString fkgLabAliEnOCDB    ; //! label to identify a file as AliEn OCDB 
102         static const TString fkgRefFileName     ; //! name of Reference File Name 
103         static const TString fkgQAOCDBDirName   ; //! name of Reference directory name in OCDB          
104         static const TString fkgRefOCDBDirName  ; //! name of Reference directory name in OCDB          
105         static const TString fkgQARefOCDBDefault; //! default storage for QA in OCDB 
106
107  ClassDef(AliQA,1)  //ALICE Quality Assurance Object
108 };
109 #endif