12-sep-2006 NvE Memberfunctions GetNslots and AddNamedSlot introduced and various
[u/mrichter/AliRoot.git] / RALICE / AliAttrib.h
1 #ifndef ALIATTRIB_H
2 #define ALIATTRIB_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 #include "TArrayF.h"
9 #include "TArrayI.h"
10 #include "TObjArray.h"
11 #include "TObjString.h"
12 #include "TString.h"
13 #include "TF1.h"
14
15 class AliAttrib
16 {
17  public:
18   AliAttrib();                                 // Default constructor
19   virtual ~AliAttrib();                        // Destructor
20   AliAttrib(const AliAttrib& a);               // Copy constructor
21   Int_t GetNgains() const;                     // Provide the number of specified gains
22   Int_t GetNoffsets() const;                   // Provide the number of specified offsets
23   Int_t GetNcalflags() const;                  // Provide the number of specified calib. flags
24   Int_t GetNnames() const;                     // Provide the maximum number of specified names
25   void SetGain(Double_t gain,Int_t j=1);       // Set gain of the j-th attribute slot
26   void SetGain(Double_t gain,TString name);    // Set gain of the name-specified attribute slot
27   Float_t GetGain(Int_t j=1) const;            // Provide gain of the j-th attribute slot
28   Float_t GetGain(TString name) const;         // Provide gain of the name-specified attribute slot
29   void SetOffset(Double_t off,Int_t j=1);      // Set offset value of the j-th attribute slot
30   void SetOffset(Double_t off,TString name);   // Set offset value of the name specified attribute slot
31   Float_t GetOffset(Int_t j=1) const;          // Provide offset value of the j-th attribute slot
32   Float_t GetOffset(TString name) const;       // Provide offset value of the name-specified attribute slot
33   Int_t GetGainFlag(Int_t j=1) const;          // Provide gain flag of the j-th attribute slot
34   Int_t GetGainFlag(TString name) const;       // Provide gain flag of the name-specified attribute slot
35   Int_t GetOffsetFlag(Int_t j=1) const;        // Provide offset flag of the j-th attribute slot
36   Int_t GetOffsetFlag(TString name) const;     // Provide offset flag of the name-specified attribute slot
37   Int_t GetCalWord(Int_t j=1) const;           // Provide calib. word of the j-th attribute slot
38   Int_t GetCalWord(TString name) const;        // Provide calib word of the name-specified attribute slot
39   void ResetGain(Int_t j=1);                   // Reset j-th gain value and flag
40   void ResetGain(TString name);                // Reset name-specified gain value and flag
41   void ResetOffset(Int_t j=1);                 // Reset j-th offset value and flag
42   void ResetOffset(TString name);              // Reset name-specified offset value and flag
43   void DeleteCalibrations(Int_t mode=0);       // User selected delete of gains and/or offsets
44   void SetDead(Int_t j=1);                     // Indicate j-th attribute slot as 'dead'
45   void SetDead(TString name);                  // Indicate name-specified attribute slot as 'dead'
46   void SetAlive(Int_t j=1);                    // Indicate j-th attribute slot as 'active'
47   void SetAlive(TString name);                 // Indicate name-specified attribute slot as 'active'
48   Int_t GetDeadValue(Int_t j=1) const;         // Return the 'dead flag' of the j-th attribute slot
49   Int_t GetDeadValue(TString name) const;      // Return the 'dead flag' of the name-specified attribute slot
50   void SetEdgeOn(Int_t j=1);                   // Indicate j-th slot as 'detector edge module'
51   void SetEdgeOn(TString name);                // Indicate name-spcified slot as 'detector edge module'
52   void SetEdgeOff(Int_t j=1);                  // Indicate j-th slot as 'detector non-edge module'
53   void SetEdgeOff(TString name);               // Indicate name-specified slot as 'detector non-edge module'
54   void IncreaseEdgeValue(Int_t j=1);           // Increase the edge value of the j-th slot by 1
55   void IncreaseEdgeValue(TString name);        // Increase the edge value of the name-specified slot by 1
56   void DecreaseEdgeValue(Int_t j=1);           // Decrease the edge value of the j-th slot by 1
57   void DecreaseEdgeValue(TString name);        // Decrease the edge value of the name-specified slot by 1
58   void SetEdgeValue(Int_t val,Int_t j=1);      // Set a specific edge value for the j-th slot
59   void SetEdgeValue(Int_t val,TString name);   // Set a specific edge value for the name-specified slot
60   Int_t GetEdgeValue(Int_t j=1) const;         // Provide the edge value of the j-th slot
61   Int_t GetEdgeValue(TString name) const;      // Provide the edge value of the name-specified slot
62   virtual void List(Int_t j=0) const;          // Printout of attribute data
63   virtual void List(TString name) const;       // Printout of name-specified attribute data
64   virtual void Load(AliAttrib& a,Int_t j=0);   // Load j-th slot or all attributes of the input AliAttrib
65   virtual void Load(AliAttrib& a,TString name);// Load name-specified slot attributes of the input AliAttrib
66   void AddNamedSlot(TString s);                // Add a new slot with the specified name
67   virtual Int_t GetNslots() const;             // Provide the number of exising slots
68   void SetSlotName(TString s,Int_t j=1);       // Set user defined name for the j-th slot
69   TString GetSlotName(Int_t j=1) const;        // Provide user defined name for the j-th slot
70   Int_t GetSlotIndex(TString name) const;      // Provide the slot index of the matching name
71   void SetCalFunction(TF1* f,Int_t j=1);       // Set calibration function of the j-th attribute slot
72   void SetCalFunction(TF1* f,TString name);    // Set calibration function of the name-specified attribute slot
73   void SetDecalFunction(TF1* f,Int_t j=1);     // Set de-calibration function of the j-th attribute slot
74   void SetDecalFunction(TF1* f,TString name);  // Set de-calibration function of the name-specified attribute slot
75   TF1* GetCalFunction(Int_t j=1) const;        // Get calibration function of the j-th attribute slot
76   TF1* GetCalFunction(TString name) const;     // Get calibration function of the name-specified attribute slot
77   TF1* GetDecalFunction(Int_t j=1) const;      // Get de-calibration function of the j-th attribute slot
78   TF1* GetDecalFunction(TString name) const;   // Get de-calibration function of the name-specified attribute slot
79   Int_t GetNcalfuncs() const;                  // Provide the number of calibration functions
80   Int_t GetNdecalfuncs() const;                // Provide the number of de-calibration functions
81
82  protected:
83   void SetCalFlags(Int_t gf,Int_t of,Int_t j); // Set flags for gain and/or offset settings
84   TArrayF* fGains;                             // Gain values
85   TArrayF* fOffsets;                           // Offset values
86   TArrayI* fCalflags;                          // Flags to mark dead, edge, and gain/offset calibrated signals
87   TObjArray* fNames;                           // User defined names for the various slots
88   TObjArray* fCalfuncs;                        // Explicit signal calibration functions
89   TObjArray* fDecalfuncs;                      // Explicit signal de-calibration functions
90
91  ClassDef(AliAttrib,5) // Generic handling of detector signal (calibration) attributes.
92 };
93 #endif