| The Gaudi Framework v29r0 (ff2e7097)

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Protected Member Functions | Private Member Functions | List of all members
CommonMessaging< BASE > Class Template Reference

`#include <GaudiKernel/CommonMessaging.h>`

Inheritance diagram for CommonMessaging< BASE >:
[legend]
Collaboration diagram for CommonMessaging< BASE >:
[legend]

## Public Types
using | base_class = CommonMessaging

## Protected Member Functions
void | updateMsgStreamOutputLevel (int level)
| Update the output level of the cached MsgStream. More...

## Private Member Functions
void | create_msgSvc () const override final
| cold functionality More...
void | create_msgStream () const override final

## Additional Inherited Members
Public Member Functions inherited from CommonMessagingBase
virtual | ~CommonMessagingBase ()=default
| Virtual destructor. More...
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...
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...

## Detailed Description

### template<typename BASE>
class CommonMessaging< BASE >

Definition at line 62 of file CommonMessaging.h.

## Member Typedef Documentation

template<typename BASE>

using CommonMessaging< BASE >::base_class = CommonMessaging

Definition at line 162 of file CommonMessaging.h.

## Member Function Documentation

template<typename BASE>

void CommonMessaging< BASE >::create_msgStream | ( |  | ) | const
| inline final override private virtual

Implements CommonMessagingBase.

Definition at line 174 of file CommonMessaging.h.

175 {
176 auto& ms = msgSvc();
177 m_msgStream.reset( new MsgStream( ms, this->name() ) );
178 m_level.reset( new MSG::Level( m_msgStream.get() ? m_msgStream->level() : MSG::NIL ) );
179 }
MsgStream
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:32
BrunelScenarioForwardScheduler.ms
ms
Definition: BrunelScenarioForwardScheduler.py:130
MSG::Level
Level
Definition: IMessageSvc.h:16
CommonMessagingBase::m_level
boost::thread_specific_ptr< MSG::Level > m_level
Definition: CommonMessaging.h:152
MSG::NIL
Definition: IMessageSvc.h:16
CommonMessagingBase::m_msgStream
boost::thread_specific_ptr< MsgStream > m_msgStream
The predefined message stream.
Definition: CommonMessaging.h:149
CommonMessagingBase::msgSvc
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
Definition: CommonMessaging.h:76
template<typename BASE>

void CommonMessaging< BASE >::create_msgSvc | ( |  | ) | const
| inline final override private virtual

cold functionality

Implements CommonMessagingBase.

Definition at line 169 of file CommonMessaging.h.

170 {
171 // Get default implementation of the message service.
172 m_msgsvc = this->serviceLocator();
173 }
CommonMessagingBase::m_msgsvc
SmartIF< IMessageSvc > m_msgsvc
Pointer to the message service;.
Definition: CommonMessaging.h:155
template<typename BASE>

void CommonMessaging< BASE >::updateMsgStreamOutputLevel | ( | int | level | ) |
| inline protected

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

185 {
186 if ( !m_msgStream.get() ) {
187 create_msgStream();
188 }
189 if ( level != MSG::NIL && level != *m_level ) {
190 if ( msgSvc() ) {
191 msgSvc()->setOutputLevel( this->name(), level );
192 }
193 if ( m_msgStream.get() ) m_msgStream->setLevel( level );
194 if ( UNLIKELY( MSG::Level( level ) <= MSG::DEBUG ) )
195 debug() << "Property update for OutputLevel : new value = " << level << endmsg;
196 *m_level = MSG::Level( level );
197 }
198 }
UNLIKELY
#define UNLIKELY(x)
Definition: Kernel.h:128
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:32
MSG::DEBUG
Definition: IMessageSvc.h:16
MSG::Level
Level
Definition: IMessageSvc.h:16
CommonMessagingBase::m_level
boost::thread_specific_ptr< MSG::Level > m_level
Definition: CommonMessaging.h:152
MSG::NIL
Definition: IMessageSvc.h:16
CommonMessagingBase::m_msgStream
boost::thread_specific_ptr< MsgStream > m_msgStream
The predefined message stream.
Definition: CommonMessaging.h:149
CommonMessaging::create_msgStream
void create_msgStream() const override final
Definition: CommonMessaging.h:174
CommonMessagingBase::debug
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
Definition: CommonMessaging.h:120
CommonMessagingBase::msgSvc
SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
Definition: CommonMessaging.h:76
gaudirun.level
level
Definition: gaudirun.py:271
endmsg
MsgStream & endmsg(MsgStream &s)
MsgStream Modifier: endmsg. Calls the output method of the MsgStream.
Definition: MsgStream.h:209
IMessageSvc::setOutputLevel
virtual void setOutputLevel(int new_level)=0
Set new global output level threshold.

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

- GaudiKernel/GaudiKernel/CommonMessaging.h