LogMethod Class Reference

The LogMethod class. More...

#include <LogMethod.h>

Collaboration diagram for LogMethod:

Public Member Functions
	LogMethod (const char *package, std::string function, std::string file, unsigned int line)
	The LogMethod constructor.
	~LogMethod ()
	The LogMethod destructor.

Private Attributes
const char *	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.

Detailed Description

The LogMethod class.

This class allows the logging of the entering and leaving point of a method. Therefore an object of this class is created on the stack, which logs a message at the moment it is created and destroyed. In addition, it logs a message if there are any uncaught exceptions pending at the time the object is destroyed on the stack. This allows to identify methods which were terminated due to a thrown exception.

Definition at line 31 of file LogMethod.h.

Constructor & Destructor Documentation

LogMethod()

LogMethod	(	const char *	package,
		std::string	function,
		std::string	file,
		unsigned int	line
	)

The LogMethod constructor.

Parameters

package	The package name where the message was sent from.
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 19 of file LogMethod.cc.

                                                                                          : m_package(package),
  m_function(std::move(function)), m_file(std::move(file)), m_line(line)
{
  //Send message for entering the method
  if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Info)) {
    string messageText = "--> Entering method '" + m_function + "'";
    LogSystem::Instance().sendMessage(LogMessage(LogConfig::c_Info, messageText, m_package, m_function, m_file, m_line));
  }
}

~LogMethod()

~LogMethod

(

)

The LogMethod destructor.

Definition at line 29 of file LogMethod.cc.

{
  //Check for uncaught exceptions
  string uncaughtExc;
  if (std::uncaught_exceptions() > 0) uncaughtExc = "(" + std::to_string(std::uncaught_exceptions()) +
                                                      " uncaught exceptions pending)";
 
  //Send message for leaving the method
  if (LogSystem::Instance().isLevelEnabled(LogConfig::c_Info)) {
    string messageText = "<-- Leaving method '" + m_function + "' " + uncaughtExc;
    LogSystem::Instance().sendMessage(LogMessage(LogConfig::c_Info, messageText, m_package, m_function, m_file, m_line));
  }
}

Member Data Documentation

m_file

std::string m_file

private

The file name where the message was sent from.

Definition at line 55 of file LogMethod.h.

m_function

std::string m_function

private

The function name where the message was sent from.

Definition at line 54 of file LogMethod.h.

m_line

unsigned int m_line

private

The line number in the source code where the message was sent from.

Definition at line 56 of file LogMethod.h.

m_package

const char* m_package

private

The package name where the message was sent from.

Definition at line 53 of file LogMethod.h.

---

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

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