In This Package:

RawRecord.h

Go to the documentation of this file.

/* Raw Record: Classes for working with DAQ data records
 *
 * Created By: dandwyer@caltech.edu 2009/7/10
 */

#ifndef RAWRECORD_H
#define RAWRECORD_H

#include "RawData/RawBuffer.h"

#include <iostream>

namespace DayaBay {
  class RawData;
}

namespace DayaBay {

  // Record as defined in DAQ raw data format
  class RawRecord : public RawBuffer {
    public:
      RawRecord(unsigned int* buffer=0, unsigned int version=0,
                bool isOwner=false);
      RawRecord(DayaBay::RawRecord& record, bool adopt=false);
      virtual ~RawRecord();
      unsigned int type() const;       // Data field type marker
      unsigned int size() const;       // Size of the record, in integer segments
      unsigned int version() const;    // Data Version
      static unsigned int minimumSize(); // Minimum size of all records
      bool         isFileStart() const; // Is this a file start record?
      bool         isFileName() const; // Is this a file name record?
      bool         isMetadata() const; // Is this a metadata record?
      bool         isRunParameters() const; // Is this a run parameters record?
      bool         isCalibrationParameters() const; // Is this a calib record?
      bool         isDataSeparator() const; // Is this a data separator record?
      bool         isFileEnd() const; // Is this a file end record?
      DayaBay::RawRecord* clone() const; // Copy this data record
      virtual std::ostream& dump(std::ostream& str); // Print string description
      // Generate a new record of the correct type
      static DayaBay::RawRecord* makeNewRecord(unsigned int* buffer=0,
                                               unsigned int version=0,
                                               bool isOwner=false);
    private:
      unsigned int m_version; // Maintain version for this record
  };

  // File-related data blocks
  class RawFileStart: public RawRecord {
    public:
      RawFileStart(unsigned int* buffer=0, unsigned int version=0,
                   bool isOwner=false);
      RawFileStart(DayaBay::RawRecord& record, bool adopt=false);
      virtual ~RawFileStart();
      unsigned int fileVersion() const;
      unsigned int fileNumber() const;
      unsigned int date() const;
      unsigned int time() const;
      unsigned int sizeLimitDataBlocks() const;
      unsigned int sizeLimitMB() const;
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  class RawFileName: public RawRecord {
    public:
      RawFileName(unsigned int* buffer=0, unsigned int version=0,
                  bool isOwner=false);
      RawFileName(DayaBay::RawRecord& record, bool adopt=false);
      virtual ~RawFileName();
      char*        appName() const;
      unsigned int appNameLength() const;
      char*        fileName() const;
      unsigned int fileNameLength() const;
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  class RawMetadata: public RawRecord {
    public:
      RawMetadata(unsigned int* buffer=0, unsigned int version=0,
                  bool isOwner=false);
      RawMetadata(DayaBay::RawRecord& record, bool adopt=false);
      virtual ~RawMetadata();
      unsigned int entries() const;
      char*        string(unsigned int index) const;
      unsigned int stringLength(unsigned int index) const;
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  class RawRunParameters: public RawRecord {
    public:
      RawRunParameters(unsigned int* buffer=0, unsigned int version=0,
                       bool isOwner=false);
      RawRunParameters(DayaBay::RawRecord& record, bool adopt=false);
      virtual ~RawRunParameters();
      unsigned int runNumber() const;
      unsigned int reconstructionEnabled() const;
      unsigned int triggerType() const;
      unsigned int detectorMask() const;
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  class RawCalibrationParameters: public RawRecord {
    public:
      RawCalibrationParameters(unsigned int* buffer=0, unsigned int version=0,
                               bool isOwner=false);
      RawCalibrationParameters(DayaBay::RawRecord& record, bool adopt=false);
      virtual ~RawCalibrationParameters();
      unsigned int detectorId() const;
      unsigned int axis() const;
      unsigned int sourceId() const;
      unsigned int zPosition() const;
      unsigned int duration() const;
      unsigned int ledFrequency() const;
      unsigned int ltbMode() const;
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  class RawDataSeparator: public RawRecord {
    public:
      RawDataSeparator(unsigned int* buffer=0, unsigned int version=0,
                       bool isOwner=false);
      RawDataSeparator(DayaBay::RawRecord& record, bool adopt=false);
      virtual ~RawDataSeparator();
      unsigned int blockNumber() const;
      unsigned int blockSize() const;
      DayaBay::RawData* data() const;
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

  class RawFileEnd: public RawRecord {
    public:
      RawFileEnd(unsigned int* buffer=0, unsigned int version=0,
                 bool isOwner=false);
      RawFileEnd(DayaBay::RawRecord& record, bool adopt=false);
      virtual ~RawFileEnd();
      unsigned int date() const;
      unsigned int time() const;
      unsigned int eventsInFile() const;
      unsigned int dataInFile() const;
      unsigned int eventsInRun() const;
      unsigned int dataInRun() const;
      unsigned int status() const;
      unsigned int end() const;
      virtual std::ostream& dump(std::ostream& str); // Print string description
  };

}

#endif // RAWRECORD_H

---