Colobot
Public Member Functions | Static Public Member Functions | List of all members
CLogger Class Reference

Class for loggin information to file or console. More...

#include <logger.h>

Inheritance diagram for CLogger:
Inheritance graph
[legend]

Public Member Functions

void Message (const char *str,...)
 
void Trace (const char *str,...)
 
void Debug (const char *str,...)
 
void Info (const char *str,...)
 
void Warn (const char *str,...)
 
void Error (const char *str,...)
 
void Log (LogLevel logLevel, const char *str,...)
 
void AddOutput (FILE *file)
 
void SetLogLevel (LogLevel level)
 

Static Public Member Functions

static bool ParseLogLevel (const std::string &str, LogLevel &logLevel)
 
- Static Public Member Functions inherited from CSingleton< CLogger >
static CLoggerGetInstance ()
 
static CLoggerGetInstancePointer ()
 
static bool IsCreated ()
 

Additional Inherited Members

- Static Protected Attributes inherited from CSingleton< CLogger >
static CLoggerm_instance = nullptr
 

Detailed Description

Class for loggin information to file or console.

Member Function Documentation

void CLogger::Message ( const char *  str,
  ... 
)

Write message to console or file

Parameters
str- message to write
...- additional arguments
void CLogger::Trace ( const char *  str,
  ... 
)

Write message to console or file with LOG_TRACE level

Parameters
str- message to write
...- additional arguments
void CLogger::Debug ( const char *  str,
  ... 
)

Write message to console or file with LOG_DEBUG level

Parameters
str- message to write
...- additional arguments
void CLogger::Info ( const char *  str,
  ... 
)

Write message to console or file with LOG_INFO level

Parameters
str- message to write
...- additional arguments
void CLogger::Warn ( const char *  str,
  ... 
)

Write message to console or file with LOG_WARN level

Parameters
str- message to write
...- additional arguments
void CLogger::Error ( const char *  str,
  ... 
)

Write message to console or file with LOG_ERROR level

Parameters
str- message to write
...- additional arguments
void CLogger::Log ( LogLevel  logLevel,
const char *  str,
  ... 
)

Write message to console or file with given log level

Parameters
logLevel- log level
str- message to write
...- additional arguments
void CLogger::AddOutput ( FILE *  file)

Set output file to write logs to The given file will be automatically closed when the logger exits

Parameters
file- file pointer to write to
void CLogger::SetLogLevel ( LogLevel  level)

Set log level. Logs with level below will not be shown

Parameters
level- minimum log level to write
bool CLogger::ParseLogLevel ( const std::string &  str,
LogLevel logLevel 
)
static

Parses string as a log level

Parameters
strstring to parse
logLevelresult log level

Valid values are "trace", "debug", "info", "warn", "error" and "none". On invalid value, returns false.


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