A class for managing log messages. More...

#include <BCLog.h>

Public Types
enum	LogLevel { debug, detail, summary, warning, error, nothing }

Public Member Functions
Constructors and destructors
	BCLog ()

	~BCLog ()

Static Public Member Functions
Getters
static BCLog::LogLevel	GetLogLevelFile ()

static BCLog::LogLevel	GetLogLevelScreen ()

Setters
static void	SetLogLevelFile (BCLog::LogLevel loglevel)

static void	SetLogLevelScreen (BCLog::LogLevel loglevel)

static void	SetLogLevel (BCLog::LogLevel loglevelscreen, BCLog::LogLevel loglevelfile)

static void	SetLogLevel (BCLog::LogLevel loglevel)

Miscellaneous
static void	OpenLog (const char *filename, BCLog::LogLevel loglevelfile, BCLog::LogLevel loglevelscreen)

static void	OpenLog (const char *filename)

static void	OpenLog ()

static bool	IsOpen ()

static void	CloseLog ()

static void	Out (BCLog::LogLevel loglevelfile, BCLog::LogLevel loglevelscreen, const char *message)

static void	Out (const char *message)

static void	Out (BCLog::LogLevel loglevel, const char *message)

static void	OutError (const char *message)

static void	OutWarning (const char *message)

static void	OutSummary (const char *message)

static void	OutDetail (const char *message)

static void	OutDebug (const char *message)

static void	StartupInfo ()

static const char *	GetVersion ()

static int	GetHIndex ()

static const char *	ToString (BCLog::LogLevel)

Static Private Attributes
static const char *	fVersion = VERSION

static BCLog::LogLevel	fMinimumLogLevelFile = BCLog::debug

static BCLog::LogLevel	fMinimumLogLevelScreen = BCLog::summary

static std::ofstream	fOutputStream

static bool	fFirstOutputDone = false

static int	fHindex = 0

Detailed Description

A class for managing log messages.

Author: Daniel Kollar; Kevin Kröninger

Version: 1.0

Date: 08.2008 This class manages log messages for printing on the screen and into a log file

Definition at line 29 of file BCLog.h.

Member Enumeration Documentation

enum BCLog::LogLevel

Enumerator for the amount of details to put into the log file Log levels: debug : Lowest level of information detail : Details of functions, etc. summary : Results warning : Warning messages error : Error message nothing : No output

Enumerator
debug
detail
summary
warning
error
nothing

Definition at line 45 of file BCLog.h.

45 {debug, detail, summary, warning, error, nothing};

Constructor & Destructor Documentation

BCLog::BCLog ( )

Constructor.

Definition at line 36 of file BCLog.cxx.

 {
    // suppress the ROOT Info printouts
    gErrorIgnoreLevel=2000;
 }

BCLog::~BCLog ( )

Destructor.

Definition at line 44 of file BCLog.cxx.

45 {}

Member Function Documentation

void BCLog::CloseLog ( )

static

Closes the log file

Definition at line 93 of file BCLog.cxx.

 {
    BCLog::fOutputStream.close();
 }

static int BCLog::GetHIndex ( )

inlinestatic

Returns: unique number for use in histogram name string

Definition at line 164 of file BCLog.h.

165 { return BCLog::fHindex++; };

static BCLog::LogLevel BCLog::GetLogLevelFile ( )

inlinestatic

Returns the minimum log level for file output.

Returns: log level

Definition at line 65 of file BCLog.h.

66 { return fMinimumLogLevelFile; };

static BCLog::LogLevel BCLog::GetLogLevelScreen ( )

inlinestatic

Returns the minimum log level for screen output.

Returns: log level

Definition at line 71 of file BCLog.h.

72 { return fMinimumLogLevelScreen; };

static const char* BCLog::GetVersion ( )

inlinestatic

Returns: string containing the version number

Definition at line 159 of file BCLog.h.

160 { return fVersion; };

bool BCLog::IsOpen ( )

static

Returns: true if log file is open or false if not.

Definition at line 86 of file BCLog.cxx.

 {
    return BCLog::fOutputStream.is_open();
 }

void BCLog::OpenLog	(	const char *	filename,
		BCLog::LogLevel	loglevelfile,
		BCLog::LogLevel	loglevelscreen
	)

static

Opens log file and sets minimum log levels for file and screen output.

Parameters

filename	log filename
loglevelfile	minimum log level for file output
loglevelscreen	minimum log level for screen output

Definition at line 49 of file BCLog.cxx.

 {
    // suppress the ROOT Info printouts
    gErrorIgnoreLevel=2000;
 
    // open log file
    BCLog::fOutputStream.open(filename);
 
    if (!BCLog::fOutputStream.is_open())
    {
       std::cerr << " Could not open log file " << filename << ". " << std::endl;
       return;
    }
 
    // set log level
    BCLog::SetLogLevelFile(loglevelfile);
    BCLog::SetLogLevelScreen(loglevelscreen);
 
    BCLog::Out(BCLog::summary,BCLog::summary,Form("Opening logfile %s",filename));
 }

void BCLog::OpenLog ( const char * filename)

static

Definition at line 72 of file BCLog.cxx.

 {
    BCLog::OpenLog(filename, BCLog::debug, BCLog::summary);
 }

void BCLog::OpenLog ( )

static

Definition at line 79 of file BCLog.cxx.

 {
    BCLog::OpenLog("log.txt", BCLog::debug, BCLog::summary);
 }

void BCLog::Out	(	BCLog::LogLevel	loglevelfile,
		BCLog::LogLevel	loglevelscreen,
		const char *	message
	)

static

Writes string to the file and screen log if the log level is equal or greater than the minimum

Parameters

loglevelfile	loglevel for the current message
loglevelscreen	loglevel for the current message
message	string to write to the file and screen log

Definition at line 100 of file BCLog.cxx.

 {
    // if this is the first call to Out(), call StartupInfo() first
    if(!fFirstOutputDone)
       BCLog::StartupInfo();
 
    // open log file if not opened
    if (BCLog::IsOpen())
    {
       // write message in to log file
       if (loglevelfile >= BCLog::fMinimumLogLevelFile)
          BCLog::fOutputStream << BCLog::ToString(loglevelfile) << " : " << message << std::endl;
    }
 
    // write message to screen
    if (loglevelscreen >= BCLog::fMinimumLogLevelScreen)
       std::cout << BCLog::ToString(loglevelscreen) << " : " << message << std::endl;
 }

void BCLog::Out ( const char * message)

static

Definition at line 121 of file BCLog.cxx.

 {
    BCLog::Out(BCLog::fMinimumLogLevelFile, BCLog::fMinimumLogLevelScreen, message);
 }

static void BCLog::Out	(	BCLog::LogLevel	loglevel,
		const char *	message
	)

inlinestatic

Definition at line 135 of file BCLog.h.

136 { Out(loglevel,loglevel,message); };

static void BCLog::OutDebug ( const char * message)

inlinestatic

Definition at line 150 of file BCLog.h.

151 { Out(debug,message); };

static void BCLog::OutDetail ( const char * message)

inlinestatic

Definition at line 147 of file BCLog.h.

148 { Out(detail,message); };

static void BCLog::OutError ( const char * message)

inlinestatic

Definition at line 138 of file BCLog.h.

139 { Out(error,message); };

static void BCLog::OutSummary ( const char * message)

inlinestatic

Definition at line 144 of file BCLog.h.

145 { Out(summary,message); };

static void BCLog::OutWarning ( const char * message)

inlinestatic

Definition at line 141 of file BCLog.h.

142 { Out(warning,message); };

static void BCLog::SetLogLevel	(	BCLog::LogLevel	loglevelscreen,
		BCLog::LogLevel	loglevelfile
	)

inlinestatic

Sets the minimum log level for file and screen output.

Parameters

loglevelscreen	log level for screen
loglevelfile	log level for file

Definition at line 94 of file BCLog.h.

95 { BCLog::fMinimumLogLevelFile = loglevelfile; BCLog::fMinimumLogLevelScreen = loglevelscreen; };

static void BCLog::SetLogLevel ( BCLog::LogLevel loglevel)

inlinestatic

Sets the minimum log level for file and screen output.

Parameters

loglevel log level

Definition at line 100 of file BCLog.h.

101 { SetLogLevel(loglevel, loglevel); };

static void BCLog::SetLogLevelFile ( BCLog::LogLevel loglevel)

inlinestatic

Sets the minimum log level for file output.

Parameters

loglevel log level

Definition at line 81 of file BCLog.h.

82 { BCLog::fMinimumLogLevelFile = loglevel; };

static void BCLog::SetLogLevelScreen ( BCLog::LogLevel loglevel)

inlinestatic

Sets the minimum log level for screen output.

Parameters

loglevel log level

Definition at line 87 of file BCLog.h.

88 { BCLog::fMinimumLogLevelScreen = loglevel; };

void BCLog::StartupInfo ( )

static

Writes startup information onto screen and into a logfile

Definition at line 128 of file BCLog.cxx.

 {
    char * message = Form(
                          " +------------------------------------------------------+\n"
                          " |                                                      |\n"
                          " | BAT version %7s                                  |\n"
                          " | Copyright (C) 2007-2013, the BAT core developer team |\n"
                          " | All rights reserved.                                 |\n"
                          " |                                                      |\n"
                          " | For the licensing terms see doc/COPYING              |\n"
                          " | For documentation see http://mpp.mpg.de/bat          |\n"
                          " |                                                      |\n"
                          " +------------------------------------------------------+\n",
                          BCLog::fVersion);
    
    // write message to screen
    if (BCLog::fMinimumLogLevelScreen < BCLog::nothing)
       std::cout << message << std::endl;
 
    if (BCLog::IsOpen() && BCLog::fMinimumLogLevelFile<BCLog::nothing)
       BCLog::fOutputStream << message;
 
    fFirstOutputDone = true;
 }

const char * BCLog::ToString ( BCLog::LogLevel loglevel)

static

Converts a log level to a string

Definition at line 155 of file BCLog.cxx.

 {
    switch (loglevel)
    {
       case debug:
          return "Debug  ";
       case detail:
          return "Detail ";
       case summary:
          return "Summary";
       case warning:
          return "Warning";
       case error:
          return "Error  ";
       default:
          return "";
    }
 }

Member Data Documentation

bool BCLog::fFirstOutputDone = false

staticprivate

Specifies wheather there were output printouts already

Definition at line 192 of file BCLog.h.

int BCLog::fHindex = 0

staticprivate

Global histogram counter

Definition at line 196 of file BCLog.h.

BCLog::LogLevel BCLog::fMinimumLogLevelFile = BCLog::debug

staticprivate

The minimum file log level

Definition at line 180 of file BCLog.h.

BCLog::LogLevel BCLog::fMinimumLogLevelScreen = BCLog::summary

staticprivate

The minimum screen log level

Definition at line 184 of file BCLog.h.

std::ofstream BCLog::fOutputStream

staticprivate

The output stream for the file log

Definition at line 188 of file BCLog.h.

const char * BCLog::fVersion = VERSION

staticprivate

BAT version number

Definition at line 176 of file BCLog.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation