access method for sub event attributes added
[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     void             SelectEvents(Int_t type);
33
34     virtual UInt_t   GetType() const = 0;
35     virtual UInt_t   GetRunNumber() const = 0;
36     virtual const UInt_t* GetEventId() const = 0;
37     virtual const UInt_t* GetTriggerPattern() const = 0;
38     virtual const UInt_t* GetDetectorPattern() const = 0;
39     virtual const UInt_t* GetAttributes() const = 0;
40     virtual const UInt_t* GetSubEventAttributes() const = 0;
41     virtual UInt_t   GetLDCId() const = 0;
42     virtual UInt_t   GetGDCId() const = 0;
43
44     virtual Int_t    GetEquipmentSize() const = 0;
45     virtual Int_t    GetEquipmentType() const = 0;
46     virtual Int_t    GetEquipmentId() const = 0;
47     virtual const UInt_t* GetEquipmentAttributes() const = 0;
48     virtual Int_t    GetEquipmentElementSize() const = 0;
49
50     Int_t            GetDetectorID() const 
51       {if (GetEquipmentId() >= 0) return (GetEquipmentId() >> 8); else return -1;};
52     Int_t            GetDDLID() const 
53       {if (GetEquipmentId() >= 0) return (GetEquipmentId() & 0xFF); else return -1;};
54
55     Int_t            GetDataSize() const 
56       {if (fHeader) return fHeader->fSize - sizeof(AliRawDataHeader); 
57       else return GetEquipmentSize();};
58
59     Int_t            GetVersion() const 
60       {if (fHeader) return fHeader->fVersion; else return -1;};
61     Bool_t           IsValid() const 
62       {if (fHeader) return fHeader->TestAttribute(0); 
63       else return kFALSE;};
64     Bool_t           IsCompressed() const 
65       {if (fHeader) return fHeader->TestAttribute(1); 
66       else return kFALSE;};
67     Bool_t           TestBlockAttribute(Int_t index) const
68       {if (fHeader) return fHeader->TestAttribute(index); 
69       else return kFALSE;};
70     UChar_t          GetBlockAttributes() const 
71       {if (fHeader) return fHeader->GetAttributes(); 
72       else return 0;};
73     UInt_t           GetStatusBits() const
74       {if (fHeader) return fHeader->GetStatus(); 
75       else return 0;};
76     const AliRawDataHeader* GetDataHeader() const
77       {return fHeader;}
78
79     virtual Bool_t   ReadHeader() = 0;
80     virtual Bool_t   ReadNextData(UChar_t*& data) = 0;
81     virtual Bool_t   ReadNextInt(UInt_t& data);
82     virtual Bool_t   ReadNextShort(UShort_t& data);
83     virtual Bool_t   ReadNextChar(UChar_t& data);
84
85     virtual Bool_t   Reset() = 0;
86
87     virtual Bool_t   NextEvent() = 0;
88     virtual Bool_t   RewindEvents() = 0;
89
90     enum {kErrMagic=1, kErrNoDataHeader=2, 
91           kErrSize=4, kErrOutOfBounds=8};
92     virtual Int_t    CheckData() const;
93     Int_t            GetErrorCode() const {return fErrorCode;};
94
95     void             DumpData(Int_t limit = -1);
96
97   protected :
98     Bool_t           IsSelected() const;
99     Bool_t           IsEventSelected() const;
100
101     virtual Bool_t   ReadNext(UChar_t* data, Int_t size) = 0;
102
103     AliRawDataHeader* fHeader;     // current data header
104     Int_t            fCount;       // counter of bytes to be read for current DDL
105
106     Int_t            fSelectEquipmentType;  // type of selected equipment (<0 = no selection)
107     Int_t            fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
108     Int_t            fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
109     Bool_t           fSkipInvalid;       // skip invalid data
110     Int_t            fSelectEventType;   // type of selected events (<0 = no selection)
111
112     Int_t            fErrorCode;         // code of last error
113
114     ClassDef(AliRawReader, 0) // base class for reading raw digits
115 };
116
117 #endif