Interface to the new class for storing and retrieving of the raw-data decoding errors...
[u/mrichter/AliRoot.git] / RAW / AliRawReader.h
1 #ifndef ALIRAWREADER_H
2 #define ALIRAWREADER_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 the base class for reading raw data.
11 ///
12 ///////////////////////////////////////////////////////////////////////////////
13
14 #include <TObject.h>
15 #include <TArrayI.h>
16 #include <TClonesArray.h>
17
18 #include "AliRawDataErrorLog.h"
19 #include "AliRawDataHeader.h"
20
21 class AliRawEventHeaderBase;
22
23 class AliRawReader: public TObject {
24   public :
25     AliRawReader();
26     AliRawReader(const AliRawReader& rawReader);
27     AliRawReader& operator = (const AliRawReader& rawReader);
28     virtual ~AliRawReader();
29
30     void             Select(Int_t detectorID, 
31                             Int_t minDDLID = -1, Int_t maxDDLID = -1);
32     void             Select(const char *detectorName, 
33                             Int_t minDDLID = -1, Int_t maxDDLID = -1);
34     void             SelectEquipment(Int_t equipmentType, 
35                                      Int_t minEquipmentId = -1, 
36                                      Int_t maxEquipmentId = -1);
37     void             SkipInvalid(Bool_t skip = kTRUE)
38       {fSkipInvalid = skip;};
39     void             SelectEvents(Int_t type);
40     virtual void     RequireHeader(Bool_t required)
41       {fRequireHeader = required;};
42
43     virtual const AliRawEventHeaderBase* GetEventHeader() const {return NULL;};
44
45     virtual UInt_t   GetType() const = 0;
46     virtual UInt_t   GetRunNumber() const = 0;
47     virtual const UInt_t* GetEventId() const = 0;
48     virtual const UInt_t* GetTriggerPattern() const = 0;
49     virtual const UInt_t* GetDetectorPattern() const = 0;
50     virtual const UInt_t* GetAttributes() const = 0;
51     virtual const UInt_t* GetSubEventAttributes() const = 0;
52     virtual UInt_t   GetLDCId() const = 0;
53     virtual UInt_t   GetGDCId() const = 0;
54
55     virtual Int_t    GetEquipmentSize() const = 0;
56     virtual Int_t    GetEquipmentType() const = 0;
57     virtual Int_t    GetEquipmentId() const = 0;
58     Int_t            GetMappedEquipmentId() const;
59     Bool_t           LoadEquipmentIdsMap(const char *fileName);
60     virtual const UInt_t* GetEquipmentAttributes() const = 0;
61     virtual Int_t    GetEquipmentElementSize() const = 0;
62     virtual Int_t    GetEquipmentHeaderSize() const = 0;
63
64     Int_t            GetDetectorID() const;
65     Int_t            GetDDLID() const;
66
67     Int_t            GetDataSize() const 
68       {if (fHeader) {
69         if (fHeader->fSize != 0xFFFFFFFF) return fHeader->fSize - sizeof(AliRawDataHeader); 
70         else return GetEquipmentSize() - GetEquipmentHeaderSize() - sizeof(AliRawDataHeader);
71       } else return GetEquipmentSize() - GetEquipmentHeaderSize();};
72
73     Int_t            GetVersion() const 
74       {if (fHeader) return fHeader->fVersion; else return -1;};
75     Bool_t           IsValid() const 
76       {if (fHeader) return fHeader->TestAttribute(0); 
77       else return kFALSE;};
78     Bool_t           IsCompressed() const 
79       {if (fHeader) return fHeader->TestAttribute(1); 
80       else return kFALSE;};
81     Bool_t           TestBlockAttribute(Int_t index) const
82       {if (fHeader) return fHeader->TestAttribute(index); 
83       else return kFALSE;};
84     UChar_t          GetBlockAttributes() const 
85       {if (fHeader) return fHeader->GetAttributes(); 
86       else return 0;};
87     UInt_t           GetStatusBits() const
88       {if (fHeader) return fHeader->GetStatus(); 
89       else return 0;};
90     const AliRawDataHeader* GetDataHeader() const
91       {return fHeader;}
92
93     virtual Bool_t   ReadHeader() = 0;
94     virtual Bool_t   ReadNextData(UChar_t*& data) = 0;
95     virtual Bool_t   ReadNextInt(UInt_t& data);
96     virtual Bool_t   ReadNextShort(UShort_t& data);
97     virtual Bool_t   ReadNextChar(UChar_t& data);
98     virtual Bool_t   ReadNext(UChar_t* data, Int_t size) = 0;
99
100     virtual Bool_t   Reset() = 0;
101
102     virtual Bool_t   NextEvent() = 0;
103     virtual Bool_t   RewindEvents() = 0;
104
105     enum {kErrMagic=1, kErrNoDataHeader=2, 
106           kErrSize=4, kErrOutOfBounds=8};
107     virtual Int_t    CheckData() const;
108     Int_t            GetErrorCode() const {return fErrorCode;};
109
110     void             DumpData(Int_t limit = -1);
111
112     void             AddErrorLog(AliRawDataErrorLog::ERawDataErrorType type,
113                                  const char *message = NULL);
114     Int_t            GetNumberOfErrorLogs() const { return fErrorLogs.GetEntriesFast(); }
115     AliRawDataErrorLog *GetErrorLog(Int_t i) const {
116       return (AliRawDataErrorLog *)fErrorLogs.UncheckedAt(i);
117     }
118
119   protected :
120     Bool_t           IsSelected() const;
121     Bool_t           IsEventSelected() const;
122
123     TArrayI         *fEquipmentIdsIn;       // array of equipment Ids to be mapped
124     TArrayI         *fEquipmentIdsOut;      // array of mapped equipment Ids
125
126     Bool_t           fRequireHeader;        // if false, data without header is accepted
127
128     AliRawDataHeader* fHeader;              // current data header
129     Int_t            fCount;                // counter of bytes to be read for current DDL
130
131     Int_t            fSelectEquipmentType;  // type of selected equipment (<0 = no selection)
132     Int_t            fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
133     Int_t            fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
134     Bool_t           fSkipInvalid;          // skip invalid data
135     Int_t            fSelectEventType;      // type of selected events (<0 = no selection)
136
137     Int_t            fErrorCode;            // code of last error
138
139     Int_t            fEventNumber;          // current event number
140     TClonesArray     fErrorLogs;        // raw data decoding errors
141
142     ClassDef(AliRawReader, 0) // base class for reading raw digits
143 };
144
145 #endif