Header.h

Go to the documentation of this file.

#ifndef ANP_HEADER_H
#define ANP_HEADER_H

// $Id: Header.h,v 1.22 2008/06/17 21:44:18 rustem Exp $
//
// Store relevant information about snarl:
//   1) DAQ data: trigger, time, detector, run period, etc
//   2) Detector data: coil current, LI status, etc
//   3) Beam spill data: time, intensity and configuration
//   4) Software: reconstruction and Monte-Release release types
//
// This header file contains include file for assert macro.

// C++
#include <cassert> 
#include <iosfwd>
#include <string>

// ROOT
#include "Rtypes.h"

namespace Anp
{
   class Header
   {
   public:
      
      Header();
      ~Header();
      
      int Run()       const;
      int SubRun()    const;
      int Snarl()     const;
      int TimeFrame() const;
      int Sec()       const;
      int NSec()      const;
      int Trigger()   const;      
      int SpillType() const;      
      int Detector()  const;
      int SimFlag()   const;

      int RunPeriod() const;
      int Release()   const;
      int SpillSec()  const;
      int SpillNSec() const;
      int GPSTime()   const;
      int GPSError()  const;
      int LITime()    const;
      int CrateMask() const;
      int BeamDSec()  const;
      int BeamDNSec() const;

      float  Tor101()     const;
      float  Tr101D()     const;
      float  TorTgt()     const;
      float  TrTgtD()     const;
      float  CoilCur()    const;
      double Time2Spill() const;

      bool CoilRevs() const;
      bool GoodBeam() const;
      bool GoodCoil() const;
      bool GoodDetc() const;
      bool GoodHV()   const;
      bool IsValid()  const;

      bool IsData() const;
      bool IsNear() const;
      bool IsFar()  const;

      long double BeamDTime() const;
      long double SpillTime() const;
      long double TriggTime() const;

      const std::string GetBEAMTYPE() const;
      const std::string GetDATATYPE() const;
      const std::string GetDETECTOR() const;
      const std::string GetMCRLTYPE() const;
      const std::string GetRECOTYPE() const;
      const std::string GetRUNCYCLE() const;

      void Clear();
      
      void Print(std::ostream &o = std::cout) const;

   private:

      int SetBeamType(const std::string &value);

   private:

      friend class FillHeader;

      Int_t    run;         // run number
      Int_t    subrun;      // sub run number
      Int_t    snarl;       // snarl number 
      Int_t    timeframe;   // time frame number
      Int_t    sec;         // detector trigger time (seconds)
      Int_t    nsec;        // detector trigger time (nanoseconds)
      Int_t    trigger;     // trigger source
      Int_t    spilltype;   // remote spill type
      Int_t    detector;    // nd=1, fd=2, caldet=3, unknown=0
      Int_t    simflag;     // data=1, for mc=2, unknown=0
      Int_t    runperiod;   // run period
      Int_t    relitype;    // reconstruction and MC release type
      Int_t    spillsec;    // beam spill time from GPS timing system (seconds)
      Int_t    spillnsec;   // beam spill time from GPS timing system (nanoseconds)
      Int_t    gpstime;     // far only: time when GPS timing error is reported (seconds)
      Int_t    gpserror;    // far only: GPS timing error (nanoseconds)
      Int_t    litime;      // far only: time of trigger PMP hit (nanoseconds)
      Int_t    cratemask;   // far only: number of enabled crates (detector crate mask)
      Int_t    beamdsec;    // beam spill time from beam data monitoring (seconds)
      Int_t    beamdnsec;   // beam spill time from beam data monitoring (nanoseconds)
      Float_t  tor101;      // toroid tor101 reading
      Float_t  tr101d;      // toroid tr101d reading
      Float_t  tortgt;      // toroid tortgt reading
      Float_t  trtgtd;      // toroid trtgtd reading
      Float_t  coilcur;     // detector coil current
      Double_t time2spill;  // time to nearest spill, computed by SpillTimeFinder

      Bool_t   coilrevs;    // detector coil current is reverse
      Bool_t   goodbeam;    // snarl passed good beam cuts
      Bool_t   goodcoil;    // detector coil is in good state
      Bool_t   gooddetc;    // detector readout is in good state
      Bool_t   goodhv;      // far only: detector high voltage is in good state
      Bool_t   valid;       // header is correctly initilized

      char beamtype[9];     // beam type as array of 9 characters
   };

   //
   // Compare Headers using run, subrun and snarl numbers
   //
   bool operator==(const Header &lhs, const Header &rhs);
   bool operator!=(const Header &lhs, const Header &rhs);

   std::ostream& operator<<(std::ostream& o, const Header &self);

   //
   // Inlined global functions
   //
   inline int Header::Run()       const { return run; }
   inline int Header::SubRun()    const { return subrun; }
   inline int Header::Snarl()     const { return snarl; }
   inline int Header::TimeFrame() const { return timeframe; }
   inline int Header::Sec()       const { return sec; }
   inline int Header::NSec()      const { return nsec; }
   inline int Header::Trigger()   const { return trigger; }
   inline int Header::SpillType() const { return spilltype; }
   inline int Header::Detector()  const { return detector; }
   inline int Header::SimFlag()   const { return simflag; }
   inline int Header::RunPeriod() const { return runperiod; }
   inline int Header::Release()   const { return relitype; }
   inline int Header::SpillSec()  const { return spillsec; }
   inline int Header::SpillNSec() const { return spillnsec; }
   inline int Header::GPSError()  const { return gpstime; }
   inline int Header::GPSTime()   const { return gpserror; }
   inline int Header::LITime()    const { return litime; }
   inline int Header::CrateMask() const { return cratemask; }
   inline int Header::BeamDSec()  const { return beamdsec; }
   inline int Header::BeamDNSec() const { return beamdnsec; }

   inline float  Header::Tor101()     const { return tor101; }
   inline float  Header::Tr101D()     const { return tr101d; }
   inline float  Header::TorTgt()     const { return tortgt; }
   inline float  Header::TrTgtD()     const { return trtgtd; }
   inline float  Header::CoilCur()    const { return coilcur; }
   inline double Header::Time2Spill() const { return time2spill; }
   
   inline bool Header::CoilRevs() const { return coilrevs; }
   inline bool Header::GoodBeam() const { return goodbeam; }
   inline bool Header::GoodCoil() const { return goodcoil; }
   inline bool Header::GoodDetc() const { return gooddetc; }
   inline bool Header::GoodHV()   const { return goodhv; }
   inline bool Header::IsValid()  const { return valid; }
}

#endif

---