During simulation: fill STU region w/ non null time sums
[u/mrichter/AliRoot.git] / RAW / AliRawReader.h
CommitLineData
a6e7b125 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
bea6b2a4 6/* $Id$ */
7
8///////////////////////////////////////////////////////////////////////////////
9///
10/// This is the base class for reading raw data.
11///
12///////////////////////////////////////////////////////////////////////////////
13
a6e7b125 14#include <TObject.h>
0cfe2438 15#include <TArrayI.h>
38cf12f3 16#include <TClonesArray.h>
17
18#include "AliRawDataErrorLog.h"
39f9963f 19#include "AliRawDataHeader.h"
8de97894 20
636c1780 21class TChain;
1fb5b4a8 22class AliRawEventHeaderBase;
33314186 23class AliRawVEvent;
a6e7b125 24
a6e7b125 25class AliRawReader: public TObject {
969d3431 26 friend class AliEveEventManager;
a6e7b125 27 public :
8de97894 28 AliRawReader();
42d20574 29 AliRawReader(const AliRawReader& rawReader);
30 AliRawReader& operator = (const AliRawReader& rawReader);
0cfe2438 31 virtual ~AliRawReader();
8de97894 32
43787b8e 33 static AliRawReader* Create(const char *uri);
34
eb808725 35 virtual void Select(Int_t detectorID,
8de97894 36 Int_t minDDLID = -1, Int_t maxDDLID = -1);
eb808725 37 virtual void Select(const char *detectorName,
362c9d61 38 Int_t minDDLID = -1, Int_t maxDDLID = -1);
eb808725 39 virtual void SelectEquipment(Int_t equipmentType,
f224de6c 40 Int_t minEquipmentId = -1,
41 Int_t maxEquipmentId = -1);
eb808725 42 virtual void SkipInvalid(Bool_t skip = kTRUE)
39f9963f 43 {fSkipInvalid = skip;};
299738b9 44 virtual void RequireHeader(Bool_t required)
18882b3b 45 {fRequireHeader = required;};
a6e7b125 46
1fb5b4a8 47 virtual const AliRawEventHeaderBase* GetEventHeader() const {return NULL;};
33314186 48 virtual const AliRawVEvent* GetEvent() const {return NULL;}
1fb5b4a8 49
42d20574 50 virtual UInt_t GetType() const = 0;
51 virtual UInt_t GetRunNumber() const = 0;
52 virtual const UInt_t* GetEventId() const = 0;
151bea4e 53 UInt_t GetPeriod() const {
54 const UInt_t *id = GetEventId();
4bf6d23d 55 return id ? (((id)[0]>>4)&0x0fffffff): 0;
151bea4e 56 }
57 UInt_t GetOrbitID() const {
58 const UInt_t *id = GetEventId();
4bf6d23d 59 return id ? ((((id)[0]<<20)&0xf00000)|(((id)[1]>>12)&0xfffff)) : 0;
151bea4e 60 }
61 UShort_t GetBCID() const {
62 const UInt_t *id = GetEventId();
4bf6d23d 63 return id ? ((id)[1]&0x00000fff) : 0;
151bea4e 64 }
99b7ff2d 65 ULong64_t GetEventIdAsLong() const {
95f2890d 66 return (((ULong64_t)GetPeriod() << 36) |
67 ((ULong64_t)GetOrbitID() << 12) |
68 (ULong64_t)GetBCID());
99b7ff2d 69 }
42d20574 70 virtual const UInt_t* GetTriggerPattern() const = 0;
4bf6d23d 71 ULong64_t GetClassMask() const {
72 const UInt_t *pattern = GetTriggerPattern();
73 return pattern ? (((ULong64_t)pattern[1] & 0x3ffff) << 32)|(pattern[0]) : 0;
74 }
42d20574 75 virtual const UInt_t* GetDetectorPattern() const = 0;
76 virtual const UInt_t* GetAttributes() const = 0;
e94ad92c 77 virtual const UInt_t* GetSubEventAttributes() const = 0;
c946ab02 78 virtual UInt_t GetLDCId() const = 0;
42d20574 79 virtual UInt_t GetGDCId() const = 0;
741c154c 80 virtual UInt_t GetTimestamp() const = 0;
04fa961a 81
c946ab02 82 virtual Int_t GetEquipmentSize() const = 0;
83 virtual Int_t GetEquipmentType() const = 0;
84 virtual Int_t GetEquipmentId() const = 0;
0cfe2438 85 Int_t GetMappedEquipmentId() const;
86 Bool_t LoadEquipmentIdsMap(const char *fileName);
c946ab02 87 virtual const UInt_t* GetEquipmentAttributes() const = 0;
88 virtual Int_t GetEquipmentElementSize() const = 0;
299738b9 89 virtual Int_t GetEquipmentHeaderSize() const = 0;
a6e7b125 90
0cfe2438 91 Int_t GetDetectorID() const;
92 Int_t GetDDLID() const;
39f9963f 93
c946ab02 94 Int_t GetDataSize() const
527a1d3f 95 {if (fHeader) {
96 if (fHeader->fSize != 0xFFFFFFFF) return fHeader->fSize - sizeof(AliRawDataHeader);
299738b9 97 else return GetEquipmentSize() - GetEquipmentHeaderSize() - sizeof(AliRawDataHeader);
98 } else return GetEquipmentSize() - GetEquipmentHeaderSize();};
509a7696 99
c946ab02 100 Int_t GetVersion() const
4e99539f 101 {if (fHeader) return fHeader->GetVersion(); else return -1;};
39f9963f 102 Bool_t IsValid() const
103 {if (fHeader) return fHeader->TestAttribute(0);
104 else return kFALSE;};
c946ab02 105 Bool_t IsCompressed() const
39f9963f 106 {if (fHeader) return fHeader->TestAttribute(1);
c946ab02 107 else return kFALSE;};
c3408d7d 108 Bool_t TestBlockAttribute(Int_t index) const
109 {if (fHeader) return fHeader->TestAttribute(index);
110 else return kFALSE;};
111 UChar_t GetBlockAttributes() const
112 {if (fHeader) return fHeader->GetAttributes();
113 else return 0;};
f58b3254 114 UInt_t GetStatusBits() const
115 {if (fHeader) return fHeader->GetStatus();
116 else return 0;};
c3408d7d 117 const AliRawDataHeader* GetDataHeader() const
118 {return fHeader;}
c946ab02 119
120 virtual Bool_t ReadHeader() = 0;
8de97894 121 virtual Bool_t ReadNextData(UChar_t*& data) = 0;
122 virtual Bool_t ReadNextInt(UInt_t& data);
123 virtual Bool_t ReadNextShort(UShort_t& data);
124 virtual Bool_t ReadNextChar(UChar_t& data);
bf22797a 125 virtual Bool_t ReadNext(UChar_t* data, Int_t size) = 0;
8de97894 126
127 virtual Bool_t Reset() = 0;
a6e7b125 128
dd9a70fe 129 virtual Bool_t NextEvent() = 0;
130 virtual Bool_t RewindEvents() = 0;
636c1780 131 virtual Bool_t GotoEvent(Int_t event);
66964465 132 virtual Bool_t GotoEventWithID(Int_t event,
133 UInt_t period,
134 UInt_t orbitID,
135 UShort_t bcID);
636c1780 136 virtual Int_t GetEventIndex() const { return -1; }
25e82ff5 137 virtual Int_t GetNumberOfEvents() const { return -1; }
dd9a70fe 138
39f9963f 139 enum {kErrMagic=1, kErrNoDataHeader=2,
140 kErrSize=4, kErrOutOfBounds=8};
b4857df7 141 virtual Int_t CheckData() const;
bea6b2a4 142 Int_t GetErrorCode() const {return fErrorCode;};
b4857df7 143
509a7696 144 void DumpData(Int_t limit = -1);
145
9fc249d9 146 void AddErrorLog(AliRawDataErrorLog::ERawDataErrorLevel level,
147 Int_t code,
38cf12f3 148 const char *message = NULL);
9fc249d9 149 void AddMinorErrorLog(Int_t code,
150 const char *message = NULL) {
151 return AddErrorLog(AliRawDataErrorLog::kMinor,code,message);
152 }
153 void AddMajorErrorLog(Int_t code,
154 const char *message = NULL) {
155 return AddErrorLog(AliRawDataErrorLog::kMajor,code,message);
156 }
157 void AddFatalErrorLog(Int_t code,
158 const char *message = NULL) {
159 return AddErrorLog(AliRawDataErrorLog::kFatal,code,message);
160 }
38cf12f3 161 Int_t GetNumberOfErrorLogs() const { return fErrorLogs.GetEntriesFast(); }
79dac785 162 const TClonesArray &GetAllErrorLogs() const { return fErrorLogs; }
38cf12f3 163 AliRawDataErrorLog *GetErrorLog(Int_t i) const {
164 return (AliRawDataErrorLog *)fErrorLogs.UncheckedAt(i);
165 }
166
2d91a353 167 // Method which can be used in order to force the auto-save on
168 // ESD tree inside AliReconstruction. For the moment it will be
169 // activated only for AliRawReaderDateOnline.
170 virtual Bool_t UseAutoSaveESD() const { return kFALSE; }
636c1780 171 virtual TChain* GetChain() const { return NULL; }
2d91a353 172
a97af23d 173 Bool_t IsRawReaderValid() const { return fIsValid; }
174
56918e2f 175 void LoadTriggerClass(const char* name, Int_t index);
176
b900a426 177 virtual AliRawReader* CloneSingleEvent() const { return NULL; }
178
a6e7b125 179 protected :
56918e2f 180 virtual void SelectEvents(Int_t type, ULong64_t triggerMask = 0, const char *triggerExpr = NULL);
42d20574 181 Bool_t IsSelected() const;
dd9a70fe 182 Bool_t IsEventSelected() const;
a6e7b125 183
0cfe2438 184 TArrayI *fEquipmentIdsIn; // array of equipment Ids to be mapped
185 TArrayI *fEquipmentIdsOut; // array of mapped equipment Ids
18882b3b 186
0cfe2438 187 Bool_t fRequireHeader; // if false, data without header is accepted
188
189 AliRawDataHeader* fHeader; // current data header
190 Int_t fCount; // counter of bytes to be read for current DDL
a6e7b125 191
f224de6c 192 Int_t fSelectEquipmentType; // type of selected equipment (<0 = no selection)
193 Int_t fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
194 Int_t fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
0cfe2438 195 Bool_t fSkipInvalid; // skip invalid data
196 Int_t fSelectEventType; // type of selected events (<0 = no selection)
00665a00 197 ULong64_t fSelectTriggerMask; // trigger mask for selecting events (0 = no selection)
56918e2f 198 TString fSelectTriggerExpr; // trigger expression for selecting events (empty = no selection)
8de97894 199
0cfe2438 200 Int_t fErrorCode; // code of last error
b4857df7 201
38cf12f3 202 Int_t fEventNumber; // current event number
edd06192 203 TClonesArray fErrorLogs; // raw data decoding errors
204
205 AliRawDataHeader* fHeaderSwapped; // temporary buffer for swapping header on PowerPC
38cf12f3 206
91f76e9b 207 UInt_t SwapWord(UInt_t x) const;
208 UShort_t SwapShort(UShort_t x) const;
209
a97af23d 210 Bool_t fIsValid; // is raw-reader created successfully
211
a6e7b125 212 ClassDef(AliRawReader, 0) // base class for reading raw digits
213};
214
215#endif