Logging

#include "Spirit/Log.h"

Definition of log levels and senders

enum Spirit_Log_Level

Levels

Values:

enumerator Log_Level_All = 0

enumerator Log_Level_Severe = 1

enumerator Log_Level_Error = 2

enumerator Log_Level_Warning = 3

enumerator Log_Level_Parameter = 4

enumerator Log_Level_Info = 5

enumerator Log_Level_Debug = 6

enum Spirit_Log_Sender

Senders

Values:

enumerator Log_Sender_All = 0

enumerator Log_Sender_IO = 1

enumerator Log_Sender_GNEB = 2

enumerator Log_Sender_LLG = 3

enumerator Log_Sender_MC = 4

enumerator Log_Sender_MMF = 5

enumerator Log_Sender_EMA = 6

enumerator Log_Sender_API = 7

enumerator Log_Sender_UI = 8

enumerator Log_Sender_HTST = 9

Logging functions

void Log_Send(State *state, Spirit_Log_Level level, Spirit_Log_Sender sender, const char *message, int idx_image = -1, int idx_chain = -1)

Send a Log message

void Log_Append(State *state)

Append the Log to it’s file

int Log_Get_N_Entries(State *state)

Get the number of Log entries

int Log_Get_N_Errors(State *state)

Get the number of errors in the Log

int Log_Get_N_Warnings(State *state)

Get the number of warnings in the Log

Get Log parameters

const char *Log_Get_Output_File_Tag(State *state)

Returns the tag in front of the log file

const char *Log_Get_Output_Folder(State *state)

Returns the output folder for the log file

bool Log_Get_Output_To_Console(State *state)

Returns whether to write log messages to the console

bool Log_Get_Output_To_File(State *state)

Returns whether to write log messages to the log file

Set Log parameters

void Log_Set_Output_File_Tag(State *state, const char *tag)

The tag in front of the log file

void Log_Set_Output_Folder(State *state, const char *folder)

The output folder for the log file

void Log_Set_Output_To_Console(State *state, bool output, int level)

Whether to write log messages to the console and corresponding level

void Log_Set_Output_To_File(State *state, bool output, int level)

Whether to write log messages to the log file and corresponding level