log_entry.m

Go to the documentation of this file.

% =========================================================================== %
%> @brief log entry to a log file
%>
%> this function logs an entry to a log file.
%>
%> @param msg message to log
%> @param ptp_num participant number (default: 0)
%> @param level log level (default: 4)
%>
%> @retval none
%>
%> @note log levels:
%> - 1: FATAL
%> - 2: ERROR
%> - 3: WARNING
%> - 4: INFO
%> - 5: DEBUG
%>
%> @copyright see the file @ref LICENSE in the root directory of the repository
% =========================================================================== %
 
function log_entry(msg, ptp_num, level, trial)
 
arguments
    msg (1,:) char
    ptp_num (1,1) double = 0
    level (1,1) double = 4
    trial (1,1) string = ""
end
 
switch level
    case 1
        lvl_str = "FATAL  ";
    case 2
        lvl_str = "ERROR  ";
    case 3
        lvl_str = "WARNING";
    case 4
        lvl_str = "INFO   ";
    case 5
        lvl_str = "DEBUG  ";
    otherwise
        lvl_str = "UNKNOWN";
end
 
if strlength(trial)
    msg = msg + " (Trial: " + trial + ")";
end
 
diary on
fprintf("%s; %s; %2d; %s\n", datetime('now', 'Format', 'yyyy-MM-dd HH:mm:ss'), lvl_str, ptp_num, msg)
diary off
 
end