Effective C++ mods
[u/mrichter/AliRoot.git] / RAW / AliAltroRawStream.h
1 #ifndef ALIALTRORAWSTREAM_H
2 #define ALIALTRORAWSTREAM_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 /// This is a base class for reading raw data digits in Altro format
11 /// The class is able to read both old and new RCU trailer formats
12 /// One can switch between formats using fIsOldRCUFormat flag.
13 /// In case the Common Data Header is 7 32-bit words long, one
14 /// can use the fIsShortDataHeader flag.
15 ///
16 ///////////////////////////////////////////////////////////////////////////////
17
18 #include <TObject.h>
19
20 class AliRawReader;
21
22 class AliAltroRawStream: public TObject {
23   public :
24     AliAltroRawStream(AliRawReader* rawReader);
25     virtual ~AliAltroRawStream();
26
27     virtual void             Reset();
28     virtual Bool_t           Next();
29
30     Int_t GetDDLNumber()  const { return fDDLNumber; }  // Provide current DDL number
31     Int_t GetPrevDDLNumber() const { return fPrevDDLNumber; }// Provide previous DDL number
32     Bool_t  IsNewDDLNumber() const {return (fDDLNumber != fPrevDDLNumber);};
33     Int_t GetRCUId()      const { return fRCUId; }      // Provide current RCU identifier
34     Int_t GetPrevRCUId()  const { return fPrevRCUId; }  // Provide previous RCU identifier
35     Bool_t  IsNewRCUId() const {return (fRCUId != fPrevRCUId);};
36     Int_t GetHWAddress()  const { return fHWAddress; }  // Provide current hardware address
37     Int_t GetPrevHWAddress() const { return fPrevHWAddress; }  // Provide previous hardware address
38     Bool_t  IsNewHWAddress() const {return (fHWAddress != fPrevHWAddress) || IsNewDDLNumber();};
39     Int_t GetTime()       const { return fTime; }       // Provide index of current time bin
40     Int_t GetPrevTime()   const { return fPrevTime; }   // Provide index of previous time bin
41     Bool_t  IsNewTime()   const {return (fTime != fPrevTime) || IsNewHWAddress();};
42     Int_t GetSignal()     const { return fSignal; }     // Provide signal in ADC counts
43     Int_t GetTimeLength() const { return fTimeBunch; }  // Provide total length of current time bunch
44
45     Bool_t  GetRCUTrailerData(UChar_t*& data) const;              // Provide a pointer to RCU trailer
46     Int_t   GetRCUTrailerSize() const { return fRCUTrailerSize; } // Provide size of RCU trailer
47
48     void SelectRawData(Int_t detId);                           // Select raw data for specific detector id
49     void SelectRawData(const char *detName);                   // Select raw data for specific detector name
50
51     void  SetNoAltroMapping(Bool_t flag) { fNoAltroMapping = flag; }  // Specify whenever to use or not the altro mapping
52     void  SetOldRCUFormat(Bool_t flag)   { fIsOldRCUFormat = flag; }  // Specify whenever to use or not the old RCU trailer format
53     void  SetShortDataHeader(Bool_t flag) { fIsShortDataHeader = flag; } // Specify whenever to assume or not a short CDH format
54
55     void PrintDebug() const; // Print debug information in case of decoding errors
56
57   protected:
58     AliAltroRawStream(const AliAltroRawStream& stream);
59     AliAltroRawStream& operator = (const AliAltroRawStream& stream);
60
61     Bool_t           fNoAltroMapping;  // temporary flag in case of no altro mapping is provided
62     Short_t          fSegmentation[3]; // temporary container for the dummy trailer, to be removed
63
64     Bool_t           fIsOldRCUFormat;  // flag used to select between old and new RCU trailer format
65     Bool_t           fIsShortDataHeader; // flag used to select between normal and short CDH format
66
67   private :
68
69     UShort_t         GetNextWord();
70     Bool_t           ReadTrailer();
71     Bool_t           ReadDummyTrailer();
72     void             ReadBunch();
73     void             ReadAmplitude();
74     Int_t            GetPosition();
75     UInt_t           Get32bitWord(Int_t &index);
76
77     Int_t            fDDLNumber;    // index of current DDL number
78     Int_t            fPrevDDLNumber;// index of previous DDL number
79     Int_t            fRCUId;        // current RCU identifier
80     Int_t            fPrevRCUId;    // previous RCU identifier
81     Short_t          fHWAddress;    // current hardware address
82     Short_t          fPrevHWAddress;// previous hardware address
83     Int_t            fTime;         // index of current time bin
84     Int_t            fPrevTime;     // index of previous time bin
85     Int_t            fSignal;       // signal in ADC counts
86     Int_t            fTimeBunch;    // total length of the current time bunch
87
88     AliRawReader*    fRawReader;    // object for reading the raw data
89
90
91     UChar_t*         fData;         // raw data
92
93     Int_t            fPosition;     // current (10 bit) position in fData
94     Int_t            fCount;        // counter of words to be read for current trailer
95     Int_t            fBunchLength;  // remaining number of signal bins in the current bunch
96
97     UChar_t*         fRCUTrailerData; // pointer to RCU trailer data
98     Int_t            fRCUTrailerSize; // size of RCU trailer data in bytes
99
100     ClassDef(AliAltroRawStream, 0)  // base class for reading Altro raw digits
101 };
102
103 #endif