Scaler added to raw data streaming class
[u/mrichter/AliRoot.git] / ZDC / AliZDCRawStream.h
1 #ifndef ALIZDCRAWSTREAM_H
2 #define ALIZDCRAWSTREAM_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 //                                              //
10 //  Class to provide access to ZDC raw data     //
11 //  Author: Chiara Oppedisano                   //
12 //                                              //
13 //////////////////////////////////////////////////
14
15 #include <TObject.h>
16 #include "AliCDBManager.h"
17 #include "AliCDBStorage.h"
18 #include "AliZDCChMap.h"
19
20 class AliRawReader;
21 class AliRawDataHeader;
22
23
24 class AliZDCRawStream: public TObject {
25   public :
26     AliZDCRawStream(AliRawReader* rawReader); 
27     virtual ~AliZDCRawStream();
28     virtual Bool_t   Next();
29     
30     virtual void ReadChMap();
31
32     virtual void ReadCDHHeader();
33
34     UInt_t GetRawBuffer()       const {return fBuffer;}
35     
36     Int_t  GetDeadfaceOffset() const {return fDeadfaceOffset;}
37     Int_t  GetDeadbeefOffset() const {return fDeadbeefOffset;}
38     Int_t  GetDataOffset()     const {return fDataOffset;}
39
40     Int_t  GetSector(Int_t i) const {return fSector[i];}
41     Int_t  GetModType()       const {return fModType;}
42     Int_t  GetADCModule()     const {return fADCModule;}
43     Int_t  GetADCNChannels()  const {return fADCNChannels;}
44     Int_t  GetADCChannel()    const {return fADCChannel;}
45     Int_t  GetADCValue()      const {return fADCValue;}
46     Int_t  GetADCGain()       const {return fADCGain;}
47     
48     // Map from OCDB
49     AliCDBStorage *SetStorage(const char* uri);
50     AliZDCChMap   *GetChMap() const;
51     
52     Int_t  GetNChannelsOn()            const {return fNChannelsOn;}
53     Int_t  GetCabledSignal()           const {return fCabledSignal;}
54     Int_t  GetADCModFromMap(Int_t i)   const {return fMapADC[i][0];}
55     Int_t  GetADCChFromMap(Int_t i)    const {return fMapADC[i][1];}
56     Int_t  GetADCSignFromMap(Int_t i)  const {return fMapADC[i][2];}
57     Int_t  GetDetectorFromMap(Int_t i) const {return fMapADC[i][3];}
58     Int_t  GetTowerFromMap(Int_t i)    const {return fMapADC[i][4];}
59     
60     Bool_t IsCalibration() const {return fIsCalib;}
61     Bool_t IsDARCHeader()  const {return fIsDARCHeader;}
62     Bool_t IsChMapping()   const {return fIsChMapping;}
63     Bool_t IsADCDataWord() const {return fIsADCDataWord;}
64     Bool_t IsADCHeader()   const {return fIsADCHeader;}
65     Bool_t IsADCEOB()      const {return fIsADCEOB;}
66     Bool_t IsUnderflow()   const {return fIsUnderflow;}
67     Bool_t IsOverflow()    const {return fIsOverflow;}
68     
69     UInt_t GetScGeo() const {return fScGeo;}        
70     UInt_t GetScNWords() const {return fScNWords;}          
71     UInt_t GetScTriggerSource() const {return fScTriggerSource;}            
72     UInt_t GetTriggerNumber() const {return fScTriggerNumber;}
73     UInt_t GetTriggerCount() const {return fScEvCounter;}
74     
75     void SetNChannelsOn(Int_t val) {fNChannelsOn = val;}
76     void SetSector(Int_t i, Int_t val) {fSector[i] = val;}
77     void SetMapADCMod(Int_t iraw, Int_t imod) {fMapADC[iraw][0]=imod;}
78     void SetMapADCCh(Int_t iraw, Int_t ich)   {fMapADC[iraw][1]=ich;}
79     void SetMapADCSig(Int_t iraw, Int_t isig) {fMapADC[iraw][2]=isig;}
80     void SetMapDet(Int_t iraw, Int_t idet)    {fMapADC[iraw][3]=idet;}
81     void SetMapTow(Int_t iraw, Int_t itow)    {fMapADC[iraw][4]=itow;}
82     
83     void SetSODReading(Bool_t iset) {fSODReading = iset;}
84     
85     // Error codes in raw data streaming
86     enum EZDCRawStreamError{
87        kCDHError = 1,
88        kDARCError = 2,
89        kZDCDataError = 3,
90        kInvalidADCModule = 4,
91        kInvalidSector = 5};
92     
93     // Signal codes for ZDC 
94     // Same codes used in DAQ configuration file
95     // To be changed ONLY IF this file is changed!!! 
96     // **** DO NOT CHANGE THE FOLLOWING LINES!!! ****
97     enum ZDCSignal{kNotConnected=0, kVoid=1,
98          kZNAC=2, kZNA1=3, kZNA2=4, kZNA3=5, kZNA4=6,
99          kZPAC=7, kZPA1=8, kZPA2=9, kZPA3=10, kZPA4=11,
100          kZNCC=12, kZNC1=13, kZNC2=14, kZNC3=15, kZNC4=16,
101          kZPCC=17, kZPC1=18, kZPC2=19, kZPC3=20, kZPC4=21,
102          kZEM1=22, kZEM2=23,
103          kZDCAMon=24, kZDCCMon=25,
104          kZNACoot=26, kZNA1oot=27, kZNA2oot=28, kZNA3oot=29, kZNA4oot=30,
105          kZPACoot=31, kZPA1oot=32, kZPA2oot=33, kZPA3oot=34, kZPA4oot=35,
106          kZNCCoot=36, kZNC1oot=37, kZNC2oot=38, kZNC3oot=39, kZNC4oot=40,
107          kZPCCoot=41, kZPC1oot=42, kZPC2oot=43, kZPC3oot=44, kZPC4oot=45,
108          kZEM1oot=46, kZEM2oot=47,
109          kZDCAMonoot=48, kZDCCMonoot=49};
110     
111   private :
112     AliZDCRawStream(const AliZDCRawStream& stream);
113     AliZDCRawStream& operator = (const AliZDCRawStream& stream);
114
115     AliRawReader* fRawReader;    // object for reading the raw data
116     
117     // Data for buffer decoding
118     UInt_t fBuffer;           // DARC header + ADC buffer
119     UInt_t fEvType;           // Event type
120     Int_t  fPosition;         // bit position in buffer data word
121     
122     // Boolean variables indicating data type
123     Bool_t fIsCalib;          // True when calibration run
124     Bool_t fIsDARCHeader;     // True when DARC header
125     Bool_t fIsChMapping;      // True when reading ch. mapping
126     Bool_t fIsADCDataWord;    // True when data word
127     Bool_t fIsADCHeader;      // True when ADC header
128     Bool_t fIsADCEOB;         // True when EOB
129     Bool_t fSODReading;       // True when reading SOD (DA)
130     Bool_t fIsMapRead;        // True if map is already read
131     
132     // From CDH
133     UInt_t fDARCEvBlockLenght;  // DARC block length
134     UInt_t fDARCBlockAttributes;// DARC block attributes
135
136     Int_t  fDeadfaceOffset;   // deadface offset
137     Int_t  fDeadbeefOffset;   // deadbeef offset
138     Int_t  fDataOffset;       // data offset
139         
140     // ADC signal
141     Int_t  fSector[2];    // [detector, sector]
142     Int_t  fModType;      // Module type
143     Int_t  fADCModule;    // ADC module
144     Int_t  fADCNChannels; // number of ADC ch.
145     Int_t  fADCChannel;   // ADC channel
146     Int_t  fADCValue;     // ADC channel
147     Int_t  fADCGain;      // ADC gain (0=high range; 1=low range)
148     Bool_t fIsUnderflow;  // ADC underflow
149     Bool_t fIsOverflow;   // ADC overflow
150     
151     // Scaler
152     UInt_t fScGeo;           // scaler GEO address
153     UInt_t fScNWords;        // no. of words in scaler event
154     UInt_t fScTriggerSource; // Trigger source 
155     UInt_t fScTriggerNumber; // no. of triggers
156     UInt_t fIsScEventGood;   // true if scaler event is good
157     UInt_t fIsScHeaderRead;  // true if scaler event is good
158     Int_t  fScStartCounter;  // position in the buffer where scaler data begins
159     UInt_t fScEvCounter;     // event counter
160     
161     // Channel mapping 
162     Int_t  fNChannelsOn;   // No. of signals/ADC ch. used
163     Int_t  fNConnCh;       // current mapped ch.
164     Int_t  fCabledSignal;  // physics signal (from enum)
165     Int_t  fMapADC[48][5]; // ADC map for the current run
166         
167     ClassDef(AliZDCRawStream, 10)    // class for reading ZDC raw digits
168 };
169
170 #endif