MessageHelper Class Reference

#include <MessageHelper.h>

Collaboration diagram for MessageHelper:

Public Member Functions
	MessageHelper (const AthAlgTool &parent, unsigned int num)
	Pass to the constructor the number of messages. More...
void	incrementCount (unsigned int messageNumber)
void	printSummary (void) const
void	printWarning (unsigned int messageNumber) const
void	printWarning (unsigned int messageNumber, const std::string &addition) const
void	setMaxNumberOfMessagesPrinted (unsigned int num)
void	setMessage (unsigned int messageNumber, const std::string &message)
bool	wouldPrintWarning (unsigned int messageNumber) const

Private Attributes
const AthAlgTool &	m_parent
unsigned int	m_maxWarnings
	Maximum number of WARNING messages permitted. More...
std::vector< std::atomic< unsigned int > > m_warningCounts	ATLAS_THREAD_SAFE
	The counts per error (the index is the error number) More...
std::vector< std::string >	m_warningText
	The text for the WARNINGs (the index is the error number). More...

Detailed Description

Definition at line 16 of file MessageHelper.h.

Constructor & Destructor Documentation

MessageHelper()

MessageHelper::MessageHelper ( const AthAlgTool &  parent, unsigned int  num  )

inline

Pass to the constructor the number of messages.

Definition at line 41 of file MessageHelper.h.

    : m_parent(parent),
      m_maxWarnings(3),
      m_warningCounts(num),
      m_warningText(num) {}

Member Function Documentation

incrementCount()

void MessageHelper::incrementCount ( unsigned int  messageNumber )

inline

Definition at line 47 of file MessageHelper.h.

                                                                    {
  m_warningCounts[messageNumber]++;
}

printSummary()

void MessageHelper::printSummary ( void  ) const

inline

Definition at line 51 of file MessageHelper.h.

                                                  {
  bool haveWarnings = false;
  for (unsigned int i = 0; i < m_warningCounts.size(); ++i) {
    if (!m_warningCounts[i])
      continue;
    haveWarnings = true;
    break;
  }
  if (!haveWarnings)
    return;
 
  std::stringstream out;
  out << " summary of WARNING occurences (maximum shown during job: "
      << m_maxWarnings << "):";
  m_parent.msg(MSG::INFO) << out.str() << endmsg;
 
  for (unsigned int i = 0; i < m_warningCounts.size(); ++i) {
    if (!m_warningCounts[i])
      continue;
    out.str("");
    out << "   " << m_warningCounts[i] << ":\t" << m_warningText[i];
    m_parent.msg(MSG::INFO) << out.str() << endmsg;
  }
}

printWarning() [1/2]

void MessageHelper::printWarning ( unsigned int  messageNumber ) const

inline

Definition at line 76 of file MessageHelper.h.

                                                                        {
  unsigned int count = ++m_warningCounts[messageNumber];
  if (!m_parent.msgLvl(MSG::WARNING) || count > m_maxWarnings)
    return;
 
  m_parent.msg(MSG::WARNING) << m_warningText[messageNumber] << endmsg;
  if (count == m_maxWarnings)
    m_parent.msg(MSG::WARNING)
        << "Limit reached. No more messages of this type will be printed."
        << endmsg;
}

printWarning() [2/2]

void MessageHelper::printWarning ( unsigned int  messageNumber, const std::string &  addition  ) const

inline

Definition at line 88 of file MessageHelper.h.

                                                                         {
  unsigned int count = ++m_warningCounts[messageNumber];
  if (!m_parent.msgLvl(MSG::WARNING) || count > m_maxWarnings)
    return;
 
  m_parent.msg(MSG::WARNING)
      << m_warningText[messageNumber] << addition << endmsg;
  if (count == m_maxWarnings)
    m_parent.msg(MSG::WARNING)
        << "Limit reached. No more messages of this type will be printed."
        << endmsg;
}

setMaxNumberOfMessagesPrinted()

void MessageHelper::setMaxNumberOfMessagesPrinted ( unsigned int  num )

inline

Definition at line 102 of file MessageHelper.h.

                                                                         {
  m_maxWarnings = num;
}

setMessage()

void MessageHelper::setMessage ( unsigned int  messageNumber, const std::string &  message  )

inline

Definition at line 106 of file MessageHelper.h.

                                                                {
  if (messageNumber >= m_warningCounts.size())
    std::abort();
  m_warningCounts[messageNumber] = 0;
  m_warningText[messageNumber] = message;
}

wouldPrintWarning()

bool MessageHelper::wouldPrintWarning ( unsigned int  messageNumber ) const

inline

Definition at line 114 of file MessageHelper.h.

                                                                             {
  if (m_parent.msgLvl(MSG::WARNING) &&
      m_warningCounts[messageNumber] <= m_maxWarnings)
    return true;
  return false;
}

Member Data Documentation

ATLAS_THREAD_SAFE

std::vector<std::atomic<unsigned int> > m_warningCounts MessageHelper::ATLAS_THREAD_SAFE

mutableprivate

The counts per error (the index is the error number)

Definition at line 34 of file MessageHelper.h.

m_maxWarnings

unsigned int MessageHelper::m_maxWarnings

private

Maximum number of WARNING messages permitted.

Definition at line 32 of file MessageHelper.h.

m_parent

const AthAlgTool& MessageHelper::m_parent

private

Definition at line 30 of file MessageHelper.h.

m_warningText

std::vector<std::string> MessageHelper::m_warningText

private

The text for the WARNINGs (the index is the error number).

Filled in ctor.

Definition at line 37 of file MessageHelper.h.

---

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

• MessageHelper.h