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