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