Message Class Reference

The Message class. More...

#include <GaudiKernel/Message.h>

Collaboration diagram for Message:

Public Member Functions
	Message ()
	Default constructor.
	Message (const char *src, int type, const char *msg)
	Constructor.
	Message (const std::string &src, int type, const std::string &msg)
	Constructor.
	~Message ()
	Default destructor.
const std::string &	getMessage () const
	Get the message string.
void	setMessage (const std::string &msg)
	Set the message string.
int	getType () const
	Get the message type.
void	setType (int msg_type)
	Set the message type.
const std::string &	getSource () const
	Get the message source.
void	setSource (const std::string &src)
	Set the message source.
const std::string &	getFormat () const
	Get the format string.
void	setFormat (const std::string &msg) const
	Set the format string.
const std::string &	getTimeFormat () const
	Get the time format string.
void	setTimeFormat (const std::string &timeFormat) const
	Set the time format string.
bool	operator< (const Message &test)
	Needed to build maps.

Static Public Member Functions
static const std::string	getDefaultFormat ()
	Get the default format string.
static const std::string	getDefaultTimeFormat ()
	Get the default time format string.

Protected Member Functions
void	invalidFormat () const
	Called when an invalid format string is encountered.
void	makeFormattedMsg (const std::string &format) const
	Format the message.
void	decodeFormat (const std::string &format) const
	Decode format.
void	sizeField (const std::string &text) const
	Truncate or pad the output string to the field width as necessary.
void	setWidth (const std::string &formatArg) const
	Set the width of a stream.

Protected Attributes
std::string	m_message
	The message.
std::string	m_source
	The source.
std::string	m_format
	The format string.
std::string	m_time_format
	Time format string.
int	m_type
	The type.
std::string	m_formatted_msg
	Formatted message.
char	m_fill
	The current fill character.
int	m_width
	The current field width.
bool	m_left
	Justification.

Static Protected Attributes
static const char	FORMAT_PREFIX = '%'
	The character used to prefix formatting commands.
static const char	JUSTIFY_LEFT = 'L'
	The character used to indicate start of left text justification.
static const char	JUSTIFY_RIGHT = 'R'
	The character used to indicate start of right text justification.
static const char	MESSAGE = 'M'
	The character used to indicate that the message should be printed.
static const char	TYPE = 'T'
	The character used to indicate that the message type should be printed.
static const char	TIME = 't'
	The character used to indicate that the message timestamp should be printed.
static const char	UTIME = 'u'
	The character used to indicate that the message timestamp should be printed in UTC time.
static const char	SOURCE = 'S'
	The character used to indicate that the message source should be printed.
static const char	FILL = 'F'
	The character used to indicate that the previous character is to be used for padding out fields if the text is not long enough.
static const char	WIDTH = 'W'
	The character used to indicate that the previous decimal characters should be taken as the field width.
static const char *	DEFAULT_FORMAT = "% F%18W%S%7W%R%T %0W%M"
	The default message format.
static const char *	DEFAULT_TIME_FORMAT = "%Y-%m-%d %H:%M:%S,%f"
	The default time format.

Friends
std::ostream &	operator<< (std::ostream &stream, const Message &msg)
	Insert the message into a stream.
bool	operator== (const Message &a, const Message &b)
	Insert the message into a stream.

Detailed Description

The Message class.

This class is used to contain messages which can then be formatted and sent to a message service

Author

Iain Last

Definition at line 15 of file Message.h.

Constructor & Destructor Documentation

Message::Message

(

)

Default constructor.

Definition at line 45 of file Message.cpp.

                 :
  m_message( "" ), m_source( "UNKNOWN" ), m_format( DEFAULT_FORMAT ),
  m_time_format(DEFAULT_TIME_FORMAT), m_type( NIL ),
  m_fill( ' ' ), m_width( 0 ), m_left( true )
{