[u/mrichter/AliRoot.git] / STEER / AliQA.h

#ifndef ALIQA_H
#define ALIQA_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* $Id$ */

//
// Quality Assurance Object
//

#include <TNamed.h> 
class TFile ; 

#include "AliLog.h"

class AliQA : public TNamed {
public:

	enum DETECTORINDEX {
    kNULLDET=-1, kITS, kTPC, kTRD, kTOF, kPHOS, kHMPID, kEMCAL, kMUON, kFMD,
    kZDC, kPMD, kT0, kVZERO, kACORDE, kHLT, kNDET };
	enum ALITASK {
    kNULLTASK=-1, kRAW, kSIM, kREC, kESD, kANA, kNTASK };
	enum QABIT {
    kNULLBit=-1, kINFO, kWARNING, kERROR, kFATAL, kNBIT };
  
	enum TASKINDEX {
    kRAWS, kHITS, kSDIGITS, kDIGITS, kRECPOINTS, kTRACKSEGMENTS, kRECPARTICLES, kESDS, kNTASKINDEX };
  
	// Creators - destructors
	AliQA(); // beware singleton, not to be used
	AliQA(const ALITASK tsk) ;
	AliQA(const DETECTORINDEX det) ;
	AliQA(const AliQA& qa) ;   
	AliQA& operator = (const AliQA& qa) ;
	virtual ~AliQA();
 
	static  AliQA *   Instance() ;
	static  AliQA *   Instance(const DETECTORINDEX det) ;
	static  AliQA *   Instance(const ALITASK tsk) ;
	const Bool_t           CheckFatal() const ;
	static void            Close() ; 
	static const char *    GetAliTaskName(ALITASK tsk) ;
    static const TString   GetLabLocalFile() { return fkgLabLocalFile ; } 
    static const TString   GetLabLocalOCDB() { return fkgLabLocalOCDB ; } 
    static const TString   GetLabAliEnOCDB() { return fkgLabAliEnOCDB ; } 
	static const TString   GetDetName(DETECTORINDEX det) { return fgDetNames[det] ; }
	static const TString   GetTaskName(TASKINDEX tsk) { return fgTaskNames[tsk] ; }
	static const char *    GetDetName(Int_t det) ;
	static const char *    GetQADataFileName() { return fgQADataFileName.Data() ; }
	static TFile *         GetQADataFile(const char * name, const Int_t run, const Int_t cycle) ; 
	static TFile *		   GetQADataFile(const char * fileName) ;
	static TFile *         GetQAResultFile() ; 
	static const char  *   GetQAResultFileName() { return (fgQAResultDirName + fgQAResultFileName).Data() ; }
	static const char  *   GetQARefDefaultStorage() { return fkgQARefOCDBDefault.Data() ; }
	static const char  *   GetQARefFileName() { return fgQARefFileName ; }
	static const char  *   GetQARefStorage() { return fgQARefDirName.Data() ; }
	static const char  *   GetQAOCDBDirName() { return fkgQAOCDBDirName.Data() ; }
	static const char  *   GetRefOCDBDirName() { return fkgRefOCDBDirName.Data() ; }
	const Bool_t           IsSet(DETECTORINDEX det, ALITASK tsk, QABIT bit) const ;
	void                   Set(QABIT bit) ;
	static void			   SetQAResultDirName(const char * name) ; 
	static void            SetQARefStorage(const char * name) ; 
	void                   Show() const { ShowStatus(fDet) ; }
	void                   ShowAll() const ;

private:      

	const Bool_t         CheckRange(DETECTORINDEX det) const ;
	const Bool_t         CheckRange(ALITASK tsk) const ;
	const Bool_t         CheckRange(QABIT bit) const ;
	const char *         GetBitName(QABIT bit) const ;
	const ULong_t        GetStatus(DETECTORINDEX det) const  { return fQA[det] ;}
	void                 Finish() const ;  
	const ULong_t        Offset(ALITASK tsk) const ;
	virtual void         ShowStatus(DETECTORINDEX det) const ;
	void                 ResetStatus(DETECTORINDEX det) { fQA[det] = 0 ; }
	void                 Set(DETECTORINDEX det) { fDet = det ;}
	void                 Set(ALITASK tsk) { fTask = tsk ; AliDebug(1, Form("Ready to set QA status in %s", GetAliTaskName(tsk) )) ; }
	void                 SetStatus(DETECTORINDEX det, UShort_t status) { fQA[det] = status ; }
	void                 SetStatusBit(DETECTORINDEX det, ALITASK tsk, QABIT bit) ;

	static AliQA *fgQA					    ; // pointer to the instance of the singleton
	Int_t                fNdet			    ; // number of detectors
	ULong_t    *         fQA			    ; //[fNdet] the status word 4 bits for SIM, REC, ESD, ANA each
	DETECTORINDEX        fDet			    ; //!  the current detector (ITS, TPC, ....)
	ALITASK              fTask		        ; //!  the current environment (SIM, REC, ESD, ANA)
	static TString       fgDetNames[]	    ; //! list of detector names   
	static TFile *       fgQADataFile	    ; //! the output file where the quality assurance maker store their results
	static TString       fgQADataFileName   ; //! the name of the file where the quality assurance maker store their results
	static TFile *       fgQARefFile	    ; //! the output file where the quality assurance maker store their results
	static TString       fgQARefDirName	    ; //! name of directory where to find the reference data file
	static TString       fgQARefFileName    ; //! file name where to find the reference data
	static TFile *       fgQAResultFile     ; //! File where to find the QA result
	static TString       fgQAResultDirName  ; //! the location of the output file where the QA results are stored  
	static TString       fgQAResultFileName ; //! the output file where the QA results are stored  
	static TString       fgTaskNames[]	    ; //! list of tasks names   
	static const TString fkgLabLocalFile    ; //! label to identify a file as local 
	static const TString fkgLabLocalOCDB    ; //! label to identify a file as local OCDB 
	static const TString fkgLabAliEnOCDB    ; //! label to identify a file as AliEn OCDB 
	static const TString fkgRefFileName     ; //! name of Reference File Name 
	static const TString fkgQAOCDBDirName   ; //! name of Reference directory name in OCDB  	
	static const TString fkgRefOCDBDirName  ; //! name of Reference directory name in OCDB  	
	static const TString fkgQARefOCDBDefault; //! default storage for QA in OCDB 

 ClassDef(AliQA,1)  //ALICE Quality Assurance Object
};
#endif
Commit	Line	Data
2e42b4d4	1	#ifndef ALIQA_H
2e42b4d4	2	#define ALIQA_H
421ab0fb	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
a5fa6165	12	#include <TNamed.h>
421ab0fb	13	class TFile ;
421ab0fb	14
7079c8d7	15	#include "AliLog.h"
7079c8d7	16
2e42b4d4	17	class AliQA : public TNamed {
421ab0fb	18	public:
421ab0fb	19
4edbc5bc	20	enum DETECTORINDEX {
421ab0fb	21	kNULLDET=-1, kITS, kTPC, kTRD, kTOF, kPHOS, kHMPID, kEMCAL, kMUON, kFMD,
4edbc5bc	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 };
421ab0fb	27
4edbc5bc	28	enum TASKINDEX {
4edbc5bc	29	kRAWS, kHITS, kSDIGITS, kDIGITS, kRECPOINTS, kTRACKSEGMENTS, kRECPARTICLES, kESDS, kNTASKINDEX };
421ab0fb	30
4edbc5bc	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();
421ab0fb	38
4edbc5bc	39	static AliQA * Instance() ;
	40	static AliQA * Instance(const DETECTORINDEX det) ;
	41	static AliQA * Instance(const ALITASK tsk) ;
4edbc5bc	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() ; }
f73f556a	56	static const char * GetQARefDefaultStorage() { return fkgQARefOCDBDefault.Data() ; }
4edbc5bc	57	static const char * GetQARefFileName() { return fgQARefFileName ; }
4edbc5bc	58	static const char * GetQARefStorage() { return fgQARefDirName.Data() ; }
f73f556a	59	static const char * GetQAOCDBDirName() { return fkgQAOCDBDirName.Data() ; }
f73f556a	60	static const char * GetRefOCDBDirName() { return fkgRefOCDBDirName.Data() ; }
4edbc5bc	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 ;
421ab0fb	67
	68	private:
	69
4edbc5bc	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 ;}
2ba0b5f5	80	void Set(ALITASK tsk) { fTask = tsk ; AliDebug(1, Form("Ready to set QA status in %s", GetAliTaskName(tsk) )) ; }
4edbc5bc	81	void SetStatus(DETECTORINDEX det, UShort_t status) { fQA[det] = status ; }
4edbc5bc	82	void SetStatusBit(DETECTORINDEX det, ALITASK tsk, QABIT bit) ;
421ab0fb	83
4edbc5bc	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
f73f556a	103	static const TString fkgQAOCDBDirName ; //! name of Reference directory name in OCDB
4edbc5bc	104	static const TString fkgRefOCDBDirName ; //! name of Reference directory name in OCDB
f73f556a	105	static const TString fkgQARefOCDBDefault; //! default storage for QA in OCDB
2e42b4d4	106
2e42b4d4	107	ClassDef(AliQA,1) //ALICE Quality Assurance Object
421ab0fb	108	};
421ab0fb	109	#endif