IMessageSvc Class Reference

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

#include <GaudiKernel/IMessageSvc.h>

Inheritance diagram for IMessageSvc:

Collaboration diagram for IMessageSvc:

Public Member Functions
	DeclareInterfaceID (IMessageSvc, 2, 0)
	InterfaceID.
virtual void	reportMessage (const Message &msg, int outputLevel)=0
	Report a message by sending a Message object to the message service.
virtual void	reportMessage (const Message &message)=0
	Report a message by sending a Message object to the message service.
virtual void	reportMessage (const StatusCode &code, std::string_view source="")=0
	Report an error to the message service.
virtual void	reportMessage (std::string source, int type, std::string message)=0
	Report a message by specifying the source, severity level and text.
virtual void	insertMessage (const StatusCode &code, Message message)=0
	Insert a message to be sent for a given status code into the error code repository.
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.
virtual void	insertStream (int type, std::string name, std::ostream *stream)=0
	Add a new stream for a message type (severity level).
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)
virtual void	eraseStream (std::ostream *stream)=0
	Delete all occurrences of a stream.
virtual std::ostream *	defaultStream () const =0
	Get the default stream.
virtual void	setDefaultStream (std::ostream *stream)=0
	Set the default stream.
virtual int	outputLevel () const =0
	Retrieve the current output level threshold.
virtual int	outputLevel (std::string_view source) const =0
	Retrieve the current output level threshold for a given message source.
virtual void	setOutputLevel (int new_level)=0
	Set new global output level threshold.
virtual void	setOutputLevel (std::string_view source, int new_level)=0
	Set new output level threshold for a given message source.
virtual bool	useColor () const =0
	Show whether colors are used.
virtual std::string	getLogColor (int logLevel) const =0
	Get the color codes for various log levels.
virtual int	messageCount (MSG::Level level) const =0
	Get the number of messages issued at a particular level.
Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET *	cast ()
template<Gaudi::IsInterface TARGET>
TARGET const *	cast () const
template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET *	cast ()
template<typename TARGET> requires ( !Gaudi::IsInterface<TARGET> )
TARGET const *	cast () const
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces.
virtual unsigned long	addRef () const =0
	Increment the reference count of Interface instance.
virtual unsigned long	release () const =0
	Release Interface instance.
virtual unsigned long	refCount () const =0
	Current reference count.
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance.
virtual	~IInterface ()=default
	Virtual destructor.
virtual void const *	i_cast (const InterfaceID &) const =0
void *	i_cast (const InterfaceID &iid)

Additional Inherited Members
Public Types inherited from IInterface
enum class	Status : StatusCode::code_t {   FAILURE = 0 , SUCCESS = 1 , NO_INTERFACE , VERSMISMATCH ,   LAST_ERROR }
	Return status. More...
using	iid = Gaudi::InterfaceId<IInterface, 0, 0>
	Interface ID.
using	ext_iids = Gaudi::interface_list<iid>
	Extra interfaces.
Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface.
Protected Member Functions inherited from IInterface
virtual unsigned long	decRef () const =0
	Decrement reference count and return the new reference count.

Detailed Description

The IMessage is the interface implemented by the message service.

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

Author

Iain Last

Definition at line 34 of file IMessageSvc.h.

Member Function Documentation

DeclareInterfaceID()

IMessageSvc::DeclareInterfaceID	(	IMessageSvc	,
		2	,
		0	)

InterfaceID.

defaultStream()

virtual std::ostream * IMessageSvc::defaultStream ( ) const

pure virtual

Get the default stream.

eraseMessage() [1/3]

virtual void IMessageSvc::eraseMessage ( )

pure virtual

Erase all messages associated to all status codes.

eraseMessage() [2/3]

virtual void IMessageSvc::eraseMessage ( const StatusCode & code )

pure virtual

Erase message associated to a given status code.

eraseMessage() [3/3]

virtual 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

eraseStream() [1/4]

virtual void IMessageSvc::eraseStream ( )

pure virtual

Delete all the streams.

eraseStream() [2/4]

virtual void IMessageSvc::eraseStream ( int message_type )

pure virtual

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

eraseStream() [3/4]

virtual 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

eraseStream() [4/4]

virtual void IMessageSvc::eraseStream ( std::ostream * stream )

pure virtual

Delete all occurrences of a stream.

Parameters

stream

Pointer to a C++ stream

getLogColor()

virtual std::string IMessageSvc::getLogColor ( int logLevel ) const

pure virtual

Get the color codes for various log levels.

Parameters

logLevel

Logging level

insertMessage()

virtual void IMessageSvc::insertMessage ( const StatusCode & code, 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

insertStream()

virtual void IMessageSvc::insertStream ( int type, 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

messageCount()

virtual int IMessageSvc::messageCount ( MSG::Level level ) const

pure virtual

Get the number of messages issued at a particular level.

outputLevel() [1/2]

virtual int IMessageSvc::outputLevel ( ) const

pure virtual

Retrieve the current output level threshold.

outputLevel() [2/2]

virtual int IMessageSvc::outputLevel ( std::string_view source ) const

pure virtual

Retrieve the current output level threshold for a given message source.

Parameters

source

Message source. Typically the alg/svc name

reportMessage() [1/4]

virtual void IMessageSvc::reportMessage ( const Message & message )

pure virtual

Report a message by sending a Message object to the message service.

Parameters

message

Reference to a message object

reportMessage() [2/4]

virtual void IMessageSvc::reportMessage ( const Message & msg, int outputLevel )

pure virtual

Report a message by sending a Message object to the message service.

Parameters

message	Reference to a message object
outputLevel	Output level of the message source for this message

reportMessage() [3/4]

virtual void IMessageSvc::reportMessage ( const StatusCode & code, std::string_view source = "" )

pure virtual

Report an error to the message service.

The service will use the error code number for formating a human readable message

Parameters

code	Error code number
source	Message source. Typically the alg/svc name

reportMessage() [4/4]

virtual void IMessageSvc::reportMessage ( std::string source, int type, 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

setDefaultStream()

virtual void IMessageSvc::setDefaultStream ( std::ostream * stream )

pure virtual

Set the default stream.

Parameters

stream

Pointer to a C++ stream

setOutputLevel() [1/2]

virtual void IMessageSvc::setOutputLevel ( int new_level )

pure virtual

Set new global output level threshold.

setOutputLevel() [2/2]

virtual void IMessageSvc::setOutputLevel ( std::string_view source, int new_level )

pure virtual

Set new output level threshold for a given message source.

Parameters

source	Message source
new_level	Severity level

useColor()

virtual bool IMessageSvc::useColor ( ) const

pure virtual

Show whether colors are used.

---

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

• GaudiKernel/include/GaudiKernel/IMessageSvc.h