Table of Contents
Status Window and Status Messages
A builtin feature to the toolbox and particularly the GUI, the status messages give a full overview of what has been done.
No, we're not in Orwell's 1984 or another dystopic and claustrophobic surveillance society. But it proved to be very useful to have a general overview of what has been done within a session of the main GUI of the toolbox.
For that purpose, the GUI (and ideally every subwindow) add lines to the status, telling the user in a concise way what's going on.
Please note: The status reports are not saved in any way nor transferred to any other place from the user's computer. Therefore, your privacy gets fully respected.1)
Implementation Details
The status is a cell array in the guidata that contains all status messages since the start of the current main GUI instance.
To add a status line, use the function trEPRmsg() with a status message as argument. This will add a new status message, together with a timestamp (with second accuracy). You may add as a second, optional, parameter the log level. For details, see below.
The status window can be opened from within the main GUI, either by pressing the <key>Status</key> button on the bottom right below the main axis or by hitting the <key>F10</key> key.
Please note: If there is no GUI currently open, the status messages will be displayed in the Matlab™ command window. This allows to use the trEPRmsg routine in all functions of the toolbox, irrespective of the GUI.
Log levels
A new feature (as of end of June 2012) is the implementation of “log levels”. This has two advantages:
- It allows to easily recognise whether a particular message is important.
- It allows for showing only specific types of messages.
If provided with a log level, a status message get's displayed with a message type identifier prefix in the GUI status.
Identifiers for log levels
Currently, there are four log levels, whose identifiers are:
- error
- warning
- info
- debug
Message type identifiers
The message type identifiers that prefix the messages in the status window of the main GUI are the following, each corresponding to the respective log level:
- (EE)
- (WW)
- (II)
- (DD)