8aedf04b91b53c51c010726e86434a360d6cb85d
[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 "AliRawDataHeader.h"
16
17
18 class AliRawReader: public TObject {
19   public :
20     AliRawReader();
21     AliRawReader(const AliRawReader& rawReader);
22     AliRawReader& operator = (const AliRawReader& rawReader);
23     virtual ~AliRawReader() {};
24
25     void             Select(Int_t detectorID, 
26                             Int_t minDDLID = -1, Int_t maxDDLID = -1);
27     void             SelectEquipment(Int_t equipmentType, 
28                                      Int_t minEquipmentId = -1, 
29                                      Int_t maxEquipmentId = -1);
30     void             SkipInvalid(Bool_t skip = kTRUE)
31       {fSkipInvalid = skip;};
32
33     virtual UInt_t   GetType() const = 0;
34     virtual UInt_t   GetRunNumber() const = 0;
35     virtual const UInt_t* GetEventId() const = 0;
36     virtual const UInt_t* GetTriggerPattern() const = 0;
37     virtual const UInt_t* GetDetectorPattern() const = 0;
38     virtual const UInt_t* GetAttributes() const = 0;
39     virtual UInt_t   GetLDCId() const = 0;
40     virtual UInt_t   GetGDCId() const = 0;
41
42     virtual Int_t    GetEquipmentSize() const = 0;
43     virtual Int_t    GetEquipmentType() const = 0;
44     virtual Int_t    GetEquipmentId() const = 0;
45     virtual const UInt_t* GetEquipmentAttributes() const = 0;
46     virtual Int_t    GetEquipmentElementSize() const = 0;
47
48     Int_t            GetDetectorID() const 
49       {if (GetEquipmentId() >= 0) return (GetEquipmentId() >> 8); else return -1;};
50     Int_t            GetDDLID() const 
51       {if (GetEquipmentId() >= 0) return (GetEquipmentId() & 0xFF); else return -1;};
52
53     Int_t            GetDataSize() const 
54       {if (fHeader) return fHeader->fSize - sizeof(AliRawDataHeader); 
55       else return GetEquipmentSize();};
56
57     Int_t            GetVersion() const 
58       {if (fHeader) return fHeader->fVersion; else return -1;};
59     Bool_t           IsValid() const 
60       {if (fHeader) return fHeader->TestAttribute(0); 
61       else return kFALSE;};
62     Bool_t           IsCompressed() const 
63       {if (fHeader) return fHeader->TestAttribute(1); 
64       else return kFALSE;};
65
66     virtual Bool_t   ReadHeader() = 0;
67     virtual Bool_t   ReadNextData(UChar_t*& data) = 0;
68     virtual Bool_t   ReadNextInt(UInt_t& data);
69     virtual Bool_t   ReadNextShort(UShort_t& data);
70     virtual Bool_t   ReadNextChar(UChar_t& data);
71
72     virtual Bool_t   Reset() = 0;
73
74     enum {kErrMagic=1, kErrNoDataHeader=2, 
75           kErrSize=4, kErrOutOfBounds=8};
76     virtual Int_t    CheckData() const;
77     Int_t            GetErrorCode() const {return fErrorCode;};
78
79     void             DumpData(Int_t limit = -1);
80
81   protected :
82     Bool_t           IsSelected() const;
83
84     virtual Bool_t   ReadNext(UChar_t* data, Int_t size) = 0;
85
86     AliRawDataHeader* fHeader;     // current data header
87     Int_t            fCount;       // counter of bytes to be read for current DDL
88
89     Int_t            fSelectEquipmentType;  // type of selected equipment (<0 = no selection)
90     Int_t            fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
91     Int_t            fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
92     Bool_t           fSkipInvalid;       // skip invalid data
93
94     Int_t            fErrorCode;         // code of last error
95
96     ClassDef(AliRawReader, 0) // base class for reading raw digits
97 };
98
99 #endif