#include </builds/gaudi/Gaudi/GaudiKernel/include/Gaudi/Accumulators.h>

Inheritance diagram for Gaudi::Accumulators::MsgCounter< level, Atomicity >:

Collaboration diagram for Gaudi::Accumulators::MsgCounter< level, Atomicity >:

Public Member Functions
template<typename OWNER>
	MsgCounter (OWNER *o, std::string const &ms, unsigned long nMax=10)
MsgCounter &	operator++ ()
MsgCounter &	operator+= (const bool by)
	MsgCounter (MsgCounter const &)=delete
MsgCounter &	operator= (MsgCounter const &)=delete
	~MsgCounter ()
template<typename stream>
stream &	printImpl (stream &o, bool tableFormat) const
std::ostream &	print (std::ostream &os, bool tableFormat) const override
	prints the counter to a stream
MsgStream &	print (MsgStream &os, bool tableFormat) const override
bool	toBePrinted () const override
	hint whether we should print that counter or not.
virtual std::ostream &	print (std::ostream &o, std::string_view tag) const
	prints the counter to a stream in table format, with the given tag
virtual MsgStream &	print (MsgStream &o, std::string_view tag) const
Public Member Functions inherited from Gaudi::Accumulators::PrintableCounter
	PrintableCounter ()=default
virtual	~PrintableCounter ()=default
	destructor
template<typename stream>
stream &	printImpl (stream &s, std::string_view tag) const
std::string	toString () const
	get a string representation
Public Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< bool, unsigned long, Atomicity, Identity, Identity, Handler< Atomicity > >
GenericAccumulator	operator+= (const InputType by)
	GenericAccumulator ()=default
	GenericAccumulator (construct_empty_t, const GenericAccumulator< InputType, unsigned long, ato, Identity, Identity, VH > &)
	constructor of an empty GenericAccumulator, copying the (non existent) config from another GenericAccumulator
	GenericAccumulator (std::in_place_t, Args &&... args)
	GenericAccumulator (const GenericAccumulator &other)
GenericAccumulator &	operator= (const GenericAccumulator &other)
OutputType	value () const
void	reset ()
void	mergeAndReset (GenericAccumulator< InputType, unsigned long, ato, Identity, Identity, VH > &other)
void	operator+ (GenericAccumulator< InputType, unsigned long, ato, Identity, Identity, VH > &&other)

Static Public Member Functions
static MsgCounter	fromJSON (const nlohmann::json &j)

Static Public Attributes
static const std::string	typeString { "counter:MsgCounter" }

Private Member Functions
	MsgCounter (std::string const &ms, unsigned long nMax, unsigned long count)
void	log ()

Private Attributes
Monitoring::Hub *	m_monitoringHub { nullptr }
const CommonMessagingBase *	logger { nullptr }
std::string	msg
unsigned long	max

Friends
void	reset (MsgCounter &c)
void	mergeAndReset (MsgCounter &c, MsgCounter &o)
void	to_json (nlohmann::json &j, MsgCounter const &c)

Additional Inherited Members
Public Types inherited from Gaudi::Accumulators::GenericAccumulator< bool, unsigned long, Atomicity, Identity, Identity, Handler< Atomicity > >
using	InputType
using	OutputType
using	InternalType
using	JSONStringEntriesType
Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< bool, unsigned long, Atomicity, Identity, Identity, Handler< Atomicity > >
	GenericAccumulator (unsigned long in)
auto	rawValue () const
void	reset (unsigned long in)
Static Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< bool, unsigned long, Atomicity, Identity, Identity, Handler< Atomicity > >
static unsigned long	extractJSONData (const nlohmann::json &j, const JSONStringEntriesType &entries)

Detailed Description

template<MSG::Level level, atomicity Atomicity = atomicity::full>
class Gaudi::Accumulators::MsgCounter< level, Atomicity >

Definition at line 1192 of file Accumulators.h.

Constructor & Destructor Documentation

◆ MsgCounter() [1/3]

template<MSG::Level level, atomicity Atomicity = atomicity::full>

template<typename OWNER>

Gaudi::Accumulators::MsgCounter< level, Atomicity >::MsgCounter	(	OWNER *	o,
		std::string const &	ms,
		unsigned long	nMax = 10 )

inline

Definition at line 1196 of file Accumulators.h.

        : m_monitoringHub{ &o->serviceLocator()->monitoringHub() }, logger( o ), msg( ms ), max( nMax ) {
      m_monitoringHub->registerEntity( o->name(), ms, typeString, *this );
    }

◆ MsgCounter() [2/3]

template<MSG::Level level, atomicity Atomicity = atomicity::full>

Gaudi::Accumulators::MsgCounter< level, Atomicity >::MsgCounter ( MsgCounter< level, Atomicity > const & )

delete

◆ ~MsgCounter()

template<MSG::Level level, atomicity Atomicity = atomicity::full>

Gaudi::Accumulators::MsgCounter< level, Atomicity >::~MsgCounter ( )

inline

Definition at line 1211 of file Accumulators.h.

                  {
      if ( m_monitoringHub ) m_monitoringHub->removeEntity( *this );
    }

◆ MsgCounter() [3/3]

template<MSG::Level level, atomicity Atomicity = atomicity::full>

Gaudi::Accumulators::MsgCounter< level, Atomicity >::MsgCounter	(	std::string const &	ms,
		unsigned long	nMax,
		unsigned long	count )

inlineprivate

Definition at line 1235 of file Accumulators.h.

1236 : details::MsgCounter::MsgAccumulator<Atomicity>{ count }, msg( ms ), max( nMax ) {}

Member Function Documentation

◆ fromJSON()

template<MSG::Level level, atomicity Atomicity = atomicity::full>

MsgCounter Gaudi::Accumulators::MsgCounter< level, Atomicity >::fromJSON ( const nlohmann::json & j )

inlinestatic

Definition at line 1229 of file Accumulators.h.

                                                        {
      return { j.at( "msg" ).get<std::string>(), j.at( "max" ).get<unsigned long>(),
               j.at( "nEntries" ).get<unsigned long>() };
    }

◆ log()

template<MSG::Level level, atomicity Atomicity = atomicity::full>

void Gaudi::Accumulators::MsgCounter< level, Atomicity >::log ( )

inlineprivate

Definition at line 1242 of file Accumulators.h.

                                     {
      if ( this->value() <= max && logger ) {
        if ( this->value() == max ) {
          logger->msgStream( level ) << "Suppressing message: " << std::quoted( msg, '\'' ) << endmsg;
        } else {
          logger->msgStream( level ) << msg << endmsg;
        }
      }
    }

◆ operator++()

template<MSG::Level level, atomicity Atomicity = atomicity::full>

MsgCounter & Gaudi::Accumulators::MsgCounter< level, Atomicity >::operator++ ( )

inline

Definition at line 1200 of file Accumulators.h.

                             {
      ( *this ) += true;
      return *this;
    }

◆ operator+=()

template<MSG::Level level, atomicity Atomicity = atomicity::full>

MsgCounter & Gaudi::Accumulators::MsgCounter< level, Atomicity >::operator+= ( const bool by )

inline

Definition at line 1204 of file Accumulators.h.

                                          {
      details::MsgCounter::MsgAccumulator<Atomicity>::operator+=( by );
      if ( by ) log();
      return *this;
    }

◆ operator=()

template<MSG::Level level, atomicity Atomicity = atomicity::full>

MsgCounter & Gaudi::Accumulators::MsgCounter< level, Atomicity >::operator= ( MsgCounter< level, Atomicity > const & )

delete

◆ print() [1/4]

template<MSG::Level level, atomicity Atomicity = atomicity::full>

virtual MsgStream & Gaudi::Accumulators::PrintableCounter::print	(	MsgStream &	o,
		std::string_view	tag ) const

inlinevirtual

Reimplemented from Gaudi::Accumulators::PrintableCounter.

Definition at line 906 of file Accumulators.h.

906{ return printImpl( o, tag ); }

Gaudi::Accumulators::MsgCounter::printImpl

stream & printImpl(stream &o, bool tableFormat) const

Definition Accumulators.h:1215

◆ print() [2/4]

template<MSG::Level level, atomicity Atomicity = atomicity::full>

MsgStream & Gaudi::Accumulators::MsgCounter< level, Atomicity >::print	(	MsgStream &	os,
		bool	tableFormat ) const

inlineoverridevirtual

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 1220 of file Accumulators.h.

1220{ return printImpl( os, tableFormat ); }

◆ print() [3/4]

template<MSG::Level level, atomicity Atomicity = atomicity::full>

virtual std::ostream & Gaudi::Accumulators::PrintableCounter::print	(	std::ostream &	o,
		std::string_view	tag ) const

inlinevirtual

prints the counter to a stream in table format, with the given tag

Reimplemented from Gaudi::Accumulators::PrintableCounter.

Definition at line 905 of file Accumulators.h.

905{ return printImpl( o, tag ); }

◆ print() [4/4]

template<MSG::Level level, atomicity Atomicity = atomicity::full>

std::ostream & Gaudi::Accumulators::MsgCounter< level, Atomicity >::print	(	std::ostream &	os,
		bool	tableFormat ) const

inlineoverridevirtual

prints the counter to a stream

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 1219 of file Accumulators.h.

1219{ return printImpl( os, tableFormat ); }

◆ printImpl()

template<MSG::Level level, atomicity Atomicity = atomicity::full>

template<typename stream>

stream & Gaudi::Accumulators::MsgCounter< level, Atomicity >::printImpl	(	stream &	o,
		bool	tableFormat ) const

inline

Definition at line 1215 of file Accumulators.h.

                                                           {
      return o << boost::format{ tableFormat ? "|%|10d| |" : "#=%|-7lu|" } % this->value();
    }

◆ toBePrinted()

template<MSG::Level level, atomicity Atomicity = atomicity::full>

bool Gaudi::Accumulators::MsgCounter< level, Atomicity >::toBePrinted ( ) const

inlineoverridevirtual

hint whether we should print that counter or not.

Typically empty counters may not be printed

Reimplemented from Gaudi::Accumulators::PrintableCounter.

Definition at line 1221 of file Accumulators.h.

1221{ return this->value() > 0; }

◆ mergeAndReset

template<MSG::Level level, atomicity Atomicity = atomicity::full>

void mergeAndReset	(	MsgCounter< level, Atomicity > &	c,
		MsgCounter< level, Atomicity > &	o )

friend

Definition at line 1223 of file Accumulators.h.

1223{ c.mergeAndReset( o ); }

Gaudi::Accumulators::MsgCounter::mergeAndReset

friend void mergeAndReset(MsgCounter &c, MsgCounter &o)

Definition Accumulators.h:1223

◆ reset

template<MSG::Level level, atomicity Atomicity = atomicity::full>

void reset ( MsgCounter< level, Atomicity > & c )

friend

Definition at line 1222 of file Accumulators.h.

1222{ c.reset(); }

Gaudi::Accumulators::MsgCounter::reset

friend void reset(MsgCounter &c)

Definition Accumulators.h:1222

◆ to_json

template<MSG::Level level, atomicity Atomicity = atomicity::full>

void to_json	(	nlohmann::json &	j,
		MsgCounter< level, Atomicity > const &	c )

friend

Definition at line 1224 of file Accumulators.h.

                                                                  {
      j = { { "type", c.typeString },  { "empty", c.value() == 0 },
              { "nEntries", c.value() }, { "level", level },
              { "max", c.max },          { "msg", c.msg } };
    }

Member Data Documentation

◆ logger

template<MSG::Level level, atomicity Atomicity = atomicity::full>

const CommonMessagingBase* Gaudi::Accumulators::MsgCounter< level, Atomicity >::logger { nullptr }

private

Definition at line 1239 of file Accumulators.h.

1239{ nullptr };

◆ m_monitoringHub

template<MSG::Level level, atomicity Atomicity = atomicity::full>

Monitoring::Hub* Gaudi::Accumulators::MsgCounter< level, Atomicity >::m_monitoringHub { nullptr }

private

Definition at line 1238 of file Accumulators.h.

1238{ nullptr };

◆ max

template<MSG::Level level, atomicity Atomicity = atomicity::full>

unsigned long Gaudi::Accumulators::MsgCounter< level, Atomicity >::max

private

Definition at line 1241 of file Accumulators.h.

◆ msg

template<MSG::Level level, atomicity Atomicity = atomicity::full>

std::string Gaudi::Accumulators::MsgCounter< level, Atomicity >::msg

private

Definition at line 1240 of file Accumulators.h.

◆ typeString

template<MSG::Level level, atomicity Atomicity = atomicity::full>

const std::string Gaudi::Accumulators::MsgCounter< level, Atomicity >::typeString { "counter:MsgCounter" }

inlinestatic

Definition at line 1194 of file Accumulators.h.

1194{ "counter:MsgCounter" };

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

GaudiKernel/include/Gaudi/Accumulators.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MsgCounter() [1/3]

◆ MsgCounter() [2/3]

◆ ~MsgCounter()

◆ MsgCounter() [3/3]

Member Function Documentation

◆ fromJSON()

◆ log()

◆ operator++()

◆ operator+=()

◆ operator=()

◆ print() [1/4]

◆ print() [2/4]

◆ print() [3/4]

◆ print() [4/4]

◆ printImpl()

◆ toBePrinted()

Friends And Related Symbol Documentation

◆ mergeAndReset

◆ reset

◆ to_json

Member Data Documentation

◆ logger

◆ m_monitoringHub

◆ max

◆ msg

◆ typeString