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_msgSvc () const =0
 cold functionality More...
 
virtual void create_msgStream () const =0
 
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 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< MsgStreamm_msgStream
 The predefined message stream. More...
 
MSG::Level m_level = MSG::NIL
 
bool m_createMsgStream = true
 Flag to trigger a new MsgStream. More...
 
SmartIF< IMessageSvcm_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.

108 { 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 126 of file CommonMessaging.h.

126 { 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 114 of file CommonMessaging.h.

114 { 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 117 of file CommonMessaging.h.

117 { 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 111 of file CommonMessaging.h.

111 { 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 123 of file CommonMessaging.h.

123 { 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 132 of file CommonMessaging.h.

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

get the output level from the embedded MsgStream

Definition at line 135 of file CommonMessaging.h.

135  {
137  return m_level;
138  }
#define UNLIKELY(x)
Definition: Kernel.h:126
std::unique_ptr< MsgStream > m_msgStream
The predefined message stream.
virtual void create_msgStream() const =0
bool CommonMessagingBase::msgLevel ( MSG::Level  lvl) const
inline

get the output level from the embedded MsgStream

Definition at line 144 of file CommonMessaging.h.

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

Return an uninitialized MsgStream.

Definition at line 88 of file CommonMessaging.h.

88  {
90  return *m_msgStream;
91  }
#define UNLIKELY(x)
Definition: Kernel.h:126
std::unique_ptr< MsgStream > m_msgStream
The predefined message stream.
virtual void create_msgStream() const =0
bool m_createMsgStream
Flag to trigger a new 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.

103  {
104  return msgStream() << level;
105  }
MsgStream & msgStream() const
Return an uninitialized MsgStream.
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  {
72  return m_msgsvc;
73  }
SmartIF< IMessageSvc > m_msgsvc
Pointer to the message service;.
#define UNLIKELY(x)
Definition: Kernel.h:126
virtual void create_msgSvc() const =0
cold functionality
MSG::Level CommonMessagingBase::outputLevel ( ) const
inline

Backward compatibility function for getting the output level.

Definition at line 141 of file CommonMessaging.h.

141 { return msgLevel(); }
MSG::Level msgLevel() const
get the output level from the embedded MsgStream
MsgStream& CommonMessagingBase::verbose ( ) const
inline

shortcut for the method msgStream(MSG::VERBOSE)

Definition at line 129 of file CommonMessaging.h.

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

120 { 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 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: