RAW/AliRawEventHeaderBase.h

   1 #ifndef ALIRAWEVENTHEADERBASE_H
   2 #define ALIRAWEVENTHEADERBASE_H
   3
   4 // Author: Cvetan Cheshkov  10/10/2005
   5
   6 /* Copyright(c) 1998-2005, ALICE Experiment at CERN, All rights reserved. *
   7  * See cxx source for full Copyright notice                               */
   8
   9 //////////////////////////////////////////////////////////////////////////
  10 //                                                                      //
  11 // AliRawEventHeaderBase                                                //
  12 //                                                                      //
  13 //////////////////////////////////////////////////////////////////////////
  14
  15 //#ifndef ROOT_TObject
  16 //#include <TObject.h>
  17 //#endif
  18
  19 class AliRawEventHeaderBase : public TObject {
  20
  21 public:
  22    AliRawEventHeaderBase();
  23    virtual ~AliRawEventHeaderBase() { if (fExtendedData) delete [] fExtendedData; }
  24
  25    void         *HeaderBaseBegin() { return (void *) &fSize; }
  26    Int_t         HeaderBaseSize() const { return (Long_t) &fVersion - (Long_t) &fSize + sizeof(fVersion); }
  27    void         *HeaderBegin();
  28    Int_t         HeaderSize() const;
  29    Bool_t        DataIsSwapped() const { return fIsSwapped; }
  30    Bool_t        IsSwapped() const { return (fMagic == fgkEventMagicNumberSwapped) ? kTRUE : kFALSE; }
  31    Bool_t        IsValid() const { return IsSwapped() ? kTRUE : ((fMagic == fgkEventMagicNumber) ? kTRUE : kFALSE); }
  32    void          Swap();
  33    UInt_t        SwapWord(UInt_t x) const;
  34    void          SwapData(const void* data, const void* buf, UInt_t size);
  35
  36    UInt_t        GetEventSize() const { return fSize; }
  37    UInt_t        GetMagic() const { return fMagic; }
  38    UInt_t        GetHeadSize() const { return fHeadSize; }
  39    UInt_t        GetVersion() const { return fVersion; }
  40    UInt_t        GetMajorVersion() const { return ((fVersion>>16)&0x0000ffff); }
  41    UInt_t        GetMinorVersion() const { return (fVersion&0x0000ffff); }
  42
  43    UInt_t        GetExtendedDataSize() const { return fExtendedDataSize; }
  44    char*         GetExtendedData() const { return fExtendedData; }
  45
  46    const char *  GetTypeName() const;
  47    static const char *  GetTypeName(UInt_t eventType);
  48    static AliRawEventHeaderBase* Create(char*& data);
  49    void          AllocateExtendedData(Int_t extsize);
  50    Int_t         ReadHeader(char*& data);
  51    Int_t         ReadExtendedData(char*& data);
  52    UInt_t        Get(const char *datamember) const;
  53    const UInt_t* GetP(const char *datamember) const;
  54
  55    void          Print( const Option_t* opt ="" ) const;
  56
  57    // The following enumeration can be used once the kEventTypeMask has been
  58    // applied to the raw event type
  59    enum EAliRawEventType {
  60      kStartOfRun =       1,    // START_OF_RUN
  61      kEndOfRun =         2,    // END_OF_RUN
  62      kStartOfRunFiles =  3,    // START_OF_RUN_FILES
  63      kEndOfRunFiles =    4,    // END_OF_RUN_FILES
  64      kStartOfBurst =     5,    // START_OF_BURST
  65      kEndOfBurst =       6,    // END_OF_BURST
  66      kPhysicsEvent =     7,    // PHYSICS_EVENT
  67      kCalibrationEvent = 8,    // CALIBRATION_EVENT
  68      kFormatError =      9,    // EVENT_FORMAT_ERROR
  69      kStartOfData =      10,   // START_OF_DATA
  70      kEndOfData =        11,   // END_OF_DATA
  71      kSystemSoftwareTriggerEvent   = 12, // SYSTEM_SOFTWARE_TRIGGER_EVENT
  72      kDetectorSoftwareTriggerEvent = 13  // DETECTOR_SOFTWARE_TRIGGER_EVENT
  73    };
  74
  75 private:
  76    AliRawEventHeaderBase(const AliRawEventHeaderBase&);
  77    AliRawEventHeaderBase& operator=(const AliRawEventHeaderBase&);
  78
  79    UInt_t fSize;          // size of event in bytes
  80    UInt_t fMagic;         // magic number used for consistency check
  81    UInt_t fHeadSize;      // size of header in bytes
  82    UInt_t fVersion;       // unique version identifier
  83
  84    UInt_t fExtendedDataSize; // size of header extension data
  85    UInt_t fExtendedAllocSize;//! size of allocated memory for header extension data
  86    char  *fExtendedData;  //[fExtendedDataSize] pointer to header extension data
  87
  88    Bool_t fIsSwapped;     // is data swapped
  89    Int_t  fHeaderSize;    //! cache for the header size estimate
  90
  91    static const UInt_t fgkEventMagicNumber        = 0xDA1E5AFE; // magic word
  92    static const UInt_t fgkEventMagicNumberSwapped = 0xFE5A1EDA; // swapped magic word
  93
  94    ClassDef(AliRawEventHeaderBase,3)  // Alice raw event header base class
  95 };
  96
  97 #define EVENT_HEADER_VERSION(AA,BB) AliRawEventHeaderV##AA##_##BB
  98
  99 #define START_EVENT_HEADER(AA,BB) \
 100 class AliRawEventHeaderV##AA##_##BB:public AliRawEventHeaderBase { \
 101 public: \
 102    AliRawEventHeaderV##AA##_##BB():AliRawEventHeaderBase() {}; \
 103    virtual ~AliRawEventHeaderV##AA##_##BB() {}; \
 104 private:
 105
 106 #define END_EVENT_HEADER(AA,BB) \
 107 ClassDef(AliRawEventHeaderV##AA##_##BB,1) \
 108 }; \
 109 ClassImp(AliRawEventHeaderV##AA##_##BB)
 110
 111 #endif