---

IMessageSvc Class Reference

The IMessage is the interface implmented by the message service. More...

#include <GaudiKernel/IMessageSvc.h>

Inheritance diagram for IMessageSvc:

List of all members.

Public Methods
virtual void	reportMessage ( const Message& message ) = 0
	Report a message by sending a Message object to the message serivice. More...
virtual void	reportMessage ( const StatusCode& code, const std::string& source = "" ) = 0
	Report an error to the message service. More...
virtual void	reportMessage ( const std::string& source, int type, const std::string& message ) = 0
	Report a message by specifying the source, severity level and text. More...
virtual void	reportMessage ( const char* source, int type, const char* message = "" ) = 0
	Report a message by specifying the source, severity level and text. More...
virtual void	insertMessage ( const StatusCode& code, const Message& message ) = 0
	Insert a message to be sent for a given status code into the error code repository. More...
virtual void	eraseMessage () = 0
	Erase all messages associated to all status codes.
virtual void	eraseMessage ( const StatusCode& code ) = 0
	Erase message associated to a given status code.
virtual void	eraseMessage ( const StatusCode& code, const Message& message ) = 0
	Erase a given message associated to a given status code. More...
virtual void	insertStream ( int type, const std::string& name, std::ostream* stream ) = 0
	Add a new stream for a message type (severity level). More...
virtual void	eraseStream () = 0
	Delete all the streams.
virtual void	eraseStream ( int message_type ) = 0
	Delete all the streams for a given message type (severity level).
virtual void	eraseStream ( int type, std::ostream* stream ) = 0
	Delete a single stream for a given message type (severity level). More...
virtual void	eraseStream ( std::ostream* stream ) = 0
	Delete all occurrences of a stream. More...
virtual std::ostream*	defaultStream () const = 0
	Get the default stream.
virtual void	setDefaultStream ( std::ostream* stream ) = 0
	Set the default stream. More...
virtual int	outputLevel () const = 0
	Retrieve the current output level threshold.
virtual int	outputLevel ( const std::string& source ) const = 0
	Retrieve the current output level threshold for a given message source. More...
virtual void	setOutputLevel ( int new_level ) = 0
	Set new global output level threshold.
virtual void	setOutputLevel ( const std::string& source, int new_level) = 0
	Set new output level threshold for a given message source. More...
Static Public Methods
const InterfaceID&	interfaceID ()
	Retrieve interface ID. More...

---

Detailed Description

The IMessage is the interface implmented by the message service.

This interface is used by any algorithm or services wanting to report messages to the end-user.

Author(s):

Iain Last

Definition at line 39 of file IMessageSvc.h.

---

Member Function Documentation

std::ostream * IMessageSvc::defaultStream ( ) const [pure virtual]

Get the default stream.

void IMessageSvc::eraseMessage ( const StatusCode & code, const Message & message ) [pure virtual]

Erase a given message associated to a given status code. Parameters: code   Status error code message   Message associated

void IMessageSvc::eraseMessage ( const StatusCode & code ) [pure virtual]

Erase message associated to a given status code.

void IMessageSvc::eraseMessage ( ) [pure virtual]

Erase all messages associated to all status codes.

void IMessageSvc::eraseStream ( std::ostream * stream ) [pure virtual]

Delete all occurrences of a stream. Parameters: stream   Pointer to a C++ stream

void IMessageSvc::eraseStream ( int type, std::ostream * stream ) [pure virtual]

Delete a single stream for a given message type (severity level). Parameters: type   Severity level stream   Pointer to a C++ stream

void IMessageSvc::eraseStream ( int message_type ) [pure virtual]

Delete all the streams for a given message type (severity level).

void IMessageSvc::eraseStream ( ) [pure virtual]

Delete all the streams.

void IMessageSvc::insertMessage ( const StatusCode & code, const Message & message ) [pure virtual]

Insert a message to be sent for a given status code into the error code repository. Parameters: code   Status error code message   Message associated

void IMessageSvc::insertStream ( int type, const std::string & name, std::ostream * stream ) [pure virtual]

Add a new stream for a message type (severity level). Parameters: type   Severity level name   Stream name stream   Pointer to a C++ stream

const InterfaceID & IMessageSvc::interfaceID ( ) [inline, static]

Retrieve interface ID. Reimplemented from IInterface. Definition at line 43 of file IMessageSvc.h.

int IMessageSvc::outputLevel ( const std::string & source ) const [pure virtual]

Retrieve the current output level threshold for a given message source. Parameters: source   Message source. Typically the alg/svc name

int IMessageSvc::outputLevel ( ) const [pure virtual]

Retrieve the current output level threshold. Referenced by MsgStream::MsgStream().

void IMessageSvc::reportMessage ( const char * source, int type, const char * message = "" ) [pure virtual]

Report a message by specifying the source, severity level and text. The text is passed as C like character string to avoid extra copying. Parameters: source   Message source. Typically the alg/svc name type   Severity level message   Text message

void IMessageSvc::reportMessage ( const std::string & source, int type, const std::string & message ) [pure virtual]

Report a message by specifying the source, severity level and text. Parameters: source   Message source. Typically the alg/svc name type   Severity level message   Text message

void IMessageSvc::reportMessage ( const StatusCode & code, const std::string & source = "" ) [pure virtual]

Report an error to the message service. The service will use the error code number for formating a human readible message Parameters: code   Error code number source   Message source. Typically the alg/svc name

void IMessageSvc::reportMessage ( const Message & message ) [pure virtual]

Report a message by sending a Message object to the message serivice. Parameters: message   Reference to a message object Referenced by MsgStream::doOutput(), Service::finalize(), and Service::initialize().

void IMessageSvc::setDefaultStream ( std::ostream * stream ) [pure virtual]

Set the default stream. Parameters: stream   Pointer to a C++ stream

void IMessageSvc::setOutputLevel ( const std::string & source, int new_level ) [pure virtual]

Set new output level threshold for a given message source. Parameters: source   Message source new_level   Severity level

void IMessageSvc::setOutputLevel ( int new_level ) [pure virtual]

Set new global output level threshold. Referenced by Service::initialize(), Auditor::setOutputLevel(), Algorithm::setOutputLevel(), and AlgTool::setProperties().

---

The documentation for this class was generated from the following file:

• IMessageSvc.h

---