CommonMessaging< BASE > Class Template Reference

#include <GaudiKernel/CommonMessaging.h>

Inheritance diagram for CommonMessaging< BASE >:

Collaboration diagram for CommonMessaging< BASE >:

Public Types
using	base_class = CommonMessaging

Public Member Functions
MSG::Level	msgLevel () const
	get the cached level (originally extracted from the embedded MsgStream) More...
MSG::Level	outputLevel () const
	Backward compatibility function for getting the output level. More...
bool	msgLevel (MSG::Level lvl) const
	get the output level from the embedded MsgStream More...
Public Member Functions inherited from CommonMessagingBase
virtual	~CommonMessagingBase ()=default
	Virtual destructor. More...
const 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...

Protected Member Functions
MSG::Level	setUpMessaging () const
	Set up local caches. More...
MSG::Level	resetMessaging ()
	Reinitialize internal states. More...
void	updateMsgStreamOutputLevel (int level)
	Update the output level of the cached MsgStream. More...

Private Member Functions
void	create_msgStream () const override final
	cold functionality More...
void	initMessaging () const
	Initialise the messaging objects. More...

Detailed Description

template<typename BASE>
class CommonMessaging< BASE >

Definition at line 56 of file CommonMessaging.h.

Member Typedef Documentation

template<typename BASE>

using CommonMessaging< BASE >::base_class = CommonMessaging

Definition at line 132 of file CommonMessaging.h.

Member Function Documentation

template<typename BASE>

void CommonMessaging< BASE >::create_msgStream ( ) const

inlinefinaloverrideprivatevirtual

cold functionality

Implements CommonMessagingBase.

Definition at line 153 of file CommonMessaging.h.

{ m_msgStream.reset( new MsgStream( msgSvc(), this->name() ) ); }

template<typename BASE>

void CommonMessaging< BASE >::initMessaging ( ) const

inlineprivate

Initialise the messaging objects.

Definition at line 156 of file CommonMessaging.h.

                             {
    if ( !m_msgsvc ) {
      // Get default implementation of the message service.
      m_msgsvc = this->serviceLocator();
    }
    create_msgStream();
    m_level = MSG::Level( m_msgStream.get() ? m_msgStream->level() : MSG::NIL );
    // if we could not get a MessageSvc, we should try again the initial set up
    m_commonMessagingReady = m_msgsvc;
  }

template<typename BASE>

MSG::Level CommonMessaging< BASE >::msgLevel ( ) const

inline

get the cached level (originally extracted from the embedded MsgStream)

Definition at line 138 of file CommonMessaging.h.

                                   {
    if ( LIKELY( m_commonMessagingReady ) ) return m_level;
    return setUpMessaging();
  }

template<typename BASE>

bool CommonMessaging< BASE >::msgLevel ( MSG::Level  lvl ) const

inline

get the output level from the embedded MsgStream

Definition at line 149 of file CommonMessaging.h.

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

template<typename BASE>

MSG::Level CommonMessaging< BASE >::outputLevel ( ) const

inline

Backward compatibility function for getting the output level.

Definition at line 144 of file CommonMessaging.h.

                                                                                                         {
    return msgLevel();
  }

template<typename BASE>

MSG::Level CommonMessaging< BASE >::resetMessaging ( )

inlineprotected

Reinitialize internal states.

Definition at line 174 of file CommonMessaging.h.

                            {
    m_commonMessagingReady = false;
    return setUpMessaging();
  }

template<typename BASE>

MSG::Level CommonMessaging< BASE >::setUpMessaging ( ) const

inlineprotected

Set up local caches.

Definition at line 169 of file CommonMessaging.h.

                                  {
    if ( UNLIKELY( !m_commonMessagingReady ) ) { initMessaging(); }
    return m_level;
  }

template<typename BASE>

void CommonMessaging< BASE >::updateMsgStreamOutputLevel ( int  level )

inlineprotected

Update the output level of the cached MsgStream.

This function is meant to be called by the update handler of the OutputLevel property.

Definition at line 180 of file CommonMessaging.h.

                                               {
    setUpMessaging();
    if ( level != MSG::NIL && level != m_level ) {
      if ( msgSvc() ) msgSvc()->setOutputLevel( this->name(), level );
      if ( m_msgStream.get() ) m_msgStream->setLevel( level );
      if ( UNLIKELY( MSG::Level( level ) <= MSG::DEBUG ) )
        debug() << "Property update for OutputLevel : new value = " << level << endmsg;
      m_level = MSG::Level( level );
    }
  }

---

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

• GaudiKernel/GaudiKernel/CommonMessaging.h