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) {
  57         if (fHeader->fSize != 0xFFFFFFFF) return fHeader->fSize - sizeof(AliRawDataHeader);
  58         else return GetEquipmentSize() - sizeof(AliRawDataHeader);
  59       } else return GetEquipmentSize();};
  60
  61     Int_t            GetVersion() const
  62       {if (fHeader) return fHeader->fVersion; else return -1;};
  63     Bool_t           IsValid() const
  64       {if (fHeader) return fHeader->TestAttribute(0);
  65       else return kFALSE;};
  66     Bool_t           IsCompressed() const
  67       {if (fHeader) return fHeader->TestAttribute(1);
  68       else return kFALSE;};
  69     Bool_t           TestBlockAttribute(Int_t index) const
  70       {if (fHeader) return fHeader->TestAttribute(index);
  71       else return kFALSE;};
  72     UChar_t          GetBlockAttributes() const
  73       {if (fHeader) return fHeader->GetAttributes();
  74       else return 0;};
  75     UInt_t           GetStatusBits() const
  76       {if (fHeader) return fHeader->GetStatus();
  77       else return 0;};
  78     const AliRawDataHeader* GetDataHeader() const
  79       {return fHeader;}
  80
  81     virtual Bool_t   ReadHeader() = 0;
  82     virtual Bool_t   ReadNextData(UChar_t*& data) = 0;
  83     virtual Bool_t   ReadNextInt(UInt_t& data);
  84     virtual Bool_t   ReadNextShort(UShort_t& data);
  85     virtual Bool_t   ReadNextChar(UChar_t& data);
  86
  87     virtual Bool_t   Reset() = 0;
  88
  89     virtual Bool_t   NextEvent() = 0;
  90     virtual Bool_t   RewindEvents() = 0;
  91
  92     enum {kErrMagic=1, kErrNoDataHeader=2,
  93           kErrSize=4, kErrOutOfBounds=8};
  94     virtual Int_t    CheckData() const;
  95     Int_t            GetErrorCode() const {return fErrorCode;};
  96
  97     void             DumpData(Int_t limit = -1);
  98
  99   protected :
 100     Bool_t           IsSelected() const;
 101     Bool_t           IsEventSelected() const;
 102
 103     virtual Bool_t   ReadNext(UChar_t* data, Int_t size) = 0;
 104
 105     AliRawDataHeader* fHeader;     // current data header
 106     Int_t            fCount;       // counter of bytes to be read for current DDL
 107
 108     Int_t            fSelectEquipmentType;  // type of selected equipment (<0 = no selection)
 109     Int_t            fSelectMinEquipmentId; // minimal index of selected equipment (<0 = no selection)
 110     Int_t            fSelectMaxEquipmentId; // maximal index of selected equipment (<0 = no selection)
 111     Bool_t           fSkipInvalid;       // skip invalid data
 112     Int_t            fSelectEventType;   // type of selected events (<0 = no selection)
 113
 114     Int_t            fErrorCode;         // code of last error
 115
 116     ClassDef(AliRawReader, 0) // base class for reading raw digits
 117 };
 118
 119 #endif