Public Member Functions | Protected Member Functions | Private Attributes | List of all members
AdditionalLoggerBase Class Reference

#include <additionalloggerbase.h>

Inheritance diagram for AdditionalLoggerBase:
Inheritance graph
[legend]

Public Member Functions

 AdditionalLoggerBase (JournalLogLevel initialLogLevel=JLL_Alert)
 Constructs an AdditionalLoggerBase. More...
 
JournalLogLevel debugLevel () const override
 
JournalLogLevel logLevel () const override
 
bool logLevel (JournalLogLevel level) const override
 
void logNoDecoration (JournalLogLevel level, char const *file, int line, char const *function, std::string const &msg) override
 Write line to the log without decoration (timestamp, thread) More...
 
void setDebugLevel (JournalLogLevel level) override
 Set the current debug log level. More...
 
void setLogLevel (JournalLogLevel level) override
 Set the current log level. More...
 
- Public Member Functions inherited from AbstractAdditionalLogger
virtual void log (JournalLogLevel level, char const *file, int line, char const *function, std::string const &msg)=0
 Write line to the log. More...
 
virtual ~AbstractAdditionalLogger ()
 Destructor. More...
 

Protected Member Functions

virtual void onDebugLevelChanged (JournalLogLevel newLevel, JournalLogLevel oldLevel)
 Called when the debug log level changes This can be overridden in derived classes. More...
 
virtual void onLogLevelChanged (JournalLogLevel newLevel, JournalLogLevel oldLevel)
 Called when the log level changes This can be overridden in derived classes. More...
 

Private Attributes

JournalLogLevel m_debugLevel
 
JournalLogLevel m_level
 

Detailed Description

Convenient base class for custom additional loggers. Already implements functionality such as log level that should be common for all additional loggers Custom additional loggers can be derived from this

Definition at line 75 of file additionalloggerbase.h.

Constructor & Destructor Documentation

◆ AdditionalLoggerBase()

AdditionalLoggerBase::AdditionalLoggerBase ( JournalLogLevel  initialLogLevel = JLL_Alert)

Constructs an AdditionalLoggerBase.

Parameters
[in]initialLogLevelThe initial log level to use as log level and debug log level

Definition at line 70 of file additionalloggerbase.cpp.

Member Function Documentation

◆ debugLevel()

JournalLogLevel AdditionalLoggerBase::debugLevel ( ) const
overridevirtual

Returns
the current debug log level

Implements AbstractAdditionalLogger.

Definition at line 84 of file additionalloggerbase.cpp.

◆ logLevel() [1/2]

JournalLogLevel AdditionalLoggerBase::logLevel ( ) const
overridevirtual

Returns
the current log level

Implements AbstractAdditionalLogger.

Definition at line 77 of file additionalloggerbase.cpp.

◆ logLevel() [2/2]

bool AdditionalLoggerBase::logLevel ( JournalLogLevel  level) const
overridevirtual

Returns
true if loglevel level should be logged, false otherwise
Parameters
[in]levelThe log level to check

Implements AbstractAdditionalLogger.

Definition at line 133 of file additionalloggerbase.cpp.

◆ logNoDecoration()

void AdditionalLoggerBase::logNoDecoration ( JournalLogLevel  level,
char const *  file,
int  line,
char const *  function,
std::string const &  msg 
)
overridevirtual

Write line to the log without decoration (timestamp, thread)

Parameters
[in]levelThe log level
[in]fileThe name of the file from which the logging originates
[in]lineThe line number from which the logging originates
[in]functionThe name of the function from which the logging originates
[in]msgThe actual log message The AdditionalLoggerBase simply forwards this call to the normal log method but this method can be overridden in derived classes

Implements AbstractAdditionalLogger.

Definition at line 141 of file additionalloggerbase.cpp.

◆ onDebugLevelChanged()

void AdditionalLoggerBase::onDebugLevelChanged ( JournalLogLevel  newLevel,
JournalLogLevel  oldLevel 
)
protectedvirtual

Called when the debug log level changes This can be overridden in derived classes.

Definition at line 125 of file additionalloggerbase.cpp.

◆ onLogLevelChanged()

void AdditionalLoggerBase::onLogLevelChanged ( JournalLogLevel  newLevel,
JournalLogLevel  oldLevel 
)
protectedvirtual

Called when the log level changes This can be overridden in derived classes.

Definition at line 116 of file additionalloggerbase.cpp.

◆ setDebugLevel()

void AdditionalLoggerBase::setDebugLevel ( JournalLogLevel  level)
overridevirtual

Set the current debug log level.

Parameters
[in]levelThe new debug log level

Implements AbstractAdditionalLogger.

Definition at line 103 of file additionalloggerbase.cpp.

◆ setLogLevel()

void AdditionalLoggerBase::setLogLevel ( JournalLogLevel  level)
overridevirtual

Set the current log level.

Parameters
[in]levelThe new log level

Implements AbstractAdditionalLogger.

Definition at line 91 of file additionalloggerbase.cpp.

Member Data Documentation

◆ m_debugLevel

JournalLogLevel AdditionalLoggerBase::m_debugLevel
private

Definition at line 95 of file additionalloggerbase.h.

◆ m_level

JournalLogLevel AdditionalLoggerBase::m_level
private

Definition at line 94 of file additionalloggerbase.h.


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


xsens_mti_driver
Author(s):
autogenerated on Sun Sep 3 2023 02:43:21