/data/refman/pasoursint/CMSSW_5_3_3/src/CondFormats/RunInfo/interface/FillInfo.h

Go to the documentation of this file.

#include "CondFormats/Common/interface/Time.h"
#include <bitset>
#include <iostream>
#include <string>
#include <sstream>
#include <vector>

class FillInfo {
 public:
  enum FillType { UNKNOWN = 0, PROTONS = 1, IONS = 2, COSMICS = 3, GAP = 4 };
  enum ParticleType { NONE = 0, PROTON = 1, PB82 = 2, AR18 = 3, D = 4, XE54 = 5 };
  typedef FillType FillTypeId;
  typedef ParticleType ParticleTypeId;
  FillInfo();
  FillInfo( unsigned short const & lhcFill, bool const & fromData = true );
  ~FillInfo();
  
  //constant static unsigned integer hosting the maximum number of LHC bunch slots
  static size_t const bunchSlots = 3564;
  
  //constant static unsigned integer hosting the available number of LHC bunch slots
  static size_t const availableBunchSlots = 2808;
  
  //reset instance
  void setFill( unsigned short const & lhcFill, bool const & fromData = true );
  
  //getters
  unsigned short const & fillNumber() const;
  
  bool const & isData() const;
  
  unsigned short const & bunchesInBeam1() const;
  
  unsigned short const & bunchesInBeam2() const;
  
  unsigned short const & collidingBunches() const;
  
  unsigned short const & targetBunches() const;
  
  FillTypeId const & fillType() const;
  
  ParticleTypeId const & particleTypeForBeam1() const;
  
  ParticleTypeId const & particleTypeForBeam2() const;
  
  float const & crossingAngle() const;

  float const & betaStar() const;
  
  float const & intensityForBeam1() const;
  
  float const & intensityForBeam2() const;
  
  float const & energy() const;
  
  cond::Time_t const & createTime() const;
  
  cond::Time_t const & beginTime() const;
  
  cond::Time_t const & endTime() const;
  
  std::string const & injectionScheme() const;
  
  std::bitset<bunchSlots+1> const & bunchBitsetForBeam1() const;
  
  std::bitset<bunchSlots+1> const & bunchBitsetForBeam2() const;
  
  //returns a boolean, true if the bunch slot number is in the circulating bunch configuration
  bool isBunchInBeam1( size_t const & bunch ) const;
  
  bool isBunchInBeam2( size_t const & bunch ) const;
  
  //member functions returning *by value* a vector with all filled bunch slots
  std::vector<unsigned short> bunchConfigurationForBeam1() const;
  
  std::vector<unsigned short> bunchConfigurationForBeam2() const;
  
  //setters
  unsigned short & bunchesInBeam1();
  
  unsigned short & bunchesInBeam2();
  
  unsigned short & collidingBunches();
  
  unsigned short & targetBunches();
  
  FillTypeId & fillType();
  
  ParticleTypeId & particleTypeForBeam1();
  
  ParticleTypeId & particleTypeForBeam2();
  
  float & crossingAngle();
  
  float & betaStar();
  
  float & intensityForBeam1();
  
  float & intensityForBeam2();
  
  float & energy();
  
  cond::Time_t & createTime();
  
  cond::Time_t & beginTime();
  
  cond::Time_t & endTime();
  
  std::string & injectionScheme();
  
  std::bitset<bunchSlots+1> & bunchBitsetForBeam1();
  
  std::bitset<bunchSlots+1> & bunchBitsetForBeam2();
  
  //sets all values in one go
  void setBeamInfo( unsigned short const & bunches1
                    ,unsigned short const & bunches2
                    ,unsigned short const & collidingBunches
                    ,unsigned short const & targetBunches
                    ,FillTypeId const & fillType
                    ,ParticleTypeId const & particleType1
                    ,ParticleTypeId const & particleType2
                    ,float const & angle
                    ,float const & beta
                    ,float const & intensity1
                    ,float const & intensity2
                    ,float const & energy
                    ,cond::Time_t const & createTime
                    ,cond::Time_t const & beginTime
                    ,cond::Time_t const & endTime
                    ,std::string const & scheme
                    ,std::bitset<bunchSlots+1> const & bunchConf1 
                    ,std::bitset<bunchSlots+1> const & bunchConf2 );
  
  //dumping values on output stream
  void print(std::stringstream & ss) const;
  
 private:
  bool m_isData;
  unsigned short m_lhcFill;
  unsigned short m_bunches1, m_bunches2, m_collidingBunches, m_targetBunches;
  FillTypeId m_fillType;
  ParticleTypeId m_particles1, m_particles2;
  float m_crossingAngle, m_betastar, m_intensity1, m_intensity2, m_energy;
  cond::Time_t m_createTime, m_beginTime, m_endTime;
  std::string m_injectionScheme;
  //BEWARE: since CMS counts bunches starting from one,
  //the size of the bitset must be incremented by one,
  //in order to avoid off-by-one
  std::bitset<bunchSlots+1> m_bunchConfiguration1, m_bunchConfiguration2;
};

std::ostream & operator<<( std::ostream &, FillInfo fillInfo );