rcMsg

class rcMsg

Message class for the run control

Public Classes
enum eLog_types: Enum for the different types of messages

Public Methods
static void init(): Initialisation routine
static void msg( int iType, const char *msg, const char* file = NULL, int iLine = 0 ): Puts the message to cout

Public
enum eLog_types: Enum for the different types of messages

Private Fields
static msg_control* pMsgDebug: msg_control structur for debug messages
static msg_control* pMsgError: msg_control structur for error messages
static msg_control* pMsgFatal: msg_control structur for fatal messages
static msg_control* pMsgInfo: msg_control structur for info messages
static msg_control* pMsgWarning: msg_control structur for warning messages

Documentation

Message class for the run control. The run control prints messages of several types. These messages go from the user's point of view to cout. Behind the scenes are two layers:

The macro rcLog which has two parameters: rcLog( type, msg ) (header file rc_log.h)
The class rcMsg, which is a wrapper class to the PHENIX message system.
rcLog:
The reaons for using rcLog is to historical: It was started when there was no PHENIX messaging system, and the goal was to be able to integrate it easily with whatever message system we would end up with. Using a macro in addition allows to append the C preprocessor variables __FILE__ and __LINE__ if the code is compiled with the flag RC_DEBUG. This allows to quickly locate messages in files. rcLog currently just calls rcMsg::msg.
rcMsg:
The run control message interfaces with the PHENIX messaging system. This class consists of a few static member functions to setup the various message filters. (See the PHENIX messaging system for details, the author is M.Purschke).
The run control has the following message types:

DEBUG: for simple debugging messages. This is not really used, instead most objects have an internal flag bDebug, that can be turned on and off interactivly.
INFO: just an informational message
WARNING: To draw the attention to something
ERROR: an serious error occured, but the run control is safe to continue
FATAL: a fatal error occured, the run control should be shut down.
Last Update: Feb 2, 2000, CW