3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * See cxx source for full Copyright notice */
8 ///////////////////////////////////////////////////////////////////////////////
10 /// This is the base class for reading raw data.
12 ///////////////////////////////////////////////////////////////////////////////
16 #include <TClonesArray.h>
18 #include "AliRawDataErrorLog.h"
19 #include "AliRawDataHeader.h"
22 class AliRawEventHeaderBase;
25 class AliRawReader: public TObject {
26 friend class AliEveEventManager;
29 AliRawReader(const AliRawReader& rawReader);
30 AliRawReader& operator = (const AliRawReader& rawReader);
31 virtual ~AliRawReader();
33 static AliRawReader* Create(const char *uri);
35 virtual void Select(Int_t detectorID,
36 Int_t minDDLID = -1, Int_t maxDDLID = -1);
37 virtual void Select(const char *detectorName,
38 Int_t minDDLID = -1, Int_t maxDDLID = -1);
39 virtual void SelectEquipment(Int_t equipmentType,
40 Int_t minEquipmentId = -1,
41 Int_t maxEquipmentId = -1);
42 virtual void SkipInvalid(Bool_t skip = kTRUE)
43 {fSkipInvalid = skip;};
44 virtual void RequireHeader(Bool_t required)
45 {fRequireHeader = required;};
47 virtual const AliRawEventHeaderBase* GetEventHeader() const {return NULL;};
48 virtual const AliRawVEvent* GetEvent() const {return NULL;}
50 virtual UInt_t GetType() const = 0;
51 virtual UInt_t GetRunNumber() const = 0;
52 virtual const UInt_t* GetEventId() const = 0;
53 UInt_t GetPeriod() const {
54 const UInt_t *id = GetEventId();
55 return id ? (((id)[0]>>4)&0x0fffffff): 0;
57 UInt_t GetOrbitID() const {
58 const UInt_t *id = GetEventId();
59 return id ? ((((id)[0]<<20)&0xf00000)|(((id)[1]>>12)&0xfffff)) : 0;
61 UShort_t GetBCID() const {
62 const UInt_t *id = GetEventId();
63 return id ? ((id)[1]&0x00000fff) : 0;
65 virtual const UInt_t* GetTriggerPattern() const = 0;
66 ULong64_t GetClassMask() const {
67 const UInt_t *pattern = GetTriggerPattern();
68 return pattern ? (((ULong64_t)pattern[1] & 0x3ffff) << 32)|(pattern[0]) : 0;
70 virtual const UInt_t* GetDetectorPattern() const = 0;
71 virtual const UInt_t* GetAttributes() const = 0;
72 virtual const UInt_t* GetSubEventAttributes() const = 0;
73 virtual UInt_t GetLDCId() const = 0;
74 virtual UInt_t GetGDCId() const = 0;
75 virtual UInt_t GetTimestamp() const = 0;
77 virtual Int_t GetEquipmentSize() const = 0;
78 virtual Int_t GetEquipmentType() const = 0;
79 virtual Int_t GetEquipmentId() const = 0;
80 Int_t GetMappedEquipmentId() const;
81 Bool_t LoadEquipmentIdsMap(const char *fileName);
82 virtual const UInt_t* GetEquipmentAttributes() const = 0;
83 virtual Int_t GetEquipmentElementSize() const = 0;
84 virtual Int_t GetEquipmentHeaderSize() const = 0;
86 Int_t GetDetectorID() const;
87 Int_t GetDDLID() const;
89 Int_t GetDataSize() const
91 if (fHeader->fSize != 0xFFFFFFFF) return fHeader->fSize - sizeof(AliRawDataHeader);
92 else return GetEquipmentSize() - GetEquipmentHeaderSize() - sizeof(AliRawDataHeader);
93 } else return GetEquipmentSize() - GetEquipmentHeaderSize();};
95 Int_t GetVersion() const
96 {if (fHeader) return fHeader->GetVersion(); else return -1;};
97 Bool_t IsValid() const
98 {if (fHeader) return fHeader->TestAttribute(0);
100 Bool_t IsCompressed() const
101 {if (fHeader) return fHeader->TestAttribute(1);
102 else return kFALSE;};
103 Bool_t TestBlockAttribute(Int_t index) const
104 {if (fHeader) return fHeader->TestAttribute(index);
105 else return kFALSE;};
106 UChar_t GetBlockAttributes() const
107 {if (fHeader) return fHeader->GetAttributes();
109 UInt_t GetStatusBits() const
110 {if (fHeader) return fHeader->GetStatus();
112 const AliRawDataHeader* GetDataHeader() const
115 virtual Bool_t ReadHeader() = 0;
116 virtual Bool_t ReadNextData(UChar_t*& data) = 0;
117 virtual Bool_t ReadNextInt(UInt_t& data);
118 virtual Bool_t ReadNextShort(UShort_t& data);
119 virtual Bool_t ReadNextChar(UChar_t& data);
120 virtual Bool_t ReadNext(UChar_t* data, Int_t size) = 0;
122 virtual Bool_t Reset() = 0;
124 virtual Bool_t NextEvent() = 0;
125 virtual Bool_t RewindEvents() = 0;
126 virtual Bool_t GotoEvent(Int_t event);
127 virtual Bool_t GotoEventWithID(Int_t event,
131 virtual Int_t GetEventIndex() const { return -1; }
132 virtual Int_t GetNumberOfEvents() const { return -1; }
134 enum {kErrMagic=1, kErrNoDataHeader=2,
135 kErrSize=4, kErrOutOfBounds=8};
136 virtual Int_t CheckData() const;
137 Int_t GetErrorCode() const {return fErrorCode;};
139 void DumpData(Int_t limit = -1);
141 void AddErrorLog(AliRawDataErrorLog::ERawDataErrorLevel level,
143 const char *message = NULL);
144 void AddMinorErrorLog(Int_t code,
145 const char *message = NULL) {
146 return AddErrorLog(AliRawDataErrorLog::kMinor,code,message);
148 void AddMajorErrorLog(Int_t code,
149 const char *message = NULL) {
150 return AddErrorLog(AliRawDataErrorLog::kMajor,code,message);
152 void AddFatalErrorLog(Int_t code,
153 const char *message = NULL) {
154 return AddErrorLog(AliRawDataErrorLog::kFatal,code,message);
156 Int_t GetNumberOfErrorLogs() const { return fErrorLogs.GetEntriesFast(); }
157 const TClonesArray &GetAllErrorLogs() const { return fErrorLogs; }
158 AliRawDataErrorLog *GetErrorLog(Int_t i) const {
159 return (AliRawDataErrorLog *)fErrorLogs.UncheckedAt(i);
162 // Method which can be used in order to force the auto-save on
163 // ESD tree inside AliReconstruction. For the moment it will be
164 // activated only for AliRawReaderDateOnline.
165 virtual Bool_t UseAutoSaveESD() const { return kFALSE; }
166 virtual TChain* GetChain() const { return NULL; }
168 Bool_t IsRawReaderValid() const { return fIsValid; }
170 void LoadTriggerClass(const char* name, Int_t index);
172 virtual AliRawReader* CloneSingleEvent() const { return NULL; }
175 virtual void SelectEvents(Int_t type, ULong64_t triggerMask = 0, const char *triggerExpr = NULL);
176 Bool_t IsSelected() const;
177 Bool_t IsEventSelected() const;
179 TArrayI *fEquipmentIdsIn; // array of equipment Ids to be mapped
180 TArrayI *fEquipmentIdsOut; // array of mapped equipment Ids
182 Bool_t fRequireHeader; // if false, data without header is accepted
184 AliRawDataHeader* fHeader; // current data header
185 Int_t fCount; // counter of bytes to be read for current DDL
187 Int_t fSelectEquipmentType; // type of selected equipment (<0 = no selection)
188 Int_t fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
189 Int_t fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
190 Bool_t fSkipInvalid; // skip invalid data
191 Int_t fSelectEventType; // type of selected events (<0 = no selection)
192 ULong64_t fSelectTriggerMask; // trigger mask for selecting events (0 = no selection)
193 TString fSelectTriggerExpr; // trigger expression for selecting events (empty = no selection)
195 Int_t fErrorCode; // code of last error
197 Int_t fEventNumber; // current event number
198 TClonesArray fErrorLogs; // raw data decoding errors
200 AliRawDataHeader* fHeaderSwapped; // temporary buffer for swapping header on PowerPC
202 UInt_t SwapWord(UInt_t x) const;
203 UShort_t SwapShort(UShort_t x) const;
205 Bool_t fIsValid; // is raw-reader created successfully
207 ClassDef(AliRawReader, 0) // base class for reading raw digits