Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::Logging Namespace Reference

debug output related helper classes and functions More...

Classes

class  ThresholdFailure
 Custom exception class so threshold failures can be caught. More...
 
class  OutputPrintPolicy
 abstract base class for printing debug output More...
 
class  OutputFilterPolicy
 abstract base class for filtering debug output More...
 
exception  DefaultFilterPolicy
 default filter policy for debug messages More...
 
class  OutputDecorator
 base class for decorating the debug output More...
 
exception  NamedOutputDecorator
 decorate debug message with a name More...
 
exception  TimedOutputDecorator
 decorate debug message with a time stamp More...
 
exception  ThreadOutputDecorator
 decorate debug message with a thread ID More...
 
exception  LevelOutputDecorator
 decorate debug message with its debug level More...
 
exception  DefaultPrintPolicy
 default print policy for debug messages More...
 

Enumerations

enum  Level {
  VERBOSE = 0, DEBUG, INFO, WARNING,
  ERROR, FATAL, MAX
}
 constants steering the debug output More...
 

Functions

std::string_view levelName (Level level)
 
constexpr Level getFailureThreshold ()
 
void setFailureThreshold (Level level)
 Set debug level above which an exception will be thrown after logging.
 

Detailed Description

debug output related helper classes and functions

Enumeration Type Documentation

constants steering the debug output

All messages with a debug level equal or higher than the currently set debug output level will be printed.

Enumerator:
VERBOSE 

VERBOSE level.

DEBUG 

DEBUG level.

INFO 

INFO level.

WARNING 

WARNING level.

ERROR 

ERROR level.

FATAL 

FATAL level.

MAX 

Must be kept above the maximum supported debug level.

Definition at line 155 of file Logger.hpp.

View newest version in sPHENIX GitHub at line 155 of file Logger.hpp

Function Documentation

constexpr Level Acts::Logging::getFailureThreshold ( )

Definition at line 209 of file Logger.hpp.

View newest version in sPHENIX GitHub at line 209 of file Logger.hpp

References MAX.

Referenced by Acts::Python::addLogging(), Acts::Test::debug_level_test(), Acts::Logging::DefaultFilterPolicy::DefaultFilterPolicy(), and Acts::Logging::DefaultPrintPolicy::flush().

+ Here is the caller graph for this function:

std::string_view Acts::Logging::levelName ( Level  level)
inline

Definition at line 165 of file Logger.hpp.

View newest version in sPHENIX GitHub at line 165 of file Logger.hpp

References DEBUG, ERROR, FATAL, INFO, MAX, VERBOSE, and WARNING.

Referenced by Acts::Logging::DefaultFilterPolicy::DefaultFilterPolicy(), and Acts::Logging::DefaultPrintPolicy::flush().

+ Here is the caller graph for this function:

void Acts::Logging::setFailureThreshold ( Level  level)

Set debug level above which an exception will be thrown after logging.

All messages with a debug level equal or higher than level will cause an exception to be thrown after log emission.

Warning
The runtime log failure threshold is global state, therefore this function is not threadsafe. The intention is that this level is set once, before multi-threaded execution begins, and then not modified before the end of the job.
Note
This function is only available if ACTS_LOG_FAILURE_THRESHOLD is unset, i.e. no compile-time threshold is used. Otherwise an exception is thrown.

Definition at line 64 of file Logger.cpp.

View newest version in sPHENIX GitHub at line 64 of file Logger.cpp

Referenced by Acts::Python::addLogging().

+ Here is the caller graph for this function: