| OpenMS 2.5.0

Classes | Namespaces | Macros | Variables
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>`

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...

## 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.

Class Members
int | counter |
Size | timestamp |

## Macro Definition Documentation

## ◆ OPENMS_LOG_DEBUG

#define OPENMS_LOG_DEBUG

Value:
OPENMS_THREAD_CRITICAL(LOGSTREAM) \
OpenMS_Log_debug << __FILE__ << "(" << __LINE__ << "): "
OPENMS_THREAD_CRITICAL
#define OPENMS_THREAD_CRITICAL(name)
Definition: openms/include/OpenMS/CONCEPT/Macros.h:67

Macro for general debugging information.

Referenced by MRMTransitionGroupPicker::computeQuality_(), FullSwathFileConsumer::consumeSpectrum(), MRMTransitionGroupPicker::createMRMFeature(), DecoyHelper::findDecoyString(), MetaProSIPInterpolation::getHighPoints(), TOPPOpenSwathBase::loadSwathFiles(), TOPPGNPSExport::main_(), NucleicAcidSearchEngine::main_(), NucleicAcidSearchEngine::parseAdduct_(), PeakPickerIterative::pick(), NucleicAcidSearchEngine::postProcessHits_(), NucleicAcidSearchEngine::preprocessSpectra_(), UTILProteomicsLFQ::quantifyFraction_(), MRMTransitionGroupPicker::recalculatePeakBorders_(), ConfidenceScoring::scoreMap(), and TOPPASBase::TOPPASreadyRead().

## ◆ OPENMS_LOG_ERROR

#define OPENMS_LOG_ERROR

Value:
OPENMS_THREAD_CRITICAL(LOGSTREAM) \
OpenMS_Log_error
OPENMS_THREAD_CRITICAL
#define OPENMS_THREAD_CRITICAL(name)
Definition: openms/include/OpenMS/CONCEPT/Macros.h:67

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

Referenced by TOPPASBase::addTOPPASFile(), RIntegration::checkRDependencies(), extractCachedMetaFilename(), GaussFilter::filter(), DecoyHelper::findDecoyString(), TOPPOpenSwathBase::loadSwathFiles(), TOPPOpenSwathBase::loadTransitionList(), main(), NucleicAcidSearchEngine::main_(), QApplicationTOPP::notify(), INIFileEditorWindow::openFile(), DigestionEnzymeDB< DigestionEnzymeRNA, RNaseDB >::parseEnzyme_(), NucleicAcidSearchEngine::preprocessSpectra_(), and PeptideIndexing::run().

## ◆ OPENMS_LOG_FATAL_ERROR

#define OPENMS_LOG_FATAL_ERROR

Value:
OPENMS_THREAD_CRITICAL(LOGSTREAM) \
OpenMS_Log_fatal << __FILE__ << "(" << __LINE__ << "): "
OPENMS_THREAD_CRITICAL
#define OPENMS_THREAD_CRITICAL(name)
Definition: openms/include/OpenMS/CONCEPT/Macros.h:67

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

Referenced by UTILProteomicsLFQ::main_(), and UTILProteomicsLFQ::quantifyFraction_().

## ◆ OPENMS_LOG_INFO

#define OPENMS_LOG_INFO

Value:
OPENMS_THREAD_CRITICAL(LOGSTREAM) \
OpenMS_Log_info
OPENMS_THREAD_CRITICAL
#define OPENMS_THREAD_CRITICAL(name)
Definition: openms/include/OpenMS/CONCEPT/Macros.h:67

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

Referenced by TOPPViewBase::addDataFile(), UTILProteomicsLFQ::align_(), NucleicAcidSearchEngine::calculateAndFilterFDR_(), UTILProteomicsLFQ::calculateSeeds_(), RIntegration::checkRDependencies(), MetaProSIPReporting::createPeptideCentricCSVReport(), MetaProSIPReporting::createQualityReport(), UTILProteomicsLFQ::estimateMedianChromatographicFWHM_(), TargetedSpectraExtractor::BinnedSpectrumComparator::init(), UTILProteomicsLFQ::link_(), main(), Epifany::main_(), NucleicAcidSearchEngine::main_(), UTILProteomicsLFQ::main_(), SpectraMerger::mergeSpectra_(), NucleicAcidSearchEngine::preprocessSpectra_(), AccurateMassSearchEngine::resolveAutoMode_(), PeptideIndexing::run(), and UTILProteomicsLFQ::transferIDsBetweenSameFraction_().

## ◆ OPENMS_LOG_WARN

#define OPENMS_LOG_WARN

Value:
OPENMS_THREAD_CRITICAL(LOGSTREAM) \
OpenMS_Log_warn
OPENMS_THREAD_CRITICAL
#define OPENMS_THREAD_CRITICAL(name)
Definition: openms/include/OpenMS/CONCEPT/Macros.h:67

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

Referenced by UTILProteomicsLFQ::centroidAndCorrectPrecursors_(), SignalToNoiseEstimatorMedian< ContainerT >::computeSTN_(), ChromatogramTools::convertSpectraToChromatograms(), MetaProSIPXICExtraction::extractXICs(), DecoyHelper::findDecoyString(), ConsensusMap::ColumnHeader::getLabelAsUInt(), PeakIntegrator::integratePeak_(), TOPPOpenSwathBase::loadSwathFiles(), NucleicAcidSearchEngine::main_(), UTILProteomicsLFQ::main_(), OpenMS::makePeakPositionUnique(), SpectraMerger::mergeSpectra_(), SpectraMerger::mergeSpectraPrecursors(), IDFilter::DigestionFilter::operator()(), IsInIsolationWindow< SpectrumType >::operator()(), NucleicAcidSearchEngine::preprocessSpectra_(), UTILProteomicsLFQ::quantifyFraction_(), SpectrumLookup::readSpectra(), UTILProteomicsLFQ::recalibrateMasses_(), PeptideIndexing::run(), ConfidenceScoring::scoreMap(), and UTILProteomicsLFQ::transform_().