]> git.uio.no Git - u/mrichter/AliRoot.git/blame - RAW/AliRawReader.h
remove the removal of galice.root
[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
1fb5b4a8 21class AliRawEventHeaderBase;
a6e7b125 22
a6e7b125 23class AliRawReader: public TObject {
24 public :
8de97894 25 AliRawReader();
42d20574 26 AliRawReader(const AliRawReader& rawReader);
27 AliRawReader& operator = (const AliRawReader& rawReader);
0cfe2438 28 virtual ~AliRawReader();
8de97894 29
43787b8e 30 static AliRawReader* Create(const char *uri);
31
eb808725 32 virtual void Select(Int_t detectorID,
8de97894 33 Int_t minDDLID = -1, Int_t maxDDLID = -1);
eb808725 34 virtual void Select(const char *detectorName,
362c9d61 35 Int_t minDDLID = -1, Int_t maxDDLID = -1);
eb808725 36 virtual void SelectEquipment(Int_t equipmentType,
f224de6c 37 Int_t minEquipmentId = -1,
38 Int_t maxEquipmentId = -1);
eb808725 39 virtual void SkipInvalid(Bool_t skip = kTRUE)
39f9963f 40 {fSkipInvalid = skip;};
eb808725 41 virtual void SelectEvents(Int_t type);
299738b9 42 virtual void RequireHeader(Bool_t required)
18882b3b 43 {fRequireHeader = required;};
a6e7b125 44
1fb5b4a8 45 virtual const AliRawEventHeaderBase* GetEventHeader() const {return NULL;};
46
42d20574 47 virtual UInt_t GetType() const = 0;
48 virtual UInt_t GetRunNumber() const = 0;
49 virtual const UInt_t* GetEventId() const = 0;
50 virtual const UInt_t* GetTriggerPattern() const = 0;
51 virtual const UInt_t* GetDetectorPattern() const = 0;
52 virtual const UInt_t* GetAttributes() const = 0;
e94ad92c 53 virtual const UInt_t* GetSubEventAttributes() const = 0;
c946ab02 54 virtual UInt_t GetLDCId() const = 0;
42d20574 55 virtual UInt_t GetGDCId() const = 0;
741c154c 56 virtual UInt_t GetTimestamp() const = 0;
04fa961a 57
c946ab02 58 virtual Int_t GetEquipmentSize() const = 0;
59 virtual Int_t GetEquipmentType() const = 0;
60 virtual Int_t GetEquipmentId() const = 0;
0cfe2438 61 Int_t GetMappedEquipmentId() const;
62 Bool_t LoadEquipmentIdsMap(const char *fileName);
c946ab02 63 virtual const UInt_t* GetEquipmentAttributes() const = 0;
64 virtual Int_t GetEquipmentElementSize() const = 0;
299738b9 65 virtual Int_t GetEquipmentHeaderSize() const = 0;
a6e7b125 66
0cfe2438 67 Int_t GetDetectorID() const;
68 Int_t GetDDLID() const;
39f9963f 69
c946ab02 70 Int_t GetDataSize() const
527a1d3f 71 {if (fHeader) {
72 if (fHeader->fSize != 0xFFFFFFFF) return fHeader->fSize - sizeof(AliRawDataHeader);
299738b9 73 else return GetEquipmentSize() - GetEquipmentHeaderSize() - sizeof(AliRawDataHeader);
74 } else return GetEquipmentSize() - GetEquipmentHeaderSize();};
509a7696 75
c946ab02 76 Int_t GetVersion() const
4e99539f 77 {if (fHeader) return fHeader->GetVersion(); else return -1;};
39f9963f 78 Bool_t IsValid() const
79 {if (fHeader) return fHeader->TestAttribute(0);
80 else return kFALSE;};
c946ab02 81 Bool_t IsCompressed() const
39f9963f 82 {if (fHeader) return fHeader->TestAttribute(1);
c946ab02 83 else return kFALSE;};
c3408d7d 84 Bool_t TestBlockAttribute(Int_t index) const
85 {if (fHeader) return fHeader->TestAttribute(index);
86 else return kFALSE;};
87 UChar_t GetBlockAttributes() const
88 {if (fHeader) return fHeader->GetAttributes();
89 else return 0;};
f58b3254 90 UInt_t GetStatusBits() const
91 {if (fHeader) return fHeader->GetStatus();
92 else return 0;};
c3408d7d 93 const AliRawDataHeader* GetDataHeader() const
94 {return fHeader;}
c946ab02 95
96 virtual Bool_t ReadHeader() = 0;
8de97894 97 virtual Bool_t ReadNextData(UChar_t*& data) = 0;
98 virtual Bool_t ReadNextInt(UInt_t& data);
99 virtual Bool_t ReadNextShort(UShort_t& data);
100 virtual Bool_t ReadNextChar(UChar_t& data);
bf22797a 101 virtual Bool_t ReadNext(UChar_t* data, Int_t size) = 0;
8de97894 102
103 virtual Bool_t Reset() = 0;
a6e7b125 104
dd9a70fe 105 virtual Bool_t NextEvent() = 0;
106 virtual Bool_t RewindEvents() = 0;
107
39f9963f 108 enum {kErrMagic=1, kErrNoDataHeader=2,
109 kErrSize=4, kErrOutOfBounds=8};
b4857df7 110 virtual Int_t CheckData() const;
bea6b2a4 111 Int_t GetErrorCode() const {return fErrorCode;};
b4857df7 112
509a7696 113 void DumpData(Int_t limit = -1);
114
9fc249d9 115 void AddErrorLog(AliRawDataErrorLog::ERawDataErrorLevel level,
116 Int_t code,
38cf12f3 117 const char *message = NULL);
9fc249d9 118 void AddMinorErrorLog(Int_t code,
119 const char *message = NULL) {
120 return AddErrorLog(AliRawDataErrorLog::kMinor,code,message);
121 }
122 void AddMajorErrorLog(Int_t code,
123 const char *message = NULL) {
124 return AddErrorLog(AliRawDataErrorLog::kMajor,code,message);
125 }
126 void AddFatalErrorLog(Int_t code,
127 const char *message = NULL) {
128 return AddErrorLog(AliRawDataErrorLog::kFatal,code,message);
129 }
38cf12f3 130 Int_t GetNumberOfErrorLogs() const { return fErrorLogs.GetEntriesFast(); }
79dac785 131 const TClonesArray &GetAllErrorLogs() const { return fErrorLogs; }
38cf12f3 132 AliRawDataErrorLog *GetErrorLog(Int_t i) const {
133 return (AliRawDataErrorLog *)fErrorLogs.UncheckedAt(i);
134 }
135
a6e7b125 136 protected :
42d20574 137 Bool_t IsSelected() const;
dd9a70fe 138 Bool_t IsEventSelected() const;
a6e7b125 139
0cfe2438 140 TArrayI *fEquipmentIdsIn; // array of equipment Ids to be mapped
141 TArrayI *fEquipmentIdsOut; // array of mapped equipment Ids
18882b3b 142
0cfe2438 143 Bool_t fRequireHeader; // if false, data without header is accepted
144
145 AliRawDataHeader* fHeader; // current data header
146 Int_t fCount; // counter of bytes to be read for current DDL
a6e7b125 147
f224de6c 148 Int_t fSelectEquipmentType; // type of selected equipment (<0 = no selection)
149 Int_t fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
150 Int_t fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
0cfe2438 151 Bool_t fSkipInvalid; // skip invalid data
152 Int_t fSelectEventType; // type of selected events (<0 = no selection)
8de97894 153
0cfe2438 154 Int_t fErrorCode; // code of last error
b4857df7 155
38cf12f3 156 Int_t fEventNumber; // current event number
edd06192 157 TClonesArray fErrorLogs; // raw data decoding errors
158
159 AliRawDataHeader* fHeaderSwapped; // temporary buffer for swapping header on PowerPC
38cf12f3 160
91f76e9b 161 UInt_t SwapWord(UInt_t x) const;
162 UShort_t SwapShort(UShort_t x) const;
163
a6e7b125 164 ClassDef(AliRawReader, 0) // base class for reading raw digits
165};
166
167#endif