Logging¶
#include "Spirit/Log.h"
Definition of log levels and senders¶
¶
typedef enum { Log_Level_All = 0, Log_Level_Severe = 1, Log_Level_Error = 2, Log_Level_Warning = 3, Log_Level_Parameter = 4, Log_Level_Info = 5, Log_Level_Debug = 6 } Spirit_Log_Level
Levels
¶
typedef enum { Log_Sender_All = 0, Log_Sender_IO = 1, Log_Sender_GNEB = 2, Log_Sender_LLG = 3, Log_Sender_MC = 4, Log_Sender_MMF = 5, Log_Sender_EMA = 6, Log_Sender_API = 7, Log_Sender_UI = 8, Log_Sender_HTST = 9 } Spirit_Log_Sender
Senders
Logging functions¶
Log_Send¶
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
Set Log parameters¶
Log_Set_Output_File_Tag¶
void Log_Set_Output_File_Tag(State *state, const char * tag)
The tag in front of the log file
Log_Set_Output_Folder¶
void Log_Set_Output_Folder(State *state, const char * folder)
The output folder for the log file
Log_Set_Output_To_Console¶
void Log_Set_Output_To_Console(State *state, bool output, int level)
Whether to write log messages to the console and corresponding level
Log_Set_Output_To_File¶
void Log_Set_Output_To_File(State *state, bool output, int level)
Whether to write log messages to the log file and corresponding level
Get Log parameters¶
Log_Get_Output_File_Tag¶
const char * Log_Get_Output_File_Tag(State *state)
Returns the tag in front of the log file
Log_Get_Output_Folder¶
const char * Log_Get_Output_Folder(State *state)
Returns the output folder for the log file
Log_Get_Output_To_Console¶
bool Log_Get_Output_To_Console(State *state)
Returns whether to write log messages to the console
Log_Get_Output_Console_Level¶
int Log_Get_Output_Console_Level(State *state)
Returns the console logging level
Log_Get_Output_To_File¶
bool Log_Get_Output_To_File(State *state)
Returns whether to write log messages to the log file
Log_Get_Output_File_Level¶
int Log_Get_Output_File_Level(State *state)
Returns the file logging level