Logger Class Reference

Keeps the error and warning messages. More...

#include <Logger.h>

Classes
class	Message
	Simple data structure to hold the messages. More...

Public Types
enum	EMessageType { ERROR = 0 , WARNING = 1 }

Public Member Functions
	Logger ()
virtual	~Logger ()
template<typename... Args>
void	add (EMessageType type, Args &&... args)
	Add a message to the log.
void	emitLoggedErrors () const
	Calls mooseError if there are any logged errors.
void	emitLoggedWarnings () const
	Calls mooseWarning if there are any logged warnings.
unsigned int	getNumberOfErrors () const
	Return the number of errors.
unsigned int	getNumberOfWarnings () const
	Return the number of warnings.

Protected Attributes
unsigned int	_n_errors
	The number of errors.
unsigned int	_n_warnings
	The number of warnings.
std::vector< Message * >	_msgs
	The list of logged messages.

Detailed Description

Keeps the error and warning messages.

Definition at line 17 of file Logger.h.

Member Enumeration Documentation

EMessageType

enum Logger::EMessageType

Enumerator
ERROR
WARNING

Definition at line 23 of file Logger.h.

  {
    ERROR = 0,
    WARNING = 1
  };

Constructor & Destructor Documentation

Logger()

Logger::Logger

(

)

Definition at line 12 of file Logger.C.

: _n_errors(0), _n_warnings(0) {}

~Logger()

Logger::~Logger ( )

virtual

Definition at line 14 of file Logger.C.

{
  for (auto && it : _msgs)
    delete it;
}

Member Function Documentation

add()

template<typename... Args>

void Logger::add ( EMessageType  type, Args &&...  args  )

inline

Add a message to the log.

Parameters

type	The type of the message

Definition at line 35 of file Logger.h.

  {
    std::ostringstream oss;
    moose::internal::mooseStreamAll(oss, args...);
 
    Logger::Message * msg = new Logger::Message(type, oss.str());
    _msgs.push_back(msg);
 
    switch (type)
    {
      case ERROR:
        _n_errors++;
        break;
      case WARNING:
        _n_warnings++;
        break;
    }
  }

Referenced by LoggingInterface::logComponentError(), LoggingInterface::logComponentWarning(), LoggingInterface::logError(), and LoggingInterface::logWarning().

emitLoggedErrors()

void Logger::emitLoggedErrors

(

)

const

Calls mooseError if there are any logged errors.

Definition at line 21 of file Logger.C.

{
  if (_n_errors > 0)
  {
    std::ostringstream oss;
    oss << "The following errors were encountered:\n";
    for (const auto & msg_it : _msgs)
      if (msg_it->_type == ERROR)
        oss << "  - " << msg_it->_msg << "\n";
    mooseError(oss.str());
  }
}

Referenced by Simulation::controlDataIntegrityCheck(), and Simulation::integrityCheck().

emitLoggedWarnings()

void Logger::emitLoggedWarnings

(

)

const

Calls mooseWarning if there are any logged warnings.

Definition at line 35 of file Logger.C.

{
  if (_n_warnings > 0)
  {
    std::ostringstream oss;
    oss << "The following warnings were encountered:\n";
    for (const auto & msg_it : _msgs)
      if (msg_it->_type == WARNING)
        oss << "  - " << msg_it->_msg << "\n";
    mooseWarning(oss.str());
  }
}

Referenced by Simulation::integrityCheck().

getNumberOfErrors()

unsigned int Logger::getNumberOfErrors

(

)

const

Return the number of errors.

Returns

The number of errors in this log

Definition at line 49 of file Logger.C.

{
  return _n_errors;
}

getNumberOfWarnings()

unsigned int Logger::getNumberOfWarnings

(

)

const

Return the number of warnings.

Returns

The number of warnings in this log

Definition at line 55 of file Logger.C.

{
  return _n_warnings;
}

Member Data Documentation

_msgs

std::vector<Message *> Logger::_msgs

protected

The list of logged messages.

Definition at line 102 of file Logger.h.

Referenced by add(), emitLoggedErrors(), emitLoggedWarnings(), and ~Logger().

_n_errors

unsigned int Logger::_n_errors

protected

The number of errors.

Definition at line 98 of file Logger.h.

Referenced by add(), emitLoggedErrors(), and getNumberOfErrors().

_n_warnings

unsigned int Logger::_n_warnings

protected

The number of warnings.

Definition at line 100 of file Logger.h.

Referenced by add(), emitLoggedWarnings(), and getNumberOfWarnings().

---

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

• thermal_hydraulics/include/utils/Logger.h
• thermal_hydraulics/src/utils/Logger.C