CommonMessagingBase Class Reference

#include <GaudiKernel/CommonMessaging.h>

Inheritance diagram for CommonMessagingBase:

Collaboration diagram for CommonMessagingBase:

Public Member Functions
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
virtual void	create_msgSvc () const =0
	cold functionality More...
virtual void	create_msgStream () const =0
SmartIF< IMessageSvc > &	msgSvc () const
	The standard message service. More...
MsgStream &	msgStream () const
	Return an uninitialized MsgStream. More...
MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...
MsgStream &	always () const
	shortcut for the method msgStream(MSG::ALWAYS) More...
MsgStream &	fatal () const
	shortcut for the method msgStream(MSG::FATAL) More...
MsgStream &	err () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	error () const
	shortcut for the method msgStream(MSG::ERROR) More...
MsgStream &	warning () const
	shortcut for the method msgStream(MSG::WARNING) More...
MsgStream &	info () const
	shortcut for the method msgStream(MSG::INFO) More...
MsgStream &	debug () const
	shortcut for the method msgStream(MSG::DEBUG) More...
MsgStream &	verbose () const
	shortcut for the method msgStream(MSG::VERBOSE) More...
MsgStream &	msg () const
	shortcut for the method msgStream(MSG::INFO) More...
MSG::Level	msgLevel () const
	get the output level from the embedded MsgStream More...
MSG::Level	outputLevel () const __attribute__((deprecated))
	Backward compatibility function for getting the output level. More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...

Private Attributes
std::unique_ptr< MsgStream >	m_msgStream
	The predefined message stream. More...
MSG::Level	m_level = MSG::NIL
bool	m_createMsgStream = true
	Flag to trigger a new MsgStream. More...
SmartIF< IMessageSvc >	m_msgsvc
	Pointer to the message service;. More...

Friends
template<typename Base >
class	CommonMessaging

Detailed Description

Definition at line 57 of file CommonMessaging.h.

Constructor & Destructor Documentation

virtual CommonMessagingBase::~CommonMessagingBase ( )

virtualdefault

Virtual destructor.

Member Function Documentation

MsgStream& CommonMessagingBase::always ( ) const

inline

shortcut for the method msgStream(MSG::ALWAYS)

Definition at line 108 of file CommonMessaging.h.

{ return msgStream(MSG::ALWAYS); }

virtual void CommonMessagingBase::create_msgStream ( ) const

pure virtual

Implemented in CommonMessaging< BASE >, CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >, CommonMessaging< implements< IAuditor, IProperty > >, CommonMessaging< implements< IAppMgrUI, IEventProcessor, IService, IStateful, INamedInterface, IProperty > >, CommonMessaging< IPrecedenceRulesGraph >, CommonMessaging< implements< IService, IProperty, IStateful > >, CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >, CommonMessaging< IExecutionFlowManager >, and CommonMessaging< implements< IComponentManager > >.

virtual void CommonMessagingBase::create_msgSvc ( ) const

pure virtual

cold functionality

Implemented in CommonMessaging< BASE >, CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >, CommonMessaging< implements< IAuditor, IProperty > >, CommonMessaging< implements< IAppMgrUI, IEventProcessor, IService, IStateful, INamedInterface, IProperty > >, CommonMessaging< IPrecedenceRulesGraph >, CommonMessaging< implements< IService, IProperty, IStateful > >, CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >, CommonMessaging< IExecutionFlowManager >, and CommonMessaging< implements< IComponentManager > >.

MsgStream& CommonMessagingBase::debug ( ) const

inline

shortcut for the method msgStream(MSG::DEBUG)

Definition at line 126 of file CommonMessaging.h.

{ return msgStream(MSG::DEBUG); }

MsgStream& CommonMessagingBase::err ( ) const

inline

shortcut for the method msgStream(MSG::ERROR)

Definition at line 114 of file CommonMessaging.h.

{ return msgStream(MSG::ERROR); }

MsgStream& CommonMessagingBase::error ( ) const

inline

shortcut for the method msgStream(MSG::ERROR)

Definition at line 117 of file CommonMessaging.h.

{ return msgStream(MSG::ERROR); }

MsgStream& CommonMessagingBase::fatal ( ) const

inline

shortcut for the method msgStream(MSG::FATAL)

Definition at line 111 of file CommonMessaging.h.

{ return msgStream(MSG::FATAL); }

MsgStream& CommonMessagingBase::info ( ) const

inline

shortcut for the method msgStream(MSG::INFO)

Definition at line 123 of file CommonMessaging.h.

{ return msgStream(MSG::INFO); }

MsgStream& CommonMessagingBase::msg ( ) const

inline

shortcut for the method msgStream(MSG::INFO)

Definition at line 132 of file CommonMessaging.h.

{ return msgStream(MSG::INFO); }

MSG::Level CommonMessagingBase::msgLevel ( ) const

inline

get the output level from the embedded MsgStream

Definition at line 135 of file CommonMessaging.h.

                                   {
    if (UNLIKELY(!m_msgStream)) create_msgStream();
    return m_level;
  }

bool CommonMessagingBase::msgLevel ( MSG::Level  lvl ) const

inline

get the output level from the embedded MsgStream

Definition at line 144 of file CommonMessaging.h.

{ return UNLIKELY(msgLevel() <= lvl); }

MsgStream& CommonMessagingBase::msgStream ( ) const

inline

Return an uninitialized MsgStream.

Definition at line 88 of file CommonMessaging.h.

                                      {
    if (UNLIKELY((m_createMsgStream))) create_msgStream();
    return *m_msgStream;
  }

MsgStream& CommonMessagingBase::msgStream ( const MSG::Level  level ) const

inline

Predefined configurable message stream for the efficient printouts.

if ( a < 0 ) { msgStream( MSG::ERROR ) << "a = " << endmsg ; }

Returns

Reference to the predefined stream

Definition at line 103 of file CommonMessaging.h.

                                                          {
    return msgStream() << level;
  }

SmartIF<IMessageSvc>& CommonMessagingBase::msgSvc ( ) const

inline

The standard message service.

Returns a pointer to the standard message service.

Definition at line 70 of file CommonMessaging.h.

                                              {
    if (UNLIKELY(!m_msgsvc)) create_msgSvc();
    return m_msgsvc;
  }

MSG::Level CommonMessagingBase::outputLevel ( ) const

inline

Backward compatibility function for getting the output level.

Definition at line 141 of file CommonMessaging.h.

{ return msgLevel(); }

MsgStream& CommonMessagingBase::verbose ( ) const

inline

shortcut for the method msgStream(MSG::VERBOSE)

Definition at line 129 of file CommonMessaging.h.

{ return msgStream(MSG::VERBOSE); }

MsgStream& CommonMessagingBase::warning ( ) const

inline

shortcut for the method msgStream(MSG::WARNING)

Definition at line 120 of file CommonMessaging.h.

{ return msgStream(MSG::WARNING); }

Friends And Related Function Documentation

template<typename Base >

friend class CommonMessaging

friend

Definition at line 147 of file CommonMessaging.h.

Member Data Documentation

bool CommonMessagingBase::m_createMsgStream = true

mutableprivate

Flag to trigger a new MsgStream.

Definition at line 154 of file CommonMessaging.h.

MSG::Level CommonMessagingBase::m_level = MSG::NIL

mutableprivate

Definition at line 152 of file CommonMessaging.h.

std::unique_ptr<MsgStream> CommonMessagingBase::m_msgStream

mutableprivate

The predefined message stream.

Definition at line 150 of file CommonMessaging.h.

SmartIF<IMessageSvc> CommonMessagingBase::m_msgsvc

mutableprivate

Pointer to the message service;.

Definition at line 157 of file CommonMessaging.h.

---

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

• GaudiKernel/GaudiKernel/CommonMessaging.h