One error-log record with provenance and severity. More...

#include <ErrorLogger.h>

Collaboration diagram for mspass::utility::LogData:

Public Member Functions
	LogData ()

	LogData (const int jid, const std::string alg, const mspass::utility::MsPASSError &merr)

	LogData (const int jid, const std::string alg, const std::string msg, const mspass::utility::ErrorSeverity lvl)

Public Attributes
int	job_id

int	p_id

std::string	algorithm

mspass::utility::ErrorSeverity	badness

std::string	message

Friends
std::ostream &	operator<< (std::ostream &, LogData &)

Detailed Description

One error-log record with provenance and severity.

Constructor & Destructor Documentation

◆ LogData() [1/3]

mspass::utility::LogData::LogData ( )

inline

Construct an empty log record.

23{};

◆ LogData() [2/3]

mspass::utility::LogData::LogData	(	const int	jid,
		const std::string	alg,
		const mspass::utility::MsPASSError &	merr
	)

Normal constuctor from a MsPASSError or child of same.

Parameters

jid	is the value to assign to job_id.
alg	is assigned to algorithm attribute.
merr	is parsed to fill the message and severity fields. Note p_id is always fetched with the system call getpid in the constructor.

                                                       {
  job_id = jid;
  p_id = getpid();
  algorithm = alg;
  message = merr.what();
  badness = merr.severity();
}

References algorithm, badness, job_id, message, p_id, mspass::utility::MsPASSError::severity(), and mspass::utility::MsPASSError::what().

◆ LogData() [3/3]

mspass::utility::LogData::LogData	(	const int	jid,
		const std::string	alg,
		const std::string	msg,
		const mspass::utility::ErrorSeverity	lvl
	)

Normal constuctor from strings.

Parameters

jid	is the value to assign to job_id.
alg	is assigned to algorithm attribute.
msg	is the error message.
lvl	is the error severity. Note p_id is always fetched with the system call getpid in the constructor.

                                                       {
  job_id = jid;
  p_id = getpid();
  algorithm = alg;
  message = msg;
  badness = lvl;
}

References algorithm, badness, job_id, message, and p_id.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	,
		LogData &
	)

friend

Stream one log record to an output stream.

Member Data Documentation

◆ algorithm

std::string mspass::utility::LogData::algorithm

Algorithm or component that posted the message.

◆ badness

mspass::utility::ErrorSeverity mspass::utility::LogData::badness

Severity assigned to the message.

◆ job_id

int mspass::utility::LogData::job_id

Processing job identifier.

◆ message

std::string mspass::utility::LogData::message

Human-readable log message.

◆ p_id

int mspass::utility::LogData::p_id

Process id returned by getpid().

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

Public Member Functions

Public Attributes

Friends