The Gaudi Framework  v30r3 (a5ef0a68)
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...
 

Private Attributes

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

Friends

template<typename Base >
class CommonMessaging
 

Detailed Description

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

92 { 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 110 of file CommonMessaging.h.

110 { 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 98 of file CommonMessaging.h.

98 { 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 101 of file CommonMessaging.h.

101 { 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 95 of file CommonMessaging.h.

95 { 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 107 of file CommonMessaging.h.

107 { 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 116 of file CommonMessaging.h.

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

Return an uninitialized MsgStream.

Definition at line 73 of file CommonMessaging.h.

74  {
75  if ( UNLIKELY( ( !m_msgStream.get() ) ) ) create_msgStream();
76  return *m_msgStream;
77  }
#define UNLIKELY(x)
Definition: Kernel.h:122
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 89 of file CommonMessaging.h.

89 { 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 70 of file CommonMessaging.h.

70 { return m_msgsvc; }
SmartIF< IMessageSvc > m_msgsvc
Pointer to the message service;.
MsgStream& CommonMessagingBase::verbose ( ) const
inline

shortcut for the method msgStream(MSG::VERBOSE)

Definition at line 113 of file CommonMessaging.h.

113 { 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 104 of file CommonMessaging.h.

104 { 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 120 of file CommonMessaging.h.

Member Data Documentation

bool CommonMessagingBase::m_commonMessagingReady = false
mutableprivate

Definition at line 122 of file CommonMessaging.h.

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

Definition at line 123 of file CommonMessaging.h.

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

The predefined message stream.

Definition at line 126 of file CommonMessaging.h.

SmartIF<IMessageSvc> CommonMessagingBase::m_msgsvc
mutableprivate

Pointer to the message service;.

Definition at line 129 of file CommonMessaging.h.


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