| The Gaudi Framework v30r0 (c919700c)

- 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
MSG::Level | setUpMessaging ()
| Set up local caches. More...
MSG::Level | resetMessaging ()
| Reinitialize internal states. More...
void | updateMsgStreamOutputLevel (int level)
| Update the output level of the cached MsgStream. More...

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

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

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

## Member Function Documentation

template<typename BASE>

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

cold functionality

Implements CommonMessagingBase.

Definition at line 162 of file CommonMessaging.h.

162 { m_msgStream.reset( new MsgStream( msgSvc(), this->name() ) ); }
MsgStream
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:32
CommonMessagingBase::m_msgStream
boost::thread_specific_ptr< MsgStream > m_msgStream
The predefined message stream.
Definition: CommonMessaging.h:143
CommonMessagingBase::msgSvc
const SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
Definition: CommonMessaging.h:75
template<typename BASE>

MSG::Level CommonMessaging< BASE >::resetMessaging | ( |  | ) |
| inline protected

Reinitialize internal states.

Definition at line 181 of file CommonMessaging.h.

182 {
183 m_commonMessagingReady = false;
184 return setUpMessaging();
185 }
CommonMessagingBase::m_commonMessagingReady
bool m_commonMessagingReady
Definition: CommonMessaging.h:140
CommonMessaging::setUpMessaging
MSG::Level setUpMessaging()
Set up local caches.
Definition: CommonMessaging.h:166
template<typename BASE>

MSG::Level CommonMessaging< BASE >::setUpMessaging | ( |  | ) |
| inline protected

Set up local caches.

Definition at line 166 of file CommonMessaging.h.

167 {
168 if ( !m_commonMessagingReady ) {
169 if ( !m_msgsvc ) {
170 // Get default implementation of the message service.
171 m_msgsvc = this->serviceLocator();
172 }
173 create_msgStream();
174 m_level = MSG::Level( m_msgStream.get() ? m_msgStream->level() : MSG::NIL );
175 // if we could not get a MessageSvc, we should try again the initial set up
176 m_commonMessagingReady = m_msgsvc;
177 }
178 return m_level;
179 }
CommonMessagingBase::m_commonMessagingReady
bool m_commonMessagingReady
Definition: CommonMessaging.h:140
CommonMessagingBase::m_msgsvc
SmartIF< IMessageSvc > m_msgsvc
Pointer to the message service;.
Definition: CommonMessaging.h:148
MSG::Level
Level
Definition: IMessageSvc.h:16
CommonMessagingBase::m_level
MSG::Level m_level
Definition: CommonMessaging.h:145
MSG::NIL
Definition: IMessageSvc.h:16
CommonMessagingBase::m_msgStream
boost::thread_specific_ptr< MsgStream > m_msgStream
The predefined message stream.
Definition: CommonMessaging.h:143
CommonMessaging::create_msgStream
void create_msgStream() const override final
cold functionality
Definition: CommonMessaging.h:162
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 188 of file CommonMessaging.h.

189 {
190 setUpMessaging();
191 if ( level != MSG::NIL && level != m_level ) {
192 if ( msgSvc() ) {
193 msgSvc()->setOutputLevel( this->name(), level );
194 }
195 if ( m_msgStream.get() ) m_msgStream->setLevel( level );
196 if ( UNLIKELY( MSG::Level( level ) <= MSG::DEBUG ) )
197 debug() << "Property update for OutputLevel : new value = " << level << endmsg;
198 m_level = MSG::Level( level );
199 }
200 }
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
MSG::Level m_level
Definition: CommonMessaging.h:145
MSG::NIL
Definition: IMessageSvc.h:16
CommonMessagingBase::m_msgStream
boost::thread_specific_ptr< MsgStream > m_msgStream
The predefined message stream.
Definition: CommonMessaging.h:143
CommonMessagingBase::msgSvc
const SmartIF< IMessageSvc > & msgSvc() const
The standard message service.
Definition: CommonMessaging.h:75
CommonMessagingBase::debug
MsgStream & debug() const
shortcut for the method msgStream(MSG::DEBUG)
Definition: CommonMessaging.h:115
gaudirun.level
level
Definition: gaudirun.py:271
CommonMessaging::setUpMessaging
MSG::Level setUpMessaging()
Set up local caches.
Definition: CommonMessaging.h:166
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