mspass::utility::ErrorLogger Class Reference

Container to hold error logs for a data object. More...

#include <ErrorLogger.h>

Public Member Functions
	ErrorLogger (int job)
	ErrorLogger (const ErrorLogger &parent)
void	set_job_id (int jid)
int	get_job_id ()
int	log_error (const mspass::utility::MsPASSError &merr)
int	log_error (const std::string alg, const std::string mess, const mspass::utility::ErrorSeverity level)
int	log_verbose (const std::string alg, const std::string mess)
	Log a verbose message marking it informational.
std::list< LogData >	get_error_log () const
int	size () const
void	clear ()
ErrorLogger &	operator= (const ErrorLogger &parent)
ErrorLogger &	operator+= (const ErrorLogger &parent)
std::list< LogData >	worst_errors () const

Detailed Description

Container to hold error logs for a data object.

This class is intended mainly to be added to data objects in mspass to provide a scalable, thread safe method for logging errors. Atomic mspass data objects (e.g. seismograms and time series objects) all use this class to log errors and mark data with ambiguous states. The log can explain why data is an invalid state, but can also contain debug information normally enabled by something like a verbose option to a program.

Constructor & Destructor Documentation

ErrorLogger() [1/3]

mspass::utility::ErrorLogger::ErrorLogger ( )

inline

{ job_id = 0; };

ErrorLogger() [2/3]

mspass::utility::ErrorLogger::ErrorLogger ( int  job )

inline

{ job_id = job; };

ErrorLogger() [3/3]

mspass::utility::ErrorLogger::ErrorLogger

(

const ErrorLogger &

parent

)

                                                  {
  job_id = parent.job_id;
  /* Just copy this.  Could call getpid every time, but the only way I can
  conceive that would be an issue is if the entry were serialized and sent
  somewhere through something like mpi.   A copy is a copy so seems best to
  clone this not ask for confusion. */
  allmessages = parent.allmessages;
}

Member Function Documentation

clear()

void mspass::utility::ErrorLogger::clear ( )

inline

Reset error log container to make it empty.

{ allmessages.clear(); };

get_error_log()

std::list< LogData > mspass::utility::ErrorLogger::get_error_log ( ) const

inline

{ return allmessages; };

get_job_id()

int mspass::utility::ErrorLogger::get_job_id ( )

inline

{ return job_id; };

log_error() [1/2]

int mspass::utility::ErrorLogger::log_error

(

const mspass::utility::MsPASSError &

merr

)

Logs one error message.

Parameters

merr	- many mspass procedures throw MsPASSError objects. This simplifies the process of posting them to an error log.

Returns

size of error log after insertion.

                                                               {
  LogData thislog(this->job_id, string("MsPASSError"), merr);
  allmessages.push_back(thislog);
  return allmessages.size();
}

log_error() [2/2]

int mspass::utility::ErrorLogger::log_error	(	const std::string	alg,
		const std::string	mess,
		const mspass::utility::ErrorSeverity	level = ErrorSeverity::Invalid
	)

Log one a message directly with a specified severity.

This is a convenience overload of log_error. It splits the MsPASSError components as arguments with a default that allows a default behavior of Invalid as the error state.

Parameters

alg	is name of algorithm posting this message
mess	is the message to be posted.
level	is the badness level to be set with the message. (default is ErrorSeverity::Invalid).

Returns

size of error log after insertion.

                                                                   {
  LogData thislog(this->job_id, alg, mess, level);
  allmessages.push_back(thislog);
  return allmessages.size();
}

log_verbose()

int mspass::utility::ErrorLogger::log_verbose	(	const std::string	alg,
		const std::string	mess
	)

Log a verbose message marking it informational.

Frequently programs need a verbose option to log something of interest that is not an error but potentially useful. This alternate logging method posts the string mess and marks it Informational. Returns the size of the log after insertion.

                                                                      {
  int count;
  count = this->log_error(alg, mess, ErrorSeverity::Informational);
  return count;
};

References log_error().

operator+=()

ErrorLogger & mspass::utility::ErrorLogger::operator+=

(

const ErrorLogger &

parent

)

For this object + of += means add the log data from the rhs to the lhs. lhs defines the job_id.

                                                             {
  if (this != &other) {
    for (auto lptr = other.allmessages.begin(); lptr != other.allmessages.end();
         ++lptr) {
      this->allmessages.push_back(*lptr);
    }
  }
  return *this;
}

operator=()

ErrorLogger & mspass::utility::ErrorLogger::operator=

(

const ErrorLogger &

parent

)

                                                             {
  if (this != &parent) {
    job_id = parent.job_id;
    allmessages = parent.allmessages;
  }
  return *this;
}

set_job_id()

void mspass::utility::ErrorLogger::set_job_id ( int  jid )

inline

{ job_id = jid; };

size()

int mspass::utility::ErrorLogger::size ( ) const

inline

{ return allmessages.size(); };

worst_errors()

list< LogData > mspass::utility::ErrorLogger::worst_errors

(

)

const

Return an std::list container with most serious error level marked.

                                              {
  /* Return immediately if the messages container is empty. */
  if (allmessages.size() <= 0)
    return allmessages;
  list<LogData> flist, ivlist, slist, clist, dlist, ilist;
  list<LogData>::const_iterator aptr;
  for (aptr = allmessages.begin(); aptr != allmessages.end(); ++aptr) {
    switch (aptr->badness) {
    case ErrorSeverity::Fatal:
      flist.push_back(*aptr);
      break;
    case ErrorSeverity::Invalid:
      ivlist.push_back(*aptr);
      break;
    case ErrorSeverity::Suspect:
      slist.push_back(*aptr);
      break;
    case ErrorSeverity::Complaint:
      clist.push_back(*aptr);
      break;
    case ErrorSeverity::Debug:
      dlist.push_back(*aptr);
      break;
    case ErrorSeverity::Informational:
    default:
      ilist.push_back(*aptr);
    };
  }
  if (flist.size() > 0)
    return flist;
  if (ivlist.size() > 0)
    return ivlist;
  if (slist.size() > 0)
    return slist;
  if (clist.size() > 0)
    return clist;
  if (dlist.size() > 0)
    return dlist;
  return ilist;
}

---

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

• /home/runner/work/mspass/mspass/cxx/include/mspass/utility/ErrorLogger.h
• /home/runner/work/mspass/mspass/cxx/src/lib/utility/ErrorLogger.cc