Possibility to specify event selection criteria within the raw-data input URI. The...
[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     static  AliRawReader* Create(const char *uri);
31
32     virtual void     Select(Int_t detectorID, 
33                             Int_t minDDLID = -1, Int_t maxDDLID = -1);
34     virtual void     Select(const char *detectorName, 
35                             Int_t minDDLID = -1, Int_t maxDDLID = -1);
36     virtual void     SelectEquipment(Int_t equipmentType, 
37                                      Int_t minEquipmentId = -1, 
38                                      Int_t maxEquipmentId = -1);
39     virtual void     SkipInvalid(Bool_t skip = kTRUE)
40       {fSkipInvalid = skip;};
41     virtual void     RequireHeader(Bool_t required)
42       {fRequireHeader = required;};
43
44     virtual const AliRawEventHeaderBase* GetEventHeader() const {return NULL;};
45
46     virtual UInt_t   GetType() const = 0;
47     virtual UInt_t   GetRunNumber() const = 0;
48     virtual const UInt_t* GetEventId() const = 0;
49     UInt_t                GetPeriod() const {
50       const UInt_t *id = GetEventId();
51       return id ? (((id)[0]>>4)&0x0fffffff): 0;
52     }
53     UInt_t                GetOrbitID() const {
54       const UInt_t *id = GetEventId();
55       return id ? ((((id)[0]<<20)&0xf00000)|(((id)[1]>>12)&0xfffff)) : 0;
56     }
57     UShort_t              GetBCID() const {
58       const UInt_t *id = GetEventId();
59       return id ? ((id)[1]&0x00000fff) : 0;
60     }
61     virtual const UInt_t* GetTriggerPattern() const = 0;
62     ULong64_t             GetClassMask() const {
63       const UInt_t *pattern = GetTriggerPattern();
64       return pattern ? (((ULong64_t)pattern[1] & 0x3ffff) << 32)|(pattern[0]) : 0;
65     }
66     virtual const UInt_t* GetDetectorPattern() const = 0;
67     virtual const UInt_t* GetAttributes() const = 0;
68     virtual const UInt_t* GetSubEventAttributes() const = 0;
69     virtual UInt_t   GetLDCId() const = 0;
70     virtual UInt_t   GetGDCId() const = 0;
71     virtual UInt_t   GetTimestamp() const = 0;
72
73     virtual Int_t    GetEquipmentSize() const = 0;
74     virtual Int_t    GetEquipmentType() const = 0;
75     virtual Int_t    GetEquipmentId() const = 0;
76     Int_t            GetMappedEquipmentId() const;
77     Bool_t           LoadEquipmentIdsMap(const char *fileName);
78     virtual const UInt_t* GetEquipmentAttributes() const = 0;
79     virtual Int_t    GetEquipmentElementSize() const = 0;
80     virtual Int_t    GetEquipmentHeaderSize() const = 0;
81
82     Int_t            GetDetectorID() const;
83     Int_t            GetDDLID() const;
84
85     Int_t            GetDataSize() const 
86       {if (fHeader) {
87         if (fHeader->fSize != 0xFFFFFFFF) return fHeader->fSize - sizeof(AliRawDataHeader); 
88         else return GetEquipmentSize() - GetEquipmentHeaderSize() - sizeof(AliRawDataHeader);
89       } else return GetEquipmentSize() - GetEquipmentHeaderSize();};
90
91     Int_t            GetVersion() const 
92       {if (fHeader) return fHeader->GetVersion(); else return -1;};
93     Bool_t           IsValid() const 
94       {if (fHeader) return fHeader->TestAttribute(0); 
95       else return kFALSE;};
96     Bool_t           IsCompressed() const 
97       {if (fHeader) return fHeader->TestAttribute(1); 
98       else return kFALSE;};
99     Bool_t           TestBlockAttribute(Int_t index) const
100       {if (fHeader) return fHeader->TestAttribute(index); 
101       else return kFALSE;};
102     UChar_t          GetBlockAttributes() const 
103       {if (fHeader) return fHeader->GetAttributes(); 
104       else return 0;};
105     UInt_t           GetStatusBits() const
106       {if (fHeader) return fHeader->GetStatus(); 
107       else return 0;};
108     const AliRawDataHeader* GetDataHeader() const
109       {return fHeader;}
110
111     virtual Bool_t   ReadHeader() = 0;
112     virtual Bool_t   ReadNextData(UChar_t*& data) = 0;
113     virtual Bool_t   ReadNextInt(UInt_t& data);
114     virtual Bool_t   ReadNextShort(UShort_t& data);
115     virtual Bool_t   ReadNextChar(UChar_t& data);
116     virtual Bool_t   ReadNext(UChar_t* data, Int_t size) = 0;
117
118     virtual Bool_t   Reset() = 0;
119
120     virtual Bool_t   NextEvent() = 0;
121     virtual Bool_t   RewindEvents() = 0;
122
123     enum {kErrMagic=1, kErrNoDataHeader=2, 
124           kErrSize=4, kErrOutOfBounds=8};
125     virtual Int_t    CheckData() const;
126     Int_t            GetErrorCode() const {return fErrorCode;};
127
128     void             DumpData(Int_t limit = -1);
129
130     void             AddErrorLog(AliRawDataErrorLog::ERawDataErrorLevel level,
131                                  Int_t code,
132                                  const char *message = NULL);
133     void             AddMinorErrorLog(Int_t code,
134                                       const char *message = NULL) {
135       return AddErrorLog(AliRawDataErrorLog::kMinor,code,message);
136     }
137     void             AddMajorErrorLog(Int_t code,
138                                       const char *message = NULL) {
139       return AddErrorLog(AliRawDataErrorLog::kMajor,code,message);
140     }
141     void             AddFatalErrorLog(Int_t code,
142                                       const char *message = NULL) {
143       return AddErrorLog(AliRawDataErrorLog::kFatal,code,message);
144     }
145     Int_t            GetNumberOfErrorLogs() const { return fErrorLogs.GetEntriesFast(); }
146     const TClonesArray &GetAllErrorLogs() const { return fErrorLogs; }
147     AliRawDataErrorLog *GetErrorLog(Int_t i) const {
148       return (AliRawDataErrorLog *)fErrorLogs.UncheckedAt(i);
149     }
150
151     // Method which can be used in order to force the auto-save on
152     // ESD tree inside AliReconstruction. For the moment it will be
153     // activated only for AliRawReaderDateOnline.
154     virtual Bool_t   UseAutoSaveESD() const { return kFALSE; }
155
156   protected :
157     virtual void     SelectEvents(Int_t type, ULong64_t triggerMask = 0);
158     Bool_t           IsSelected() const;
159     Bool_t           IsEventSelected() const;
160
161     TArrayI         *fEquipmentIdsIn;       // array of equipment Ids to be mapped
162     TArrayI         *fEquipmentIdsOut;      // array of mapped equipment Ids
163
164     Bool_t           fRequireHeader;        // if false, data without header is accepted
165
166     AliRawDataHeader* fHeader;              // current data header
167     Int_t            fCount;                // counter of bytes to be read for current DDL
168
169     Int_t            fSelectEquipmentType;  // type of selected equipment (<0 = no selection)
170     Int_t            fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
171     Int_t            fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
172     Bool_t           fSkipInvalid;          // skip invalid data
173     Int_t            fSelectEventType;      // type of selected events (<0 = no selection)
174     ULong64_t        fSelectTriggerMask;    // trigger mask for selecting events (0 = no selection)
175
176     Int_t            fErrorCode;            // code of last error
177
178     Int_t            fEventNumber;          // current event number
179     TClonesArray     fErrorLogs;            // raw data decoding errors
180
181     AliRawDataHeader* fHeaderSwapped;       // temporary buffer for swapping header on PowerPC
182
183     UInt_t SwapWord(UInt_t x) const;
184     UShort_t SwapShort(UShort_t x) const;
185
186     ClassDef(AliRawReader, 0) // base class for reading raw digits
187 };
188
189 #endif