CommonMessagingBase Class Reference

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/CommonMessaging.h>

Inheritance diagram for CommonMessagingBase:

Collaboration diagram for CommonMessagingBase:

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

Private Attributes
bool	m_commonMessagingReady = false
MSG::Level	m_level = MSG::NIL
boost::thread_specific_ptr< MsgStream >	m_msgStream
	The predefined message stream.
SmartIF< IMessageSvc >	m_msgsvc
	Pointer to the message service;.

Friends
template<typename Base>
class	CommonMessaging

Detailed Description

Definition at line 67 of file CommonMessaging.h.

Constructor & Destructor Documentation

~CommonMessagingBase()

virtual CommonMessagingBase::~CommonMessagingBase ( )

virtualdefault

Virtual destructor.

Member Function Documentation

always()

MsgStream & CommonMessagingBase::always ( ) const

inline

shortcut for the method msgStream(MSG::ALWAYS)

Definition at line 100 of file CommonMessaging.h.

{ return msgStream( MSG::ALWAYS ); }

create_msgStream()

virtual void CommonMessagingBase::create_msgStream ( ) const

pure virtual

cold functionality

Implemented in CommonMessaging< BASE >, CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >, CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >, CommonMessaging< implements< IAppMgrUI, Gaudi::Interfaces::IQueueingEventProcessor, IService, IStateful, INamedInterface, IProperty > >, CommonMessaging< implements< IAuditor, IProperty > >, CommonMessaging< implements< IComponentManager > >, CommonMessaging< implements< IService, IProperty, IStateful > >, and CommonMessaging< IPrecedenceRulesGraph >.

debug()

MsgStream & CommonMessagingBase::debug ( ) const

inline

shortcut for the method msgStream(MSG::DEBUG)

Definition at line 118 of file CommonMessaging.h.

{ return msgStream( MSG::DEBUG ); }

err()

MsgStream & CommonMessagingBase::err ( ) const

inline

shortcut for the method msgStream(MSG::ERROR)

Definition at line 106 of file CommonMessaging.h.

{ return msgStream( MSG::ERROR ); }

error()

MsgStream & CommonMessagingBase::error ( ) const

inline

shortcut for the method msgStream(MSG::ERROR)

Definition at line 109 of file CommonMessaging.h.

{ return msgStream( MSG::ERROR ); }

fatal()

MsgStream & CommonMessagingBase::fatal ( ) const

inline

shortcut for the method msgStream(MSG::FATAL)

Definition at line 103 of file CommonMessaging.h.

{ return msgStream( MSG::FATAL ); }

info()

MsgStream & CommonMessagingBase::info ( ) const

inline

shortcut for the method msgStream(MSG::INFO)

Definition at line 115 of file CommonMessaging.h.

{ return msgStream( MSG::INFO ); }

msg()

MsgStream & CommonMessagingBase::msg ( ) const

inline

shortcut for the method msgStream(MSG::INFO)

Definition at line 124 of file CommonMessaging.h.

{ return msgStream( MSG::INFO ); }

msgLevel() [1/2]

MSG::Level CommonMessagingBase::msgLevel ( ) const

inline

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

Definition at line 127 of file CommonMessaging.h.

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

msgLevel() [2/2]

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

inline

get the output level from the embedded MsgStream

Definition at line 133 of file CommonMessaging.h.

{ return msgLevel() <= lvl; }

msgStream() [1/2]

MsgStream & CommonMessagingBase::msgStream ( ) const

inline

Return an uninitialized MsgStream.

Definition at line 82 of file CommonMessaging.h.

                               {
    if ( !m_msgStream.get() ) create_msgStream();
    return *m_msgStream;
  }

msgStream() [2/2]

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 97 of file CommonMessaging.h.

{ return msgStream() << level; }

msgSvc()

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

inline

The standard message service.

Returns a pointer to the standard message service.

Definition at line 79 of file CommonMessaging.h.

{ return m_msgsvc; }

setUpMessaging()

virtual MSG::Level CommonMessagingBase::setUpMessaging ( ) const

pure virtual

Implemented in CommonMessaging< BASE >, CommonMessaging< implements< IAlgorithm, IDataHandleHolder, IProperty, IStateful > >, CommonMessaging< implements< IAlgTool, IDataHandleHolder, IProperty, IStateful > >, CommonMessaging< implements< IAppMgrUI, Gaudi::Interfaces::IQueueingEventProcessor, IService, IStateful, INamedInterface, IProperty > >, CommonMessaging< implements< IAuditor, IProperty > >, CommonMessaging< implements< IComponentManager > >, CommonMessaging< implements< IService, IProperty, IStateful > >, and CommonMessaging< IPrecedenceRulesGraph >.

verbose()

MsgStream & CommonMessagingBase::verbose ( ) const

inline

shortcut for the method msgStream(MSG::VERBOSE)

Definition at line 121 of file CommonMessaging.h.

{ return msgStream( MSG::VERBOSE ); }

warning()

MsgStream & CommonMessagingBase::warning ( ) const

inline

shortcut for the method msgStream(MSG::WARNING)

Definition at line 112 of file CommonMessaging.h.

{ return msgStream( MSG::WARNING ); }

Friends And Related Symbol Documentation

CommonMessaging

template<typename Base>

friend class CommonMessaging

friend

Definition at line 137 of file CommonMessaging.h.

Member Data Documentation

m_commonMessagingReady

bool CommonMessagingBase::m_commonMessagingReady = false

mutableprivate

Definition at line 139 of file CommonMessaging.h.

m_level

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

mutableprivate

Definition at line 140 of file CommonMessaging.h.

m_msgStream

boost::thread_specific_ptr<MsgStream> CommonMessagingBase::m_msgStream

mutableprivate

The predefined message stream.

Definition at line 143 of file CommonMessaging.h.

m_msgsvc

SmartIF<IMessageSvc> CommonMessagingBase::m_msgsvc

mutableprivate

Pointer to the message service;.

Definition at line 146 of file CommonMessaging.h.

---

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

• GaudiKernel/include/GaudiKernel/CommonMessaging.h