64b7534dc0e03ba38776485ee721894c867cf808
[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 #include <TObject.h>
7 #include "AliMiniHeader.h"
8
9
10 class AliRawReader: public TObject {
11   public :
12     AliRawReader();
13     AliRawReader(const AliRawReader& rawReader);
14     AliRawReader& operator = (const AliRawReader& rawReader);
15     virtual ~AliRawReader() {};
16
17     void             Select(Int_t detectorID, 
18                             Int_t minDDLID = -1, Int_t maxDDLID = -1);
19
20     virtual UInt_t   GetType() const = 0;
21     virtual UInt_t   GetRunNumber() const = 0;
22     virtual const UInt_t* GetEventId() const = 0;
23     virtual const UInt_t* GetTriggerPattern() const = 0;
24     virtual const UInt_t* GetDetectorPattern() const = 0;
25     virtual const UInt_t* GetAttributes() const = 0;
26     virtual UInt_t   GetLDCId() const = 0;
27     virtual UInt_t   GetGDCId() const = 0;
28
29     virtual Int_t    GetEquipmentSize() const = 0;
30     virtual Int_t    GetEquipmentType() const = 0;
31     virtual Int_t    GetEquipmentId() const = 0;
32     virtual const UInt_t* GetEquipmentAttributes() const = 0;
33     virtual Int_t    GetEquipmentElementSize() const = 0;
34
35     Int_t            GetDataSize() const 
36       {if (fMiniHeader) return fMiniHeader->fSize; else return 0;};
37     Int_t            GetDetectorID() const 
38       {if (fMiniHeader) return fMiniHeader->fDetectorID; else return -1;};
39     Int_t            GetDDLID() const 
40       {if (fMiniHeader) return fMiniHeader->fDDLID; else return -1;};
41     Int_t            GetVersion() const 
42       {if (fMiniHeader) return fMiniHeader->fVersion; else return -1;};
43     Bool_t           IsCompressed() const 
44       {if (fMiniHeader) return fMiniHeader->fCompressionFlag != 0; 
45       else return kFALSE;};
46
47     virtual Bool_t   ReadHeader() = 0;
48     virtual Bool_t   ReadNextData(UChar_t*& data) = 0;
49     virtual Bool_t   ReadNextInt(UInt_t& data);
50     virtual Bool_t   ReadNextShort(UShort_t& data);
51     virtual Bool_t   ReadNextChar(UChar_t& data);
52
53     virtual Bool_t   Reset() = 0;
54
55     enum {kErrMagic=1, kErrNoMiniHeader=2, kErrMiniMagic=4, 
56           kErrSize=8, kErrOutOfBounds=16};
57     virtual Int_t    CheckData() const;
58     Int_t            GetErrorCode() {return fErrorCode;};
59
60   protected :
61     Bool_t           IsSelected() const;
62
63     Bool_t           CheckMiniHeader(AliMiniHeader* miniHeader = NULL) const;
64     virtual Bool_t   ReadNext(UChar_t* data, Int_t size) = 0;
65
66     AliMiniHeader*   fMiniHeader;  // current mini header
67     Int_t            fCount;       // counter of bytes to be read for current DDL
68
69     Int_t            fSelectDetectorID;  // id of selected detector (<0 = no selection)
70     Int_t            fSelectMinDDLID;    // minimal index of selected DDLs (<0 = no selection)
71     Int_t            fSelectMaxDDLID;    // maximal index of selected DDLs (<0 = no selection)
72
73     Int_t            fErrorCode;         // code of last error
74
75     ClassDef(AliRawReader, 0) // base class for reading raw digits
76 };
77
78 #endif