The logging API used by OpenSurgSim code.
More...
|
#define | SURGSIM_LOG(logger, level) |
| Logs a message to the specified logger with the short level name. More...
|
|
#define | SURGSIM_LOG_DEBUG(logger) SURGSIM_LOG(logger, DEBUG) |
| Logs a message to the specified logger at the DEBUG level. More...
|
|
#define | SURGSIM_LOG_INFO(logger) SURGSIM_LOG(logger, INFO) |
| Logs a message to the specified logger at the INFO level. More...
|
|
#define | SURGSIM_LOG_WARNING(logger) SURGSIM_LOG(logger, WARNING) |
| Logs a message to the specified logger at the WARNING level. More...
|
|
#define | SURGSIM_LOG_SEVERE(logger) SURGSIM_LOG(logger, SEVERE) |
| Logs a message to the specified logger at the SEVERE level. More...
|
|
#define | SURGSIM_LOG_CRITICAL(logger) SURGSIM_LOG(logger, CRITICAL) |
| Logs a message to the specified logger at the CRITICAL level. More...
|
|
#define | SURGSIM_LOG_IF(condition, logger, level) |
| Logs a message to the specified logger with the short level name if condition is true. More...
|
|
#define | SURGSIM_LOG_ONCE(logger, level) |
| Logs a message to the specified logger with the short level name, but only the first time this statement is reached. More...
|
|
#define | SURGSIM_LOG_ONCE_IF(condition, logger, level) |
| Logs a message to the specified logger with the short level name if condition is true, but only the first time this particular condition is true. More...
|
|
The logging API used by OpenSurgSim code.
- See also
- Assertions
◆ SURGSIM_LOG
#define SURGSIM_LOG |
( |
|
logger, |
|
|
|
level |
|
) |
| |
Logs a message to the specified logger
with the short level
name.
- Parameters
-
- Returns
- Stream to output the log message
Example
◆ SURGSIM_LOG_CRITICAL
#define SURGSIM_LOG_CRITICAL |
( |
|
logger | ) |
SURGSIM_LOG(logger, CRITICAL) |
Logs a message to the specified logger
at the CRITICAL level.
- Parameters
-
logger | Logger used to log the message |
- Returns
- Stream to output the log message
Example
◆ SURGSIM_LOG_DEBUG
#define SURGSIM_LOG_DEBUG |
( |
|
logger | ) |
SURGSIM_LOG(logger, DEBUG) |
Logs a message to the specified logger
at the DEBUG level.
- Parameters
-
logger | Logger used to log the message |
- Returns
- Stream to output the log message
Example
◆ SURGSIM_LOG_IF
#define SURGSIM_LOG_IF |
( |
|
condition, |
|
|
|
logger, |
|
|
|
level |
|
) |
| |
Logs a message to the specified logger
with the short level
name if condition
is true.
- Parameters
-
- Returns
- Stream to output the log message.
Example
◆ SURGSIM_LOG_INFO
#define SURGSIM_LOG_INFO |
( |
|
logger | ) |
SURGSIM_LOG(logger, INFO) |
Logs a message to the specified logger
at the INFO level.
- Parameters
-
logger | Logger used to log the message |
- Returns
- Stream to output the log message
Example
◆ SURGSIM_LOG_ONCE
#define SURGSIM_LOG_ONCE |
( |
|
logger, |
|
|
|
level |
|
) |
| |
Logs a message to the specified logger
with the short level
name, but only the first time this statement is reached.
- Parameters
-
- Returns
- Stream to output the log message.
Example
◆ SURGSIM_LOG_ONCE_IF
#define SURGSIM_LOG_ONCE_IF |
( |
|
condition, |
|
|
|
logger, |
|
|
|
level |
|
) |
| |
Logs a message to the specified logger
with the short level
name if condition
is true, but only the first time this particular condition is true.
- Parameters
-
- Returns
- Stream to output the log message
Example
◆ SURGSIM_LOG_SEVERE
#define SURGSIM_LOG_SEVERE |
( |
|
logger | ) |
SURGSIM_LOG(logger, SEVERE) |
Logs a message to the specified logger
at the SEVERE level.
- Parameters
-
logger | Logger used to log the message |
- Returns
- Stream to output the log message
Example
◆ SURGSIM_LOG_WARNING
#define SURGSIM_LOG_WARNING |
( |
|
logger | ) |
SURGSIM_LOG(logger, WARNING) |
Logs a message to the specified logger
at the WARNING level.
- Parameters
-
logger | Logger used to log the message |
- Returns
- Stream to output the log message
Example
◆ LogLevel
Logging levels.
Please note that most logging macros take an abbreviated version of these enumerations, without the leading LOG_LEVEL_
, i.e. one of DEBUG
, INFO
, WARNING
, SEVERE
or CRITICAL
.
Enumerator |
---|
LOG_LEVEL_DEBUG | Use at your discretion.
|
LOG_LEVEL_INFO | Informational, notify of state changes.
|
LOG_LEVEL_WARNING | Something failed, but the impact of the failure is not know or minimal (e.g. purely visual).
|
LOG_LEVEL_SEVERE | Something failed and will impact functionality, some parts of the program will not function correctly.
|
LOG_LEVEL_CRITICAL | Used by assertion, after using this level the program will not be functional at all.
|
#define SURGSIM_LOG_CRITICAL(logger)
Logs a message to the specified logger at the CRITICAL level.
Definition: LogMacros.h:117
#define SURGSIM_LOG(logger, level)
Logs a message to the specified logger with the short level name.
Definition: LogMacros.h:60
#define SURGSIM_LOG_INFO(logger)
Logs a message to the specified logger at the INFO level.
Definition: LogMacros.h:86
#define SURGSIM_LOG_DEBUG(logger)
Logs a message to the specified logger at the DEBUG level.
Definition: LogMacros.h:76
#define SURGSIM_LOG_WARNING(logger)
Logs a message to the specified logger at the WARNING level.
Definition: LogMacros.h:96
#define SURGSIM_LOG_ONCE_IF(condition, logger, level)
Logs a message to the specified logger with the short level name if condition is true,...
Definition: LogMacros.h:199
#define SURGSIM_LOG_IF(condition, logger, level)
Logs a message to the specified logger with the short level name if condition is true.
Definition: LogMacros.h:135
#define SURGSIM_LOG_SEVERE(logger)
Logs a message to the specified logger at the SEVERE level.
Definition: LogMacros.h:106
#define SURGSIM_LOG_ONCE(logger, level)
Logs a message to the specified logger with the short level name, but only the first time this statem...
Definition: LogMacros.h:173