#include <ConfigHelper.h>

Inheritance diagram for jet::ConfigHelper:

Collaboration diagram for jet::ConfigHelper:

Public Member Functions
	ConfigHelper (const TString &confPrefix, const TString &MCtype, const float energyScaleVal)
virtual StatusCode	initialize (TEnv &settings)
virtual	~ConfigHelper ()
bool	isCompGroup () const
bool	isComponent () const
bool	isGroup () const
const ComponentHelper *	getComponentInfo () const
const GroupHelper *	getGroupInfo () const
void	enforceGroupNamePrefix (const std::string &prefix)
void	enforceGroupNamePrefix (const TString &prefix)
void	setComponentJetDefSuffix (const std::string &suffix)
void	setComponentJetDefSuffix (const TString &suffix)
void	addValidityHistogram (const std::string &histName)
void	addValidityHistogram (const TString &histName)

Private Member Functions
	ConfigHelper ()
void	setLevel (MSG::Level lvl)
	Change the current logging level.
void	initMessaging () const
	Initialize our message level and MessageSvc.
Functions providing the same interface as AthMessaging
bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.

Private Attributes
bool	m_isInit {}
const TString	m_confPrefix
const TString	m_MCtype
const float	m_energyScale {}
ComponentHelper *	m_cInfo {}
GroupHelper *	m_gInfo {}
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels).
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging).

Detailed Description

Definition at line 105 of file ConfigHelper.h.

Constructor & Destructor Documentation

◆ ConfigHelper() [1/2]

jet::ConfigHelper::ConfigHelper	(	const TString &	confPrefix,
		const TString &	MCtype,
		const float	energyScaleVal )

Definition at line 172 of file ConfigHelper.cxx.

    : asg::AsgMessaging(confPrefix.Data())
    , m_isInit(false)
    , m_confPrefix(confPrefix)
    , m_MCtype(MCtype)
    , m_energyScale(energyScaleVal)
    , m_cInfo(nullptr)
    , m_gInfo(nullptr)
{ }

◆ ~ConfigHelper()

jet::ConfigHelper::~ConfigHelper ( )

virtual

Definition at line 182 of file ConfigHelper.cxx.

{
    JESUNC_SAFE_DELETE(m_cInfo);
    JESUNC_SAFE_DELETE(m_gInfo);
}

◆ ConfigHelper() [2/2]

jet::ConfigHelper::ConfigHelper ( )

private

Definition at line 160 of file ConfigHelper.cxx.

    : asg::AsgMessaging("")
    , m_isInit(false)
    , m_confPrefix("")
    , m_MCtype("")
    , m_energyScale(0)
    , m_cInfo(nullptr)
    , m_gInfo(nullptr)
{
    JESUNC_NO_DEFAULT_CONSTRUCTOR;
}

Member Function Documentation

◆ addValidityHistogram() [1/2]

void jet::ConfigHelper::addValidityHistogram ( const std::string & histName )

Definition at line 328 of file ConfigHelper.cxx.

{
    addValidityHistogram(TString(histName.c_str()));
}

◆ addValidityHistogram() [2/2]

void jet::ConfigHelper::addValidityHistogram ( const TString & histName )

Definition at line 333 of file ConfigHelper.cxx.

{
    if (histName != "")
    {
        if (m_cInfo->validName != "")
        {
            ATH_MSG_WARNING(Form("Ignoring request to add validity histogram to: %s",m_cInfo->name.Data()));
            ATH_MSG_WARNING(Form("The following validity histogram was already specified: %s",m_cInfo->validName.Data()));
            ATH_MSG_WARNING(Form("Blocking overwrite with a new validity histogram: %s",histName.Data()));
        }
        else
            m_cInfo->validName = histName;
    }
}

◆ enforceGroupNamePrefix() [1/2]

void jet::ConfigHelper::enforceGroupNamePrefix ( const std::string & prefix )

Definition at line 280 of file ConfigHelper.cxx.

{
    enforceGroupNamePrefix(TString(prefix.c_str()));
}

◆ enforceGroupNamePrefix() [2/2]

void jet::ConfigHelper::enforceGroupNamePrefix ( const TString & prefix )

Definition at line 285 of file ConfigHelper.cxx.

{
    // Special config file string must exactly match this to activate the condition
    const TString NOPREFIX = "NOPREFIX_";
 
    // Check for a special NOPREFIX string
    // This is to support parameters from other groups we have propagated into our uncertainties
    // NPs can now have the same name, so tools will coherently scale different properties for the same uncertainty name
    if (m_gInfo->name.BeginsWith(NOPREFIX))
    m_gInfo->name = m_gInfo->name.ReplaceAll(NOPREFIX,"");
 
    // Doesn't have the prefix
    else if (!m_gInfo->name.BeginsWith(prefix,TString::kIgnoreCase))
        m_gInfo->name = Form("%s%s",prefix.Data(),m_gInfo->name.Data());
    // Has the right prefix, but not the right case (enforce identical prefix)
    else if (!m_gInfo->name.BeginsWith(prefix))
        m_gInfo->name.Replace(0,prefix.Length(),prefix);
}

◆ getComponentInfo()

const ComponentHelper * jet::ConfigHelper::getComponentInfo ( ) const

Definition at line 260 of file ConfigHelper.cxx.

{
    if (!m_isInit)
    {
        ATH_MSG_ERROR("ConfigHelper has not yet been initialized: " << m_confPrefix.Data());
        return nullptr;
    }
    return m_cInfo;
}

◆ getGroupInfo()

const GroupHelper * jet::ConfigHelper::getGroupInfo ( ) const

Definition at line 270 of file ConfigHelper.cxx.

{
    if (!m_isInit)
    {
        ATH_MSG_ERROR("ConfigHelper has not yet been initialized: " << m_confPrefix.Data());
        return nullptr;
    }
    return m_gInfo;
}

◆ initialize()

StatusCode jet::ConfigHelper::initialize ( TEnv & settings )

virtual

Definition at line 188 of file ConfigHelper.cxx.

{
    if (m_isInit)
    {
        ATH_MSG_ERROR("Blocking double-initialization: " << m_confPrefix.Data());
        return StatusCode::FAILURE;
    }
 
    m_cInfo = new ComponentHelper(settings, m_confPrefix, m_MCtype, m_energyScale);
    if (!m_cInfo)
    {
        ATH_MSG_ERROR("Failed to create ComponentHelper: " << m_confPrefix.Data());
        return StatusCode::FAILURE;
    }
 
    m_gInfo = new GroupHelper(settings, m_confPrefix, m_MCtype);
    if (!m_gInfo)
    {
        ATH_MSG_ERROR("Failed to create GroupHelper: " << m_confPrefix.Data());
        return StatusCode::FAILURE;
    }
 
    m_isInit = true;
    return StatusCode::SUCCESS;
}

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

◆ isCompGroup()

bool jet::ConfigHelper::isCompGroup ( ) const

Definition at line 214 of file ConfigHelper.cxx.

{
    if (!m_isInit)
    {
        ATH_MSG_ERROR("ConfigHelper has not yet been initialized: " << m_confPrefix.Data());
        return false;
    }
    
    // Simple group possibilities:
    //      Single-component with all group info specified on the component, "Group" == 0 (or unspec)
    //      Multi-component "SubComp" with all group info specified on the component, "Group" == 0
    // So the defining factor of simple groups is "Group" == 0 (== unspecified)
    // It also has to have a name to ensure it's not just empty (it will be if this is a group)
    if (m_cInfo->groupNum == 0 && m_cInfo->name != "")
        return true;
    return false;
}

◆ isComponent()

bool jet::ConfigHelper::isComponent ( ) const

Definition at line 232 of file ConfigHelper.cxx.

{
    if (!m_isInit)
    {
        ATH_MSG_ERROR("ConfigHelper has not yet been initialized: " << m_confPrefix.Data());
        return false;
    }
    
    // Component means that it has a component name and that the group is specified
    if (m_cInfo->groupNum != 0 && m_cInfo->name != "")
        return true;
    return false;
}

◆ isGroup()

bool jet::ConfigHelper::isGroup ( ) const

Definition at line 246 of file ConfigHelper.cxx.

{
    if (!m_isInit)
    {
        ATH_MSG_ERROR("ConfigHelper has not yet been initialized: " << m_confPrefix.Data());
        return false;
    }
 
    // Group means that it has a group name and the group is specified
    if (m_gInfo->groupNum != 0 && m_gInfo->name != "")
        return true;
    return false;
}

◆ msg() [1/2]

MsgStream & asg::AsgMessaging::msg ( ) const

inherited

The standard message stream.

Returns: A reference to the default message stream of this object.

Definition at line 49 of file AsgMessaging.cxx.

                                      {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg();
#else // not XAOD_STANDALONE
      return m_msg;
#endif // not XAOD_STANDALONE
   }

◆ msg() [2/2]

MsgStream & asg::AsgMessaging::msg ( const MSG::Level lvl ) const

inherited

The standard message stream.

Parameters

lvl	The message level to set the stream to

Returns: A reference to the default message stream, set to level "lvl"

Definition at line 57 of file AsgMessaging.cxx.

                                                          {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg( lvl );
#else // not XAOD_STANDALONE
      m_msg << lvl;
      return m_msg;
#endif // not XAOD_STANDALONE
   }

◆ msgLvl()

bool asg::AsgMessaging::msgLvl ( const MSG::Level lvl ) const

inherited

Test the output level of the object.

Parameters

lvl	The message level to test against

Returns: boolean Indicting if messages at given level will be printed; true If messages at level "lvl" will be printed

Definition at line 41 of file AsgMessaging.cxx.

                                                       {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msgLvl( lvl );
#else // not XAOD_STANDALONE
      return m_msg.msgLevel( lvl );
#endif // not XAOD_STANDALONE
   }

◆ setComponentJetDefSuffix() [1/2]

void jet::ConfigHelper::setComponentJetDefSuffix ( const std::string & suffix )

Definition at line 304 of file ConfigHelper.cxx.

{
    setComponentJetDefSuffix(TString(suffix.c_str()));
}

◆ setComponentJetDefSuffix() [2/2]

void jet::ConfigHelper::setComponentJetDefSuffix ( const TString & suffix )

Definition at line 309 of file ConfigHelper.cxx.

{
    if (!m_cInfo)[[unlikely]] {
      ATH_MSG_WARNING("ConfigHelper::setComponentJetDefSuffix: 'm_cInfo' is nullptr.");
      return;
    }
    if (m_cInfo->uncNames.empty() && m_cInfo->subComps.empty())
        m_cInfo->uncNames.push_back(m_cInfo->name+"_"+suffix);
    else if (!m_cInfo->uncNames.empty())
        for (size_t iName = 0; iName < m_cInfo->uncNames.size(); ++iName)
            m_cInfo->uncNames[iName] = m_cInfo->uncNames[iName] + "_" + suffix;
    else if (!m_cInfo->subComps.empty())
        for (size_t iSubComp = 0; iSubComp < m_cInfo->subComps.size(); ++iSubComp)
            m_cInfo->subComps[iSubComp] = m_cInfo->subComps[iSubComp] + "_" + suffix;
    
    if (m_cInfo->validName != "")
        m_cInfo->validName = m_cInfo->validName+"_"+suffix;
}

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging).

Definition at line 141 of file AthMessaging.h.

◆ m_cInfo

ComponentHelper* jet::ConfigHelper::m_cInfo {}

private

Definition at line 140 of file ConfigHelper.h.

140{};

◆ m_confPrefix

const TString jet::ConfigHelper::m_confPrefix

private

Definition at line 135 of file ConfigHelper.h.

◆ m_energyScale

const float jet::ConfigHelper::m_energyScale {}

private

Definition at line 137 of file ConfigHelper.h.

137{};

◆ m_gInfo

GroupHelper* jet::ConfigHelper::m_gInfo {}

private

Definition at line 141 of file ConfigHelper.h.

141{};

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_isInit

bool jet::ConfigHelper::m_isInit {}

private

Definition at line 132 of file ConfigHelper.h.

132{};

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ MSG::NIL };

◆ m_MCtype

const TString jet::ConfigHelper::m_MCtype

private

Definition at line 136 of file ConfigHelper.h.

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels).

Definition at line 132 of file AthMessaging.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConfigHelper() [1/2]

◆ ~ConfigHelper()

◆ ConfigHelper() [2/2]

Member Function Documentation

◆ addValidityHistogram() [1/2]

◆ addValidityHistogram() [2/2]

◆ enforceGroupNamePrefix() [1/2]

◆ enforceGroupNamePrefix() [2/2]

◆ getComponentInfo()

◆ getGroupInfo()

◆ initialize()

◆ initMessaging()

◆ isCompGroup()

◆ isComponent()

◆ isGroup()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ setComponentJetDefSuffix() [1/2]

◆ setComponentJetDefSuffix() [2/2]

◆ setLevel()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_cInfo

◆ m_confPrefix

◆ m_energyScale

◆ m_gInfo

◆ m_imsg

◆ m_isInit

◆ m_lvl

◆ m_MCtype

◆ m_msg_tls

◆ m_nm