Bug fixed (Christian)
[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>
39f9963f 16#include "AliRawDataHeader.h"
8de97894 17
a6e7b125 18
a6e7b125 19class AliRawReader: public TObject {
20 public :
8de97894 21 AliRawReader();
42d20574 22 AliRawReader(const AliRawReader& rawReader);
23 AliRawReader& operator = (const AliRawReader& rawReader);
0cfe2438 24 virtual ~AliRawReader();
8de97894 25
26 void Select(Int_t detectorID,
27 Int_t minDDLID = -1, Int_t maxDDLID = -1);
362c9d61 28 void Select(const char *detectorName,
29 Int_t minDDLID = -1, Int_t maxDDLID = -1);
f224de6c 30 void SelectEquipment(Int_t equipmentType,
31 Int_t minEquipmentId = -1,
32 Int_t maxEquipmentId = -1);
39f9963f 33 void SkipInvalid(Bool_t skip = kTRUE)
34 {fSkipInvalid = skip;};
dd9a70fe 35 void SelectEvents(Int_t type);
299738b9 36 virtual void RequireHeader(Bool_t required)
18882b3b 37 {fRequireHeader = required;};
a6e7b125 38
42d20574 39 virtual UInt_t GetType() const = 0;
40 virtual UInt_t GetRunNumber() const = 0;
41 virtual const UInt_t* GetEventId() const = 0;
42 virtual const UInt_t* GetTriggerPattern() const = 0;
43 virtual const UInt_t* GetDetectorPattern() const = 0;
44 virtual const UInt_t* GetAttributes() const = 0;
e94ad92c 45 virtual const UInt_t* GetSubEventAttributes() const = 0;
c946ab02 46 virtual UInt_t GetLDCId() const = 0;
42d20574 47 virtual UInt_t GetGDCId() const = 0;
04fa961a 48
c946ab02 49 virtual Int_t GetEquipmentSize() const = 0;
50 virtual Int_t GetEquipmentType() const = 0;
51 virtual Int_t GetEquipmentId() const = 0;
0cfe2438 52 Int_t GetMappedEquipmentId() const;
53 Bool_t LoadEquipmentIdsMap(const char *fileName);
c946ab02 54 virtual const UInt_t* GetEquipmentAttributes() const = 0;
55 virtual Int_t GetEquipmentElementSize() const = 0;
299738b9 56 virtual Int_t GetEquipmentHeaderSize() const = 0;
a6e7b125 57
0cfe2438 58 Int_t GetDetectorID() const;
59 Int_t GetDDLID() const;
39f9963f 60
c946ab02 61 Int_t GetDataSize() const
527a1d3f 62 {if (fHeader) {
63 if (fHeader->fSize != 0xFFFFFFFF) return fHeader->fSize - sizeof(AliRawDataHeader);
299738b9 64 else return GetEquipmentSize() - GetEquipmentHeaderSize() - sizeof(AliRawDataHeader);
65 } else return GetEquipmentSize() - GetEquipmentHeaderSize();};
509a7696 66
c946ab02 67 Int_t GetVersion() const
39f9963f 68 {if (fHeader) return fHeader->fVersion; else return -1;};
69 Bool_t IsValid() const
70 {if (fHeader) return fHeader->TestAttribute(0);
71 else return kFALSE;};
c946ab02 72 Bool_t IsCompressed() const
39f9963f 73 {if (fHeader) return fHeader->TestAttribute(1);
c946ab02 74 else return kFALSE;};
c3408d7d 75 Bool_t TestBlockAttribute(Int_t index) const
76 {if (fHeader) return fHeader->TestAttribute(index);
77 else return kFALSE;};
78 UChar_t GetBlockAttributes() const
79 {if (fHeader) return fHeader->GetAttributes();
80 else return 0;};
f58b3254 81 UInt_t GetStatusBits() const
82 {if (fHeader) return fHeader->GetStatus();
83 else return 0;};
c3408d7d 84 const AliRawDataHeader* GetDataHeader() const
85 {return fHeader;}
c946ab02 86
87 virtual Bool_t ReadHeader() = 0;
8de97894 88 virtual Bool_t ReadNextData(UChar_t*& data) = 0;
89 virtual Bool_t ReadNextInt(UInt_t& data);
90 virtual Bool_t ReadNextShort(UShort_t& data);
91 virtual Bool_t ReadNextChar(UChar_t& data);
bf22797a 92 virtual Bool_t ReadNext(UChar_t* data, Int_t size) = 0;
8de97894 93
94 virtual Bool_t Reset() = 0;
a6e7b125 95
dd9a70fe 96 virtual Bool_t NextEvent() = 0;
97 virtual Bool_t RewindEvents() = 0;
98
39f9963f 99 enum {kErrMagic=1, kErrNoDataHeader=2,
100 kErrSize=4, kErrOutOfBounds=8};
b4857df7 101 virtual Int_t CheckData() const;
bea6b2a4 102 Int_t GetErrorCode() const {return fErrorCode;};
b4857df7 103
509a7696 104 void DumpData(Int_t limit = -1);
105
a6e7b125 106 protected :
42d20574 107 Bool_t IsSelected() const;
dd9a70fe 108 Bool_t IsEventSelected() const;
a6e7b125 109
0cfe2438 110 TArrayI *fEquipmentIdsIn; // array of equipment Ids to be mapped
111 TArrayI *fEquipmentIdsOut; // array of mapped equipment Ids
18882b3b 112
0cfe2438 113 Bool_t fRequireHeader; // if false, data without header is accepted
114
115 AliRawDataHeader* fHeader; // current data header
116 Int_t fCount; // counter of bytes to be read for current DDL
a6e7b125 117
f224de6c 118 Int_t fSelectEquipmentType; // type of selected equipment (<0 = no selection)
119 Int_t fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
120 Int_t fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
0cfe2438 121 Bool_t fSkipInvalid; // skip invalid data
122 Int_t fSelectEventType; // type of selected events (<0 = no selection)
8de97894 123
0cfe2438 124 Int_t fErrorCode; // code of last error
b4857df7 125
a6e7b125 126 ClassDef(AliRawReader, 0) // base class for reading raw digits
127};
128
129#endif