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