LogMessage Class Reference

The LogMessage class. More...

#include <LogMessage.h>

Collaboration diagram for LogMessage:

Classes
struct	TextHasher
	Helper struct to hash and compare messages only by log level and message content. More...

Public Member Functions
	LogMessage (LogConfig::ELogLevel logLevel, const std::string &message, const char *package, std::string function, std::string file, unsigned int line, int debugLevel=0)
	The LogMessage constructor. More...
	LogMessage (LogConfig::ELogLevel logLevel, LogVariableStream &&messageStream, const char *package, std::string function, std::string file, unsigned int line, int debugLevel=0)
	The LogMessage constructor taking a LogVariableStream which can contains name/value pairs. More...
	LogMessage (LogMessage &&)=default
	Provide move constructor.
	LogMessage (LogMessage const &lm)=default
	Provide copy-constructor.
bool	operator== (const LogMessage &message) const
	Compares two messages. More...
bool	operator!= (const LogMessage &message) const
	Check for inequality.
LogMessage &	operator= (const LogMessage &lvs)=default
	Custom assignment-operator, thanks to stringsream's incompetence ...
LogConfig::ELogLevel	getLogLevel () const
	Returns the log level of the message. More...
const std::string &	getPackage () const
	Returns the package where the message was sent from. More...
const std::string	getMessage () const
	Returns the message text. More...
void	setModule (const std::string &module)
	Configure which information should be printed.
void	setLogInfo (unsigned int logInfo)
	Configure which information should be printed.
std::ostream &	print (std::ostream &out) const
	Generate output stream. More...
std::string	toJSON (bool complete) const
	Return a json string for the log message. More...
const std::vector< LogVar > &	getLogVariables () const
	Return a reference to the log variables associated with this message.

Private Attributes
LogConfig::ELogLevel	m_logLevel
	The log level of the message.
LogVariableStream	m_message
	The message stream which should be sent.
std::string	m_module
	The module name where the message was sent from.
std::string	m_package
	The package name where the message was sent from.
std::string	m_function
	The function name where the message was sent from.
std::string	m_file
	The file name where the message was sent from.
unsigned int	m_line
	The line number in the source code where the message was sent from.
int	m_debugLevel
	The debug level for messages with level=c_Debug.
unsigned int	m_logInfo
	kind of information to show (ORed combination of LogConfig::ELogInfo flags).

Detailed Description

The LogMessage class.

This class encapsulates a logging message.

Definition at line 39 of file LogMessage.h.

Constructor & Destructor Documentation

LogMessage() [1/2]

LogMessage	(	LogConfig::ELogLevel	logLevel,
		const std::string &	message,
		const char *	package,
		std::string	function,
		std::string	file,
		unsigned int	line,
		int	debugLevel = 0
	)

The LogMessage constructor.

Parameters

logLevel	The log level of the message (e.g. debug, info, warning, error, fatal).
message	The message string which should be send. This will be internally converted to a LogVariableStream with the text message and 0 variables.
package	The package name where the message was sent from (can be NULL)
function	The function name where the message was sent from.
file	The file name where the message was sent from.
line	The line number in the source code where the message was sent from.

Definition at line 24 of file LogMessage.cc.

                                                                                                :
  m_logLevel(logLevel),
  m_message(message),
  m_module(""),
  m_package(package ? package : ""),
  m_function(std::move(function)),
  m_file(std::move(file)),
  m_line(line),
  m_debugLevel(debugLevel),
  m_logInfo(0)
{
}

LogMessage() [2/2]

LogMessage	(	LogConfig::ELogLevel	logLevel,
		LogVariableStream &&	messageStream,
		const char *	package,
		std::string	function,
		std::string	file,
		unsigned int	line,
		int	debugLevel = 0
	)

The LogMessage constructor taking a LogVariableStream which can contains name/value pairs.

Parameters

logLevel	The log level of the message (e.g. debug, info, warning, error, fatal).
messageStream	The LogVariableStream which should be send.
package	The package name where the message was sent from (can be NULL)
function	The function name where the message was sent from.
file	The file name where the message was sent from.
line	The line number in the source code where the message was sent from.

Definition at line 38 of file LogMessage.cc.

Member Function Documentation

getLogLevel()

LogConfig::ELogLevel getLogLevel ( ) const

inline

Returns the log level of the message.

Returns

Returns the log level of the message.

Definition at line 99 of file LogMessage.h.

getMessage()

const std::string getMessage ( ) const

inline

Returns the message text.

Returns

Returns the message text;

Definition at line 113 of file LogMessage.h.

getPackage()

const std::string& getPackage ( ) const

inline

Returns the package where the message was sent from.

Returns

Returns the package where the message was sent from.

Definition at line 106 of file LogMessage.h.

operator==()

bool operator==

(

const LogMessage &

message

)

const

Compares two messages.

Returns

true if the message contents (including module, .cc line etc.) are equal.

Definition at line 53 of file LogMessage.cc.

print()

std::ostream & print

(

std::ostream &

out

)

const

Generate output stream.

Parameters

out	The output stream.

Definition at line 108 of file LogMessage.cc.

toJSON()

std::string toJSON

(

bool

complete

)

const

Return a json string for the log message.

The returned string will be a json object containing the full log message on one line

Parameters

complete

if true include all fields independent of the logInfo settings

Definition at line 64 of file LogMessage.cc.

---

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

• framework/logging/include/LogMessage.h
• framework/logging/src/LogMessage.cc