OpenMS
LogStream.h File Reference
#include <OpenMS/CONCEPT/Macros.h>
#include <OpenMS/DATASTRUCTURES/String.h>
#include <sstream>
#include <iostream>
#include <list>
#include <vector>
#include <ctime>
#include <map>
Include dependency graph for LogStream.h:

Go to the source code of this file.

Classes

class  LogStreamBuf
 Stream buffer used by LogStream. More...
 
struct  LogStreamBuf::StreamStruct
 Holds a stream that is connected to the LogStream. It also includes the minimum and maximum level at which the LogStream redirects messages to this stream. More...
 
struct  LogStreamBuf::LogCacheStruct
 Holds a counter of occurrences and an index for the occurrence sequence of the corresponding log message. More...
 
class  LogStreamNotifier
 
class  LogStream
 Log Stream Class. More...
 

Namespaces

 OpenMS
 Main OpenMS namespace.
 
 OpenMS::Logger
 Log streams.
 

Macros

#define OPENMS_LOG_FATAL_ERROR
 Macro to be used if fatal error are reported (processing stops) More...
 
#define OPENMS_LOG_ERROR
 Macro to be used if non-fatal error are reported (processing continues) More...
 
#define OPENMS_LOG_WARN
 Macro if a warning, a piece of information which should be read by the user, should be logged. More...
 
#define OPENMS_LOG_INFO
 Macro if a information, e.g. a status should be reported. More...
 
#define OPENMS_LOG_DEBUG
 Macro for general debugging information. More...
 
#define OPENMS_LOG_DEBUG_NOFILE
 Macro for general debugging information (without information on file) More...
 

Variables

Logger::LogStream OpenMS_Log_fatal
 Global static instance of a LogStream to capture messages classified as fatal errors. By default it is bound to cerr. More...
 
Logger::LogStream OpenMS_Log_error
 Global static instance of a LogStream to capture messages classified as errors. By default it is bound to cerr. More...
 
Logger::LogStream OpenMS_Log_warn
 Global static instance of a LogStream to capture messages classified as warnings. By default it is bound to cout. More...
 
Logger::LogStream OpenMS_Log_info
 Global static instance of a LogStream to capture messages classified as information. By default it is bound to cout. More...
 
Logger::LogStream OpenMS_Log_debug
 Global static instance of a LogStream to capture messages classified as debug output. By default it is not bound to any output stream. TOPP(AS)Base will connect cout, iff 0 < debug-level. More...
 

Class Documentation

◆ OpenMS::Logger::LogStreamBuf::LogCacheStruct

struct OpenMS::Logger::LogStreamBuf::LogCacheStruct

Holds a counter of occurrences and an index for the occurrence sequence of the corresponding log message.

Collaboration diagram for LogStreamBuf::LogCacheStruct:
[legend]
Class Members
int counter
Size timestamp

Macro Definition Documentation

◆ OPENMS_LOG_DEBUG

#define OPENMS_LOG_DEBUG
Value:
OpenMS_Log_debug << [](){ constexpr const char* x = (past_last_slash(__FILE__)); return x; }() << "(" << __LINE__ << "): "
#define OPENMS_THREAD_CRITICAL(name)
Definition: openms/include/OpenMS/CONCEPT/Macros.h:41

Macro for general debugging information.

◆ OPENMS_LOG_DEBUG_NOFILE

#define OPENMS_LOG_DEBUG_NOFILE
Value:
OpenMS_Log_debug

Macro for general debugging information (without information on file)

◆ OPENMS_LOG_ERROR

#define OPENMS_LOG_ERROR
Value:
OpenMS_Log_error

Macro to be used if non-fatal error are reported (processing continues)

◆ OPENMS_LOG_FATAL_ERROR

#define OPENMS_LOG_FATAL_ERROR
Value:
OpenMS_Log_fatal << __FILE__ << "(" << __LINE__ << "): "

Macro to be used if fatal error are reported (processing stops)

◆ OPENMS_LOG_INFO

#define OPENMS_LOG_INFO
Value:
OpenMS_Log_info

Macro if a information, e.g. a status should be reported.

◆ OPENMS_LOG_WARN

#define OPENMS_LOG_WARN
Value:
OpenMS_Log_warn

Macro if a warning, a piece of information which should be read by the user, should be logged.