peary::log

Classes

Name
class peary::log::Log Log of the framework to inform the user of process.

Types

Name
enum class LogLevel { FATAL = 0, STATUS, ERROR, WARNING, INFO, DEBUG, NONE, TRACE}Logging detail level.
enum class LogFormat { SHORT = 0, DEFAULT, LONG}Format of the Log.

Functions

Name
void SUPPRESS_STREAM(std::ostream & stream)Suppress an stream from writing any output.
void RELEASE_STREAM(std::ostream & stream)Release an suppressed stream so it can write again.

Types Documentation

enum LogLevel

Enumerator Value Description
FATAL 0 Fatal problems that terminate the framework (typically exceptions)
STATUS Only critical progress information.
ERROR Critical problems that usually lead to fatal errors.
WARNING Possible issue that could lead to unexpected results.
INFO General information about processes (should not be called in run function)
DEBUG Detailed information about physics process.
NONE Indicates the log level has not been set (cannot be selected by the user)
TRACE Software debugging information about what part is currently running.

Logging detail level.

enum LogFormat

Enumerator Value Description
SHORT 0 Only include a single character for the log level, the section header and the message.
DEFAULT Also include the time and a full logging level description.
LONG All of the above and also information about the file and line where the message was defined.

Format of the Log.

Functions Documentation

function SUPPRESS_STREAM 

  inline void SUPPRESS_STREAM(
    std::ostream & stream
)

Suppress an stream from writing any output.

Parameters:

  • stream The stream to suppress

function RELEASE_STREAM 

  inline void RELEASE_STREAM(
    std::ostream & stream
)

Release an suppressed stream so it can write again.

Parameters:

  • stream The stream to release

Updated on 2025-11-14 at 11:31:23 +0100