Loading [MathJax]/extensions/tex2jax.js
The Gaudi Framework  v29r3 (fa547fc2)
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
CommonMessagingBase Class Referenceabstract

#include <GaudiKernel/CommonMessaging.h>

Inheritance diagram for CommonMessagingBase:
Collaboration diagram for CommonMessagingBase:

Public Member Functions

virtual ~CommonMessagingBase ()=default
 Virtual destructor. More...
 
virtual void create_msgStream () const =0
 cold functionality More...
 
const SmartIF< IMessageSvc > & msgSvc () const
 The standard message service. More...
 
MsgStreammsgStream () const
 Return an uninitialized MsgStream. More...
 
MsgStreammsgStream (const MSG::Level level) const
 Predefined configurable message stream for the efficient printouts. More...
 
MsgStreamalways () const
 shortcut for the method msgStream(MSG::ALWAYS) More...
 
MsgStreamfatal () const
 shortcut for the method msgStream(MSG::FATAL) More...
 
MsgStreamerr () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamerror () const
 shortcut for the method msgStream(MSG::ERROR) More...
 
MsgStreamwarning () const
 shortcut for the method msgStream(MSG::WARNING) More...
 
MsgStreaminfo () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MsgStreamdebug () const
 shortcut for the method msgStream(MSG::DEBUG) More...
 
MsgStreamverbose () const
 shortcut for the method msgStream(MSG::VERBOSE) More...
 
MsgStreammsg () const
 shortcut for the method msgStream(MSG::INFO) More...
 
MSG::Level msgLevel () const
 get the cached level (originally extracted 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

bool m_commonMessagingReady = false
 
boost::thread_specific_ptr< MsgStreamm_msgStream
 The predefined message stream. More...
 
MSG::Level m_level = MSG::NIL
 
SmartIF< IMessageSvcm_msgsvc
 Pointer to the message service;. More...
 

Friends

template<typename Base >
class CommonMessaging
 

Detailed Description

Definition at line 64 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 97 of file CommonMessaging.h.

97 { return msgStream( MSG::ALWAYS ); }
MsgStream & msgStream() const
Return an uninitialized MsgStream.
MsgStream& CommonMessagingBase::debug ( ) const
inline

shortcut for the method msgStream(MSG::DEBUG)

Definition at line 115 of file CommonMessaging.h.

115 { return msgStream( MSG::DEBUG ); }
MsgStream & msgStream() const
Return an uninitialized MsgStream.
MsgStream& CommonMessagingBase::err ( ) const
inline

shortcut for the method msgStream(MSG::ERROR)

Definition at line 103 of file CommonMessaging.h.

103 { return msgStream( MSG::ERROR ); }
MsgStream & msgStream() const
Return an uninitialized MsgStream.
MsgStream& CommonMessagingBase::error ( ) const
inline

shortcut for the method msgStream(MSG::ERROR)

Definition at line 106 of file CommonMessaging.h.

106 { return msgStream( MSG::ERROR ); }
MsgStream & msgStream() const
Return an uninitialized MsgStream.
MsgStream& CommonMessagingBase::fatal ( ) const
inline

shortcut for the method msgStream(MSG::FATAL)

Definition at line 100 of file CommonMessaging.h.

100 { return msgStream( MSG::FATAL ); }
MsgStream & msgStream() const
Return an uninitialized MsgStream.
MsgStream& CommonMessagingBase::info ( ) const
inline

shortcut for the method msgStream(MSG::INFO)

Definition at line 112 of file CommonMessaging.h.

112 { return msgStream( MSG::INFO ); }
MsgStream & msgStream() const
Return an uninitialized MsgStream.
MsgStream& CommonMessagingBase::msg ( ) const
inline

shortcut for the method msgStream(MSG::INFO)

Definition at line 121 of file CommonMessaging.h.

121 { return msgStream( MSG::INFO ); }
MsgStream & msgStream() const
Return an uninitialized MsgStream.
MSG::Level CommonMessagingBase::msgLevel ( ) const
inline

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

Definition at line 124 of file CommonMessaging.h.

125  {
126  assert( m_commonMessagingReady );
127  return m_level;
128  }
bool CommonMessagingBase::msgLevel ( MSG::Level  lvl) const
inline

get the output level from the embedded MsgStream

Definition at line 134 of file CommonMessaging.h.

134 { return UNLIKELY( msgLevel() <= lvl ); }
#define UNLIKELY(x)
Definition: Kernel.h:128
MSG::Level msgLevel() const
get the cached level (originally extracted from the embedded MsgStream)
MsgStream& CommonMessagingBase::msgStream ( ) const
inline

Return an uninitialized MsgStream.

Definition at line 78 of file CommonMessaging.h.

79  {
80  if ( UNLIKELY( ( !m_msgStream.get() ) ) ) create_msgStream();
81  return *m_msgStream;
82  }
#define UNLIKELY(x)
Definition: Kernel.h:128
virtual void create_msgStream() const =0
cold functionality
boost::thread_specific_ptr< MsgStream > m_msgStream
The predefined message stream.
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 94 of file CommonMessaging.h.

94 { return msgStream() << level; }
MsgStream & msgStream() const
Return an uninitialized MsgStream.
const SmartIF<IMessageSvc>& CommonMessagingBase::msgSvc ( ) const
inline

The standard message service.

Returns a pointer to the standard message service.

Definition at line 75 of file CommonMessaging.h.

75 { return m_msgsvc; }
SmartIF< IMessageSvc > m_msgsvc
Pointer to the message service;.
MSG::Level CommonMessagingBase::outputLevel ( ) const
inline

Backward compatibility function for getting the output level.

Definition at line 131 of file CommonMessaging.h.

131 { return msgLevel(); }
MSG::Level msgLevel() const
get the cached level (originally extracted from the embedded MsgStream)
MsgStream& CommonMessagingBase::verbose ( ) const
inline

shortcut for the method msgStream(MSG::VERBOSE)

Definition at line 118 of file CommonMessaging.h.

118 { return msgStream( MSG::VERBOSE ); }
MsgStream & msgStream() const
Return an uninitialized MsgStream.
MsgStream& CommonMessagingBase::warning ( ) const
inline

shortcut for the method msgStream(MSG::WARNING)

Definition at line 109 of file CommonMessaging.h.

109 { return msgStream( MSG::WARNING ); }
MsgStream & msgStream() const
Return an uninitialized MsgStream.

Friends And Related Function Documentation

template<typename Base >
friend class CommonMessaging
friend

Definition at line 138 of file CommonMessaging.h.

Member Data Documentation

bool CommonMessagingBase::m_commonMessagingReady = false
private

Definition at line 140 of file CommonMessaging.h.

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

Definition at line 145 of file CommonMessaging.h.

boost::thread_specific_ptr<MsgStream> CommonMessagingBase::m_msgStream
mutableprivate

The predefined message stream.

Definition at line 143 of file CommonMessaging.h.

SmartIF<IMessageSvc> CommonMessagingBase::m_msgsvc
private

Pointer to the message service;.

Definition at line 148 of file CommonMessaging.h.


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