BackgroundMetaData.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <framework/pcore/Mergeable.h>
#include <framework/core/FrameworkExceptions.h>
 
#include <string>
#include <string_view>
 
namespace Belle2 {
  class BackgroundMetaData: public Mergeable {
 
  public:
 
    enum BG_TAG { bg_none             = 0,  
                  bg_Coulomb_LER      = 1,  
                  bg_Coulomb_HER      = 2,  
                  bg_RBB_LER          = 3,  
                  bg_RBB_HER          = 4,  
                  bg_Touschek_LER     = 5,  
                  bg_Touschek_HER     = 6,  
                  bg_twoPhoton        = 7,  
                  bg_RBB_gamma        = 8,  
                  bg_RBB_LER_far      = 9,  
                  bg_RBB_HER_far      = 10, 
                  bg_Touschek_LER_far = 11, 
                  bg_Touschek_HER_far = 12, 
                  bg_SynchRad_LER     = 13, 
                  bg_SynchRad_HER     = 14, 
                  bg_BHWide_LER       = 15, 
                  bg_BHWide_HER       = 16, 
                  bg_RBB              = 17, 
                  bg_BHWide           = 18, 
                  bg_BHWideLargeAngle = 19, 
                  bg_InjectionLER     = 21, 
                  bg_InjectionHER     = 22, 
                  bg_Brems_LER        = 23, 
                  bg_Brems_HER        = 24, 
                  bg_Brems_base_LER      = 25, 
                  bg_Brems_dynamic_LER   = 26, 
                  bg_Brems_base_HER      = 27, 
                  bg_Brems_dynamic_HER   = 28, 
                  bg_Coulomb_base_LER    = 29, 
                  bg_Coulomb_dynamic_LER = 30, 
                  bg_Coulomb_base_HER    = 31, 
                  bg_Coulomb_dynamic_HER = 32, 
                  bg_other            = 99  
                };
 
    BELLE2_DEFINE_EXCEPTION(BackgroundMetaDataNotMergeable,
                            "BackgroundMetaData: objects cannot be merged");
 
    enum EFileType { c_Usual = 0,   
                     c_ECL   = 1,   
                     c_PXD   = 2    
                   };
 
    BackgroundMetaData()
    {}
 
    void setBackgroundType(const std::string& type) {m_backgroundType = type;}
 
    void setBackgroundTag(BG_TAG tag) {m_backgroundTag = tag;}
 
    void setRealTime(float time) {m_realTime = time;}
 
    void setFileType(EFileType type) {m_fileType = type;}
 
    const std::string& getBackgroundType() const {return m_backgroundType;}
 
    BG_TAG getBackgroundTag() const {return m_backgroundTag;}
 
    float getRealTime() const {return m_realTime;}
 
    EFileType getFileType() const {return m_fileType;}
 
    static constexpr std::string_view getDefaultBackgroundOverlayType() { return c_defaultBackgroundOverlayType; }
 
    virtual void merge(const Mergeable* other) override;
 
    virtual void clear() override;
 
 
  private:
 
    bool canBeMerged(const BackgroundMetaData* other);
 
    std::string m_backgroundType; 
    BG_TAG m_backgroundTag = bg_other; 
    float m_realTime = 0; 
    EFileType m_fileType = c_Usual; 
    static constexpr std::string_view c_defaultBackgroundOverlayType = "RandomTrigger"; 
    ClassDefOverride(BackgroundMetaData, 4); 
  };
}