In This Package:

RawData.h

Go to the documentation of this file.

/* Raw Data: Classes for representing Raw Event Data.
 *
 * Created By: dandwyer@caltech.edu 2009/7/10
 */

#ifndef RAWDATA_H
#define RAWDATA_H

#include "RawData/RawBuffer.h"
#include <iostream>

namespace DayaBay {

  // Base raw data block
  class RawData : public RawBuffer {
    public:
      RawData(unsigned int* buffer=0, unsigned int majorVersion=0, 
              unsigned int minorVersion=0, bool isOwner=false);
      ~RawData();
      unsigned int type() const;         // Data field type marker
      unsigned int majorVersion() const; // Major Data Version
      unsigned int minorVersion() const; // Minor Data Version
      bool         isEventType() const;  // Is event data block?
      bool         isModuleType() const; // Is module data block?
      virtual std::ostream& dump(std::ostream& str); // Print string description
      // Generate a new data object of the correct type
      static DayaBay::RawData* makeNewData(unsigned int* buffer=0,
                                           unsigned int majorVersion=0,
                                           unsigned int minorVersion=0,
                                           bool isOwner=false);
    protected:
      unsigned int m_majorVersion; // Major version for this data block
      unsigned int m_minorVersion; // Minor version for this data block
  };


  // Base type for specific data fragments
  class RawFragment: public RawData {
    public:
      RawFragment(unsigned int* buffer=0, unsigned int majorVersion=0, 
                  unsigned int minorVersion=0, bool isOwner=false);
      ~RawFragment();
      unsigned int type() const;              // Type of fragment
      virtual unsigned int size() const;      // Size of fragment
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  // Head fragment for data block
  class HeadFragment: public RawFragment {
    public:
      HeadFragment(unsigned int* buffer=0, unsigned int majorVersion=0, 
                   unsigned int minorVersion=0, bool isOwner=false);
      ~HeadFragment();
      virtual unsigned int size() const;      // Size of fragment
      unsigned int status() const;
      unsigned int triggerNumber() const;
      virtual unsigned int headType() const;  // Type of Head fragment
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  // Tail fragment for data block
  class TailFragment: public RawFragment {
    public:
      TailFragment(unsigned int* buffer=0, unsigned int majorVersion=0, 
                   unsigned int minorVersion=0, bool isOwner=false);
      ~TailFragment();
      virtual unsigned int size() const;      // Size of fragment
      unsigned int dataSize() const;          // Size of all data in block
      virtual unsigned int tailType() const;  // Type of Tail fragment
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  // Local Trigger Board specific Head fragment
  class LtbHeadFragment: public HeadFragment {
    public:
      LtbHeadFragment(unsigned int* buffer=0, unsigned int majorVersion=0, 
                      unsigned int minorVersion=0, bool isOwner=false);
      ~LtbHeadFragment();
      virtual unsigned int headType() const;  // Type of Head fragment
      unsigned int clockError() const;
      unsigned int ltbDataVersion() const;
      unsigned int numberInternalLocalTrigger() const;
      unsigned int numberSavedInternalLocalTrigger() const;
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  // Local Trigger Board specific Tail fragment
  class LtbTailFragment: public TailFragment {
    public:
      LtbTailFragment(unsigned int* buffer=0, unsigned int majorVersion=0, 
                      unsigned int minorVersion=0, bool isOwner=false);
      ~LtbTailFragment();
      virtual unsigned int tailType() const;  // Type of Tail fragment
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  // PMT FEE specific Head fragment
  class FeeHeadFragment: public HeadFragment {
    public:
      FeeHeadFragment(unsigned int* buffer=0, unsigned int majorVersion=0, 
                      unsigned int minorVersion=0, bool isOwner=false);
      ~FeeHeadFragment();
      virtual unsigned int headType() const;  // Type of Head fragment
      unsigned int feeDataVersion() const;
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  // PMT FEE specific Tail fragment
  class FeeTailFragment: public TailFragment {
    public:
      FeeTailFragment(unsigned int* buffer=0, unsigned int majorVersion=0, 
                      unsigned int minorVersion=0, bool isOwner=false);
      ~FeeTailFragment();
      virtual unsigned int tailType() const;  // Type of Tail fragment
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  // Base type for specific data fragments
  class DataFragment: public RawFragment {
    public:
      DataFragment(unsigned int* buffer=0, unsigned int majorVersion=0, 
                   unsigned int minorVersion=0, bool isOwner=false);
      ~DataFragment();
      virtual unsigned int size() const;      // Size of fragment
      virtual unsigned int dataType() const;  // Type of Data fragment
      bool                 isLocalTriggerData() const; // Is LTB data?
      bool                 isFeePeakData() const; // Is FEE Peak data?
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  // Local Trigger Board data block
  class LocalTriggerData: public DataFragment {
    public:
      LocalTriggerData(unsigned int* buffer=0, unsigned int majorVersion=0, 
                       unsigned int minorVersion=0, 
                       unsigned int ltbDataVersion=0,
                       bool isOwner=false);
      ~LocalTriggerData();
      virtual unsigned int size() const;      // Local Trigger data size
      virtual unsigned int dataType() const;  // Type of Data fragment
      unsigned int ltbDataVersion() const;
      unsigned int sequenceNumber() const;
      unsigned int readOutType() const;
      unsigned int triggerType() const;
      unsigned int hour() const;
      unsigned int minute() const;
      unsigned int second() const;
      unsigned int hsum() const;
      unsigned int esumComp() const;
      unsigned int esum() const;
      unsigned int crossTriggerSource() const;
      // Available in LTB Data version == 1
      unsigned int year() const;
      unsigned int month() const;
      unsigned int day() const;
      unsigned int clock() const;
      // Available in LTB Data version >= 2
      unsigned int accumulationStatus() const;
      unsigned int gpsValid() const;
      unsigned int timestampType() const;
      unsigned int clockValid() const;
      unsigned int unixtimeHigh() const;
      unsigned int unixtimeLow() const;
      unsigned int unixtime() const;
      unsigned int days() const;
      unsigned int accumulationHigh() const;
      unsigned int nanosecondHigh() const;
      unsigned int accumulationLow() const;
      unsigned int nanosecondLow() const;
      int          accumulation() const;
      unsigned int nanosecond() const;
      unsigned int feeBufferStatus() const;
      unsigned int ltbBufferStatus() const;
      unsigned int blockedTrigger() const;
      bool         isUtcTime() const;
      bool         isUnixTime() const;
      // End version >=2
      bool         isManualTrigger() const;  // Is Manual trigger?
      bool         isCrossTrigger() const;  // Is Cross trigger?
      bool         isPeriodicTrigger() const;  // Is Periodic trigger?
      bool         isMultiplicityTrigger() const;  // Is Multiplicity trigger?
      bool         isEsumAdcTrigger() const;  // Is Esum ADC trigger?
      bool         isEsumCompHighTrigger() const; // Is Esum Comp High trigger?
      bool         isEsumCompLowTrigger() const;  // Is Esum Comp Low trigger?
      bool         isEsumCompAllTrigger() const;  // Is Esum Comp All trigger?
      virtual std::ostream& dump(std::ostream& str); // Print string description
    protected:
      unsigned int m_ltbDataVersion;
  };

  // FEE FPGA Peak-finding data block
  class FeePeakData: public DataFragment {
    public:
      FeePeakData(unsigned int* buffer=0, unsigned int majorVersion=0, 
                  unsigned int minorVersion=0, unsigned int feeDataVersion=0, 
                  bool isOwner=false);
      ~FeePeakData();
      virtual unsigned int size() const;      // TDC/ADC Peak data size == 2
      virtual unsigned int dataType() const;  // Type of Data fragment
      unsigned int feeDataVersion() const;
      unsigned int channel() const;      // Channel in module
      unsigned int tdcChannel() const;   // Channel from tdc channel line
      unsigned int adcChannel() const;   // Channel from adc channel line
      unsigned int tdc() const;       
      unsigned int tdcHitCount() const;
      unsigned int adc() const;
      unsigned int peakCycle() const;
      unsigned int adcRange() const;
      bool         hasAdcPedestal() const;
      // Available in FEE Data version >= 2
      unsigned int adcPedestal() const;
      virtual std::ostream& dump(std::ostream& str); // Print string description
    protected:
      unsigned int m_feeDataVersion;
  };

  // Data from one module
  class RawModule: public RawData {
    public:
      RawModule(unsigned int* buffer=0, unsigned int majorVersion=0, 
                unsigned int minorVersion=0, bool isOwner=false);
      ~RawModule();
      unsigned int size() const;         // Raw Module total size
      unsigned int headerSize() const;   // Raw Module header size
      unsigned int siteId() const;
      unsigned int detectorId() const;
      unsigned int moduleType() const;
      unsigned int slot() const;
      bool         isLocalTriggerModule() const;  // Is LTB module?
      bool         isPmtFeeModule() const;        // Is PMT FEE module?
      bool         isFlashAdcModule() const;      // Is Flash ADC module?
      bool         isRpcRomModule() const;        // Is RPC ROM module?
      bool         isRpcRtmModule() const;        // Is RPC RTM module?
      DayaBay::HeadFragment* headFragment();
      DayaBay::DataFragment* nextDataFragment();
      void resetDataFragment();
      virtual std::ostream& dump(std::ostream& str); // Print string description
      // Generate a new raw fragment of the correct type
      DayaBay::RawFragment* makeNewFragment(unsigned int* buffer=0,
                                            unsigned int majorVersion=0,
                                            unsigned int minorVersion=0,
                                            bool isOwner=false);
      // Generate a new head fragment of the correct type
      DayaBay::HeadFragment* makeNewHeadFragment(unsigned int* buffer=0,
                                                 unsigned int majorVersion=0,
                                                 unsigned int minorVersion=0,
                                                 bool isOwner=false);
      // Generate a new tail fragment of the correct type
      DayaBay::TailFragment* makeNewTailFragment(unsigned int* buffer=0,
                                                 unsigned int majorVersion=0,
                                                 unsigned int minorVersion=0,
                                                 bool isOwner=false);
      // Generate a new data fragment of the correct type
      DayaBay::DataFragment* makeNewDataFragment(unsigned int* buffer=0,
                                                 unsigned int majorVersion=0,
                                                 unsigned int minorVersion=0,
                                                 bool isOwner=false);
    private:
      unsigned int m_currentFragmentLine; // Line number of current fragment
  };

  // Event data block
  class RawEvent: public RawData {
    public:
      RawEvent(unsigned int* buffer=0, unsigned int majorVersion=0, 
               unsigned int minorVersion=0, bool isOwner=false);
      ~RawEvent();
      unsigned int size() const;         // Raw Event total size
      unsigned int headerSize() const;   // Raw Event header size
      unsigned int eventMajorVersion() const;
      unsigned int eventMinorVersion() const;
      unsigned int siteId() const;
      unsigned int detectorId() const;
      unsigned int runNumber() const;
      unsigned int eventId() const;
      unsigned int eventType() const;
      unsigned int eventTypeValue() const;
      unsigned int formatFlag() const;
      unsigned int statusFlag() const;
      DayaBay::RawModule* nextModule();
      void resetModule();
      DayaBay::RawEvent* clone() const;   // Make a copy of this raw event
      virtual std::ostream& dump(std::ostream& str); // Print string description
    private:
      unsigned int m_currentModuleLine; // Line number for current module
  };


  /*

  // FEE FPGA Waveform data block
  class FeeWaveformData: public DataFragment {
    public:
      FeeWaveformData(unsigned int* buffer=0, unsigned int majorVersion=0, 
                      unsigned int minorVersion=0, bool isOwner=false);
      ~FeeWaveformData();
      // FIXME: Define this data fragment
  };

  // FEE FPGA ADC baseline data block
  class FeeBaselineData: public DataFragment {
    public:
      FeeBaselineData(unsigned int* buffer=0, unsigned int majorVersion=0, 
                      unsigned int minorVersion=0, bool isOwner=false);
      ~FeeBaselineData();
      // FIXME: Define this data fragment
  };
  */
}

#endif // RAWDATA_H

---