dist_tools/
mg_log.pro
includes main-level program MG_LOG is a procedural interface to the logging framework.
MG_LOG is a convenience routine so that the MGffLogger object does not
need to be explicitly stored. If more than one logger is required, then
create and use the logger objects explicitly instead of using this routine.
The error levels are: none (level 0), critical (level 1), error (level 2), warning (level 3), informational (level 4), debug (level 5). Only log messages with a level less than or equal to the current logger level are actually recorded.
Named subloggers can be created using the NAME keyword. These subloggers
should be used for individual applications or functional areas of an
application.
For example, the following starts the logging framework and creates an
"mg_example" logger object returned via the LOGGER keyword:
mg_log, name='mg_example', logger=logger
Further refinement can be done with a hierarchy of names, such as:
mg_log, name='mg_example/gui', logger=logger
Examples
Use the LOGGER keyword to retrieve the logger object in order to set
the level or filename of output:
IDL> mg_log, logger=logger
IDL> logger->setProperty, level=3
IDL> mg_log, 'Warning message', /warning
top mg_log
mg_log [, msg] [, name=string] [, /debug] [, /informational] [, /warning] [, /error] [, /critical] [, /last_error] [, logger=object] [, /quit]
Messages are logged via this routine. Also, the LOGGER keyword returns the
logging object which is used to configure the logging.
Parameters
- msg in optional type=string
message to log, if present
Keywords
- name in optional type=string
path to logger to send message to
- debug in optional type=boolean
set to specify the message as debug
- informational in optional type=boolean
set to specify the message as informational
- warning in optional type=boolean
set to specify the message as a warning
- error in optional type=boolean
set to specify the message as an error
- critical in optional type=boolean
set to specify the message as critical
- last_error in optional type=boolean
set to place a stack trace for the last error in the log; placed after the logging of any normal message in this call
- logger out optional type=object
MGffLogger object
- quit in optional type=boolean
set to quit logging; will log an normal message in this call before quitting
File attributes
| Modification date: | Tue Oct 19 18:48:11 2010 |
| Lines: | 139 |
| Docformat: | rst rst |