[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_t {
    kNULLDET=-1, kITS, kTPC, kTRD, kTOF, kPHOS, kHMPID, kEMCAL, kMUON, kFMD,
    kZDC, kPMD, kT0, kVZERO, kACORDE, kHLT, kGLOBAL, kNDET };
	enum ALITASK_t {
    kNULLTASK=-1, kRAW, kSIM, kREC, kESD, kANA, kNTASK };
	enum QABIT_t {
    kNULLBit=-1, kINFO, kWARNING, kERROR, kFATAL, kNBIT };
  
	enum TASKINDEX_t {
    kRAWS, kHITS, kSDIGITS, kDIGITS, kRECPOINTS, kTRACKSEGMENTS, kRECPARTICLES, kESDS, kNTASKINDEX };
  
	// Creators - destructors
	AliQA(); // beware singleton, not to be used
	AliQA(const ALITASK_t tsk) ;
	AliQA(const DETECTORINDEX_t det) ;
	AliQA(const AliQA& qa) ;   
	AliQA& operator = (const AliQA& qa) ;
	virtual ~AliQA();
 
	static  AliQA *   Instance() ;
	static  AliQA *   Instance(const DETECTORINDEX_t det) ;
	static  AliQA *   Instance(const ALITASK_t tsk) ;
	static  AliQA *   Instance(const TASKINDEX_t tsk) ;
	const Bool_t           CheckFatal() const ;
	static void            Close() ; 
	static const char *    GetAliTaskName(ALITASK_t tsk) ;
    static const TString   GetLabLocalFile() { return fkgLabLocalFile ; } 
    static const TString   GetLabLocalOCDB() { return fkgLabLocalOCDB ; } 
    static const TString   GetLabAliEnOCDB() { return fkgLabAliEnOCDB ; } 
	static const DETECTORINDEX_t GetDetIndex(const char * name) ; 
	static const TString   GetDetName(DETECTORINDEX_t det) { return fgDetNames[det] ; }
	static const char *    GetDetName(Int_t det) ;
	static TFile *         GetQADataFile(const char * name, const Int_t run, const Int_t cycle) ; 
	static TFile *		   GetQADataFile(const char * fileName) ;
	static const char *    GetQADataFileName(const char * name, const Int_t run, const Int_t cycle) 
								{return Form("%s.%s.%d.%d.root", name, fgQADataFileName.Data(), run, cycle)  ; }
	static const char *    GetQADataFileName() { return fgQADataFileName.Data() ; }
	static const char *    GetQAName() { return fkgQAName ; } 
	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  *   GetRefOCDBDirName() { return fkgRefOCDBDirName.Data() ; }
	static const char  *   GetRefDataDirName() { return fkgRefDataDirName.Data() ; }
	static const TString   GetTaskName(TASKINDEX_t tsk) { return fgTaskNames[tsk] ; }
	const Bool_t           IsSet(DETECTORINDEX_t det, ALITASK_t tsk, QABIT_t bit) const ;
	void                   Set(QABIT_t bit) ;
	static void			   SetQAResultDirName(const char * name) ; 
	static void            SetQARefStorage(const char * name) ; 
	static void            SetQARefDataDirName( const char * name) { fkgRefDataDirName = name ; }
    void                   Show() const { ShowStatus(fDet) ; }
	void                   ShowAll() const ;
	void                   UnSet(QABIT_t bit) ;

private:      

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