CMS 3D CMS Logo

lat::logflag Struct Reference

A log mode flag. More...

#include <Iguana/Utilities/classlib/utils/Log.h>

List of all members.

Public Attributes

int level
 If the mode is enabled, this indicates the logging level up to which, inclusively, logging will be performed.
const char * name
 A short and descriptive mode name.
logflagnext
 Pointer to the next log flag.
bool selected
 A flag indicating whether this mode is currently selected.


Detailed Description

A log mode flag.

Log mode flags are used for two purposes: to associate a particular dump to a mode and to control what kinds of outputs are actually emitted. All output that is actually emitted is prefixed with the mode in which it was produced.

Definition at line 101 of file Log.h.


Member Data Documentation

int lat::logflag::level

If the mode is enabled, this indicates the logging level up to which, inclusively, logging will be performed.

The value must be -1 or greater; -1 indicates all possible logging levels. The value may be changed at any time during the execution of the program.

The default of this value is whatever is assigned to it in static initialisers; it is recommended to set it to -1. This may be overridden by the $LOG_MODES environment variable (effective only on the first use of the mode).

Definition at line 142 of file Log.h.

const char* lat::logflag::name

A short and descriptive mode name.

It will be used in output to identify the mode.

Definition at line 110 of file Log.h.

Referenced by MMM_DEFUN_FUNC().

logflag* lat::logflag::next

Pointer to the next log flag.

User defined flags should always set this field to zero---it will be initialised when the mode flag is used for the first time.

Definition at line 106 of file Log.h.

bool lat::logflag::selected

A flag indicating whether this mode is currently selected.

The value of this field is determined to see if the dumps in this mode should actually emit any output. Setting the field to true will enable the mode, while setting it to false will cause the output to discarded.

The value of this flag may be changed at any time during the execution of the program. It defaults to the value it is set in static initialisation. That value can be overridden by the $LOG_MODES environment variable (effective only on first use of the mode flag).

When enabled, the two special modes LFall and LFnever override the settings of all other modes. When LFall is enabled, all modes are enabled. When LFnever is enabled, all modes are disabled. If both are enabled, LFall takes precendece. Only if neither is enabled is the value of this field consulted.

Definition at line 130 of file Log.h.


The documentation for this struct was generated from the following file:
Generated on Tue Jun 9 18:48:26 2009 for CMSSW by  doxygen 1.5.4