EDepSim::LogManager Class Reference

#include <EDepSimLog.hh>

Public Types
enum	ErrorPriority {   SilentLevel, ErrorLevel, SevereLevel, WarnLevel,   DebugLevel, TraceLevel }
enum	LogPriority { QuietLevel, LogLevel, InfoLevel, VerboseLevel }

Public Member Functions
	~LogManager ()

Static Public Member Functions
static void	Configure (const char *conf=NULL)
static void	SetDebugStream (std::ostream *err)
	Set the output stream to be used for error messages. More...
static void	SetDebugLevel (ErrorPriority level)
static void	SetDebugLevel (const char *trace, ErrorPriority level)
	Set the debugging level for a particular trace. More...
static ErrorPriority	GetDebugLevel ()
	Get the current debugging level;. More...
static ErrorPriority	GetDebugLevel (const char *trace)
	Get the current debugging level for a named trace. More...
static void	SetLogStream (std::ostream *log)
	Set the output stream to be used for log messages. More...
static void	SetLogLevel (LogPriority level)
	Set the default logging level. More...
static void	SetLogLevel (const char *trace, LogPriority level)
	Set the logging level for a named trace. More...
static LogPriority	GetLogLevel ()
	Get the current logging level;. More...
static LogPriority	GetLogLevel (const char *trace)
	Get the current logging level;. More...
static std::ostream &	GetDebugStream ()
	Return the stream associated with the error file. More...
static std::ostream &	GetLogStream ()
	Return the stream associated with the log file. More...
static void	SetIndentation (int i)
	Set the indentation level for a log message. More...
static void	IncreaseIndentation ()
	Increase the indentation level. More...
static void	DecreaseIndentation ()
	Decrease the indentation level. More...
static void	ResetIndentation ()
	Reset the indentation to zero. More...
static std::string	MakeIndent ()
	[Internal method] Make an indentation for a log message. More...

Private Member Functions
	LogManager ()

Static Private Attributes
static ErrorPriority	fErrorPriority = EDepSim::LogManager::ErrorLevel
static LogPriority	fLogPriority = EDepSim::LogManager::LogLevel
static std::ostream *	fDebugStream = NULL
static std::ostream *	fLogStream = NULL
static std::map< std::string, ErrorPriority >	fErrorTraces
static std::map< std::string, LogPriority >	fLogTraces
static int	fIndentation = 0

Detailed Description

Definition at line 380 of file EDepSimLog.hh.

Member Enumeration Documentation

enum EDepSim::LogManager::ErrorPriority

Enumerator
SilentLevel
ErrorLevel
SevereLevel
WarnLevel
DebugLevel
TraceLevel

Definition at line 384 of file EDepSimLog.hh.

                 {SilentLevel,
                  ErrorLevel,
                  SevereLevel,
                  WarnLevel,
                  DebugLevel,
                  TraceLevel} ErrorPriority;

enum EDepSim::LogManager::LogPriority

Enumerator
QuietLevel
LogLevel
InfoLevel
VerboseLevel

Definition at line 391 of file EDepSimLog.hh.

                 {QuietLevel,
                  LogLevel,
                  InfoLevel,
                  VerboseLevel} LogPriority;

Constructor & Destructor Documentation

EDepSim::LogManager::~LogManager

(

)

Definition at line 16 of file EDepSimLogManager.cc.

{ }

EDepSim::LogManager::LogManager ( )

inlineprivate

Definition at line 467 of file EDepSimLog.hh.

{ }

Member Function Documentation

void EDepSim::LogManager::Configure ( const char *  conf = NULL )

static

Cause the logging and error output streams to be initialized. Basic configuration for logging occurs automatically, so this need not be called. If this is called, then it first trys to read the edeplog.config file in the current directory. If Configure is called with an argument, then the named file will be read after reading the local configuration file. If Configure is called with a named file then that file must exist. The The EDepSim::LogManager Configuration File syntax is described elsewhere.

Definition at line 387 of file EDepSimLogManager.cc.

                                                  {
    // Try to read a local configuration file.  
    ReadConfigurationFile("./edeplog.config");
    if (conf) {
        bool success = ReadConfigurationFile(conf);
        if (!success) EDepSimLog("EDepSim::Log configuration file was not read.");
    }
}

void EDepSim::LogManager::DecreaseIndentation ( )

static

Decrease the indentation level.

Definition at line 115 of file EDepSimLogManager.cc.

                                            {
    if (EDepSim::LogManager::fIndentation>0) --EDepSim::LogManager::fIndentation;
}

static ErrorPriority EDepSim::LogManager::GetDebugLevel ( )

inlinestatic

Get the current debugging level;.

Definition at line 417 of file EDepSimLog.hh.

{return fErrorPriority;}

EDepSim::LogManager::ErrorPriority EDepSim::LogManager::GetDebugLevel ( const char *  trace )

static

Get the current debugging level for a named trace.

Definition at line 23 of file EDepSimLogManager.cc.

                                                                                 {
    std::map<std::string,ErrorPriority>::iterator elem = fErrorTraces.find(trace);
    if (elem == fErrorTraces.end()) return fErrorPriority;
    return elem->second;
}

std::ostream & EDepSim::LogManager::GetDebugStream ( )

static

Return the stream associated with the error file.

Definition at line 68 of file EDepSimLogManager.cc.

                                              {
    if (!EDepSim::LogManager::fDebugStream ) return GetLogStream();
    return *EDepSim::LogManager::fDebugStream;
}

static LogPriority EDepSim::LogManager::GetLogLevel ( )

inlinestatic

Get the current logging level;.

Definition at line 432 of file EDepSimLog.hh.

{return fLogPriority;}

EDepSim::LogManager::LogPriority EDepSim::LogManager::GetLogLevel ( const char *  trace )

static

Get the current logging level;.

Definition at line 78 of file EDepSimLogManager.cc.

                                                                             {
    std::map<std::string,LogPriority>::iterator elem = fLogTraces.find(trace);
    if (elem == fLogTraces.end()) return fLogPriority;
    return elem->second;
}

std::ostream & EDepSim::LogManager::GetLogStream ( )

static

Return the stream associated with the log file.

Definition at line 102 of file EDepSimLogManager.cc.

                                            {
    if (!EDepSim::LogManager::fLogStream) return std::cout;
    return *EDepSim::LogManager::fLogStream;
}

void EDepSim::LogManager::IncreaseIndentation ( )

static

Increase the indentation level.

Definition at line 111 of file EDepSimLogManager.cc.

                                            {
    ++EDepSim::LogManager::fIndentation;
}

std::string EDepSim::LogManager::MakeIndent ( )

static

[Internal method] Make an indentation for a log message.

Definition at line 124 of file EDepSimLogManager.cc.

                                        {
    if (fIndentation<1) return "";
    std::string indent = "";
    for (int i=0; i<fIndentation; ++i) {
        indent += "..";
    }
    indent += " ";
    return indent;
}

void EDepSim::LogManager::ResetIndentation ( )

static

Reset the indentation to zero.

Definition at line 119 of file EDepSimLogManager.cc.

                                         {
    EDepSim::LogManager::fIndentation = 0;
}

static void EDepSim::LogManager::SetDebugLevel ( ErrorPriority  level )

inlinestatic

Set the default debugging level. The level parameter takes a value with type EDepSim::LogManager::ErrorPriority.

Definition at line 411 of file EDepSimLog.hh.

{fErrorPriority = level;}

void EDepSim::LogManager::SetDebugLevel ( const char *  trace, ErrorPriority  level  )

static

Set the debugging level for a particular trace.

Definition at line 18 of file EDepSimLogManager.cc.

                                                                    {
    fErrorTraces[trace] = level;
}

void EDepSim::LogManager::SetDebugStream ( std::ostream *  err )

static

Set the output stream to be used for error messages.

Definition at line 50 of file EDepSimLogManager.cc.

                                                      {
    EDepSim::LogManager::fDebugStream = err;
    if (!fDebugStream) return;
    std::ofstream* ofile = dynamic_cast<std::ofstream*>(err);
    if (ofile && !(ofile->is_open())) {
        fDebugStream = NULL;
        EDepSimSevere("Debug stream is not open.");
    }
    *fDebugStream << std::endl
                  << "##################################################" 
                  << std::endl
                  << "# ERROR LOG STARTS AT: " << MakeTimeStamp()
                  << std::endl
                  << "##################################################" 
                  << std::endl
                  << std::endl;
}

void EDepSim::LogManager::SetIndentation ( int  i )

static

Set the indentation level for a log message.

Definition at line 107 of file EDepSimLogManager.cc.

                                            {
    EDepSim::LogManager::fIndentation = std::max(i,0);
}

static void EDepSim::LogManager::SetLogLevel ( LogPriority  level )

inlinestatic

Set the default logging level.

Definition at line 426 of file EDepSimLog.hh.

{fLogPriority = level;}

void EDepSim::LogManager::SetLogLevel ( const char *  trace, LogPriority  level  )

static

Set the logging level for a named trace.

Definition at line 73 of file EDepSimLogManager.cc.

                                                                {
    fLogTraces[trace] = level;
}

void EDepSim::LogManager::SetLogStream ( std::ostream *  log )

static

Set the output stream to be used for log messages.

Definition at line 84 of file EDepSimLogManager.cc.

                                                    {
    EDepSim::LogManager::fLogStream = log;
    if (!fLogStream) return;
    std::ofstream* ofile = dynamic_cast<std::ofstream*>(log);
    if (ofile && !(ofile->is_open())) {
        fLogStream = NULL;
        EDepSimSevere("Log stream is not open.");
    }
    *fLogStream << std::endl
                << "##################################################" 
                << std::endl
                << "# LOG STARTS AT: " << MakeTimeStamp()
                << std::endl
                << "##################################################" 
                << std::endl
                << std::endl;
}

Member Data Documentation

std::ostream * EDepSim::LogManager::fDebugStream = NULL

staticprivate

Definition at line 461 of file EDepSimLog.hh.

EDepSim::LogManager::ErrorPriority EDepSim::LogManager::fErrorPriority = EDepSim::LogManager::ErrorLevel

staticprivate

Definition at line 459 of file EDepSimLog.hh.

std::map< std::string, EDepSim::LogManager::ErrorPriority > EDepSim::LogManager::fErrorTraces

staticprivate

Definition at line 463 of file EDepSimLog.hh.

int EDepSim::LogManager::fIndentation = 0

staticprivate

Definition at line 465 of file EDepSimLog.hh.

EDepSim::LogManager::LogPriority EDepSim::LogManager::fLogPriority = EDepSim::LogManager::LogLevel

staticprivate

Definition at line 460 of file EDepSimLog.hh.

std::ostream * EDepSim::LogManager::fLogStream = NULL

staticprivate

Definition at line 462 of file EDepSimLog.hh.

std::map< std::string, EDepSim::LogManager::LogPriority > EDepSim::LogManager::fLogTraces

staticprivate

Definition at line 464 of file EDepSimLog.hh.

---

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

• edep-sim/src/EDepSimLog.hh
• edep-sim/src/EDepSimLogManager.cc