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