asg::MsgHelpers Struct Reference

a helper class for functions dealing with messages More...

#include <MsgHelpers.h>

Collaboration diagram for asg::MsgHelpers:

Static Public Member Functions
static MsgStream &	pkgMsgStream (const std::string &package)
	the message stream for the given package identifier More...
static void	setPkgMsgLevel (const std::string &package, MSG::Level level)
	set the package message level for the given name More...
static void	printAllPkgMsgLevels ()
	print all package message levels More...

Detailed Description

a helper class for functions dealing with messages

This class contains only static member functions and it is solely meant as a work-around for a limitation in ROOT dictionaries: python/root will not autoload a dictionary when a function contained in that dictionary is requested. However, if the function is a static member function of a class it will work just fine, so instead of standalone functions these are now all static member functions.

Definition at line 30 of file MsgHelpers.h.

Member Function Documentation

pkgMsgStream()

MsgStream & asg::MsgHelpers::pkgMsgStream ( const std::string &  package )

static

the message stream for the given package identifier

This is for package-level streaming, which in itself is discouraged, but sometimes it is just not practical to wrap code that wants to write out a message into a tool or algorithm. Maybe if we have dual-use services some day, this may become less relevant.

Normally users shouldn't access this directly, but rely on the wrappers defined above.

Definition at line 70 of file MsgHelpers.cxx.

  {
    std::lock_guard<std::recursive_mutex> lock {packageMsgMutex()};
    auto iter = packageMsgStreamMap().find (package);
    if (iter != packageMsgStreamMap().end())
      return iter->second;
 
    const std::string fullName {"Package." + package};
#ifdef XAOD_STANDALONE
    auto result = packageMsgStreamMap().emplace (package, fullName);
#else
    auto result = packageMsgStreamMap().emplace
      (std::piecewise_construct,
       std::forward_as_tuple (package),
       std::forward_as_tuple (Athena::getMessageSvc(Athena::Options::Eager), fullName));
#endif
    assert (result.second);
    return result.first->second;
  }

printAllPkgMsgLevels()

void asg::MsgHelpers::printAllPkgMsgLevels ( )

static

print all package message levels

This is mostly to have a single, stable function that can be called from python-configuration, without having to rely on any of the details of the implementation above.

Definition at line 102 of file MsgHelpers.cxx.

  {
    using namespace msgAsgMessaging;
    std::lock_guard<std::recursive_mutex> lock {packageMsgMutex()};
    ANA_MSG_INFO ("package message levels:");
    for (auto& msgStream : packageMsgStreamMap())
    {
      ANA_MSG_INFO ("  package=" << msgStream.first << " level=" << name (msgStream.second.level()) << "(" << unsigned (msgStream.second.level()) << ")");
    }
  }

setPkgMsgLevel()

void asg::MsgHelpers::setPkgMsgLevel ( const std::string &  package, MSG::Level  level  )

static

set the package message level for the given name

This is mostly to have a single, stable function that can be called from python-configuration, without having to rely on any of the details of the implementation above.

Definition at line 93 of file MsgHelpers.cxx.

  {
    std::lock_guard<std::recursive_mutex> lock {packageMsgMutex()};
    pkgMsgStream (package).setLevel (level);
  }

---

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

• MsgHelpers.h
• MsgHelpers.cxx