066364f5968e72c91131f17bc625c54c28f62568
[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_t {
21     kNULLDET=-1, kITS, kTPC, kTRD, kTOF, kPHOS, kHMPID, kEMCAL, kMUON, kFMD,
22     kZDC, kPMD, kT0, kVZERO, kACORDE, kHLT, kGLOBAL, kNDET };
23         enum ALITASK_t {
24     kNULLTASK=-1, kRAW, kSIM, kREC, kESD, kANA, kNTASK };
25         enum QABIT_t {
26     kNULLBit=-1, kINFO, kWARNING, kERROR, kFATAL, kNBIT };
27     enum RUNTYPE_t {
28       kNULLTYPE=-1, kUNKOWN, kAUTO_TEST, kCALIBRATION, kCALIBRATION_PULSER, kCHANNEL_DELAY_TUNING, kCOSMIC, kCOSMICS, kDAQ_FO_UNIF_SCAN, 
29                         kDAQ_GEN_DAC_SCAN, kDAQ_MEAN_TH_SCAN, kDAQ_MIN_TH_SCAN, kDAQ_NOISY_PIX_SCAN, kDAQ_PIX_DELAY_SCAN, kDAQ_UNIFORMITY_SCAN, 
30                         kDCS_FO_UNIF_SCAN, kDCS_MEAN_TH_SCAN, kDCS_MIN_TH_SCAN, kDCS_PIX_DELAY_SCAN, kDCS_UNIFORMITY_SCAN, kDDL_TEST, kGAIN, 
31                         kPEDESTAL, kINJECTOR,  kLASER, kMONTECARLO, kNOISE, kNOISY_PIX_SCAN,  kPHYSICS, kPULSER, kSTANDALONE, kSTANDALONE_BC, 
32                         kSTANDALONE_CENTRAL, kSTANDALONE_COSMIC, kSTANDALONE_EMD, kSTANDALONE_LASER, kSTANDALONE_MB, kSTANDALONE_PEDESTAL, 
33                         kSTANDALONE_SEMICENTRAL, kSTANDALONE_PULSER, kNTYPE};
34         
35         enum TASKINDEX_t {
36     kNULLTASKINDEX=-1, kRAWS, kHITS, kSDIGITS, kDIGITS, kRECPOINTS, kTRACKSEGMENTS, kRECPARTICLES, kESDS, kNTASKINDEX };
37   
38         // Creators - destructors
39         AliQA(); // beware singleton, not to be used
40         AliQA(const ALITASK_t tsk) ;
41         AliQA(const DETECTORINDEX_t det) ;
42         AliQA(const AliQA& qa) ;   
43         AliQA& operator = (const AliQA& qa) ;
44         virtual ~AliQA();
45  
46         static  AliQA *        Instance() ;
47         static  AliQA *        Instance(const DETECTORINDEX_t det) ;
48         static  AliQA *        Instance(const ALITASK_t tsk) ;
49         static  AliQA *        Instance(const TASKINDEX_t tsk) ;
50         const Bool_t           CheckFatal() const ;
51         static void            Close() ; 
52         static const char *    GetAliTaskName(ALITASK_t tsk) ;
53         static const TString   GetLabLocalFile() { return fkgLabLocalFile ; } 
54         static const TString   GetLabLocalOCDB() { return fkgLabLocalOCDB ; } 
55         static const TString   GetLabAliEnOCDB() { return fkgLabAliEnOCDB ; } 
56         static const DETECTORINDEX_t GetDetIndex(const char * name) ; 
57         static const TString   GetDetName(DETECTORINDEX_t det) { return fgDetNames[det] ; }
58         static const char *    GetDetName(Int_t det) ;
59         static const TString   GetGRPPath() { return fgGRPPath ; }  
60         static TFile *         GetQADataFile(const char * name, const Int_t run, const Int_t cycle) ; 
61         static TFile *         GetQADataFile(const char * fileName) ;
62         static const char *    GetQADataFileName(const char * name, const Int_t run, const Int_t cycle) 
63                                                                                                                 {return Form("%s.%s.%d.%d.root", name, fgQADataFileName.Data(), run, cycle)  ; }
64         static const char *    GetQADataFileName() { return fgQADataFileName.Data() ; }
65         static const char *    GetQAName() { return fkgQAName ; } 
66         static TFile *         GetQAResultFile() ; 
67         static const char  *   GetQAResultFileName() { return (fgQAResultDirName + fgQAResultFileName).Data() ; }
68         static const char  *   GetQARefDefaultStorage() { return fkgQARefOCDBDefault.Data() ; }
69         static const char  *   GetQARefFileName() { return fgQARefFileName ; }
70         static const char  *   GetQARefStorage() { return fgQARefDirName.Data() ; }
71         static const char  *   GetRefOCDBDirName() { return fkgRefOCDBDirName.Data() ; }
72         static const char  *   GetRefDataDirName() { return fkgRefDataDirName.Data() ; }
73         static const TString   GetRunTypeName(RUNTYPE_t rt = kNULLTYPE) ;
74         static const TASKINDEX_t GetTaskIndex(const char * name) ; 
75         static const TString   GetTaskName(UInt_t tsk) { return fgTaskNames[tsk] ; }
76         const Bool_t           IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const ;
77         void                   Set(QABIT_t bit) ;
78         static void                            SetQAResultDirName(const char * name) ; 
79         static void            SetQARefStorage(const char * name) ; 
80         static void            SetQARefDataDirName(RUNTYPE_t rt) { fkgRefDataDirName = GetRunTypeName(rt) ; }
81         static void            SetQARefDataDirName(const char * name) ;
82         void                   Show() const { ShowStatus(fDet, fTask) ; }
83         void                   Show(DETECTORINDEX_t det) const { ShowStatus(det) ; }
84         void                   ShowAll() const ;
85         void                   UnSet(QABIT_t bit) ;
86
87 private:      
88
89         const Bool_t         CheckRange(DETECTORINDEX_t det) const ;
90         const Bool_t         CheckRange(ALITASK_t tsk) const ;
91         const Bool_t         CheckRange(QABIT_t bit) const ;
92         const char *         GetBitName(QABIT_t bit) const ;
93         const ULong_t        GetStatus(DETECTORINDEX_t det) const  { return fQA[det] ;}
94         void                 Finish() const ;  
95         const ULong_t        Offset(ALITASK_t tsk) const ;
96         void                 ShowStatus(DETECTORINDEX_t det, ALITASK_t tsk=kNULLTASK) const ;
97         void                 ShowASCIIStatus(DETECTORINDEX_t det, ALITASK_t tsk, ULong_t status) const ; 
98         void                 ResetStatus(DETECTORINDEX_t det) { fQA[det] = 0 ; }
99         void                 Set(DETECTORINDEX_t det) { fDet = det ;}
100         void                 Set(ALITASK_t tsk) { fTask = tsk ; AliDebug(1, Form("Ready to set QA status in %s", GetAliTaskName(tsk) )) ; }
101         void                 SetStatus(DETECTORINDEX_t det, UShort_t status) { fQA[det] = status ; }
102         void                 SetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) ;
103         void                 UnSetStatusBit(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) ;
104
105         static AliQA *       fgQA                               ; // pointer to the instance of the singleton
106         Int_t          fNdet                              ; // number of detectors
107         ULong_t    *         fQA                                ; //[fNdet] the status word 4 bits for SIM, REC, ESD, ANA each
108         DETECTORINDEX_t      fDet                               ; //!  the current detector (ITS, TPC, ....)
109         ALITASK_t            fTask                      ; //!  the current environment (SIM, REC, ESD, ANA)
110         static TString       fgDetNames[]                 ; //! list of detector names   
111         static TString       fgGRPPath              ; //! path of the GRP object in OCDB
112         static TFile *       fgQADataFile                 ; //! the output file where the quality assurance maker store their results
113         static TString       fgQADataFileName       ; //! the name of the file where the quality assurance maker store their results
114         static TFile *       fgQARefFile                  ; //! the output file where the quality assurance maker store their results
115         static TString       fgQARefDirName             ; //! name of directory where to find the reference data file
116         static TString       fgQARefFileName        ; //! file name where to find the reference data
117         static TFile *       fgQAResultFile         ; //! File where to find the QA result
118         static TString       fgQAResultDirName      ; //! the location of the output file where the QA results are stored  
119         static TString       fgQAResultFileName     ; //! the output file where the QA results are stored  
120         static TString       fgRTNames[]                  ; //! list of Run Type names   
121         static TString       fgTaskNames[]              ; //! list of tasks names   
122         static const TString fkgLabLocalFile        ; //! label to identify a file as local 
123         static const TString fkgLabLocalOCDB        ; //! label to identify a file as local OCDB 
124         static const TString fkgLabAliEnOCDB        ; //! label to identify a file as AliEn OCDB 
125         static const TString fkgRefFileName         ; //! name of Reference File Name 
126         static const TString fkgQAName              ; //! name of QA object 
127         static const TString fkgRefOCDBDirName      ; //! name of Reference directory name in OCDB      
128         static       TString fkgRefDataDirName      ; //! name of Reference directory name in OCDB for data     
129         static const TString fkgQARefOCDBDefault    ; //! default storage for QA in OCDB 
130
131  ClassDef(AliQA,1)  //ALICE Quality Assurance Object
132 };
133 #endif