#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 >:

[legend]

Public Member Functions
template<typename OWNER >
	MsgCounter (OWNER *o, std::string const &ms, int 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 More...

MsgStream &	print (MsgStream &os, bool tableFormat) const override

bool	toBePrinted () const override
	hint whether we should print that counter or not. More...

virtual nlohmann::json	toJSON () const override
	Basic JSON export for Gaudi::Monitoring::Hub support. More...

virtual std::ostream &	print (std::ostream &, bool tableFormat=false) const=0
	prints the counter to a stream More...

virtual MsgStream &	print (MsgStream &, bool tableFormat=true) const=0

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 More...

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

Public Member Functions inherited from Gaudi::Accumulators::PrintableCounter
	PrintableCounter ()=default

virtual	~PrintableCounter ()=default
	destructor More...

template<typename stream >
stream &	printImpl (stream &s, std::string_view tag) const

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 More...

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

std::string	toString () const
	get a string representation More...

Public Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< InputTypeT, InnerType, Atomicity, InputTransform, OutputTransform, ValueHandler >
GenericAccumulator	operator+= (const InputType by)

	GenericAccumulator ()=default

template<atomicity ato, typename VH >
	GenericAccumulator (construct_empty_t, const GenericAccumulator< InputType, InnerType, ato, InputTransform, OutputTransform, VH > &)
	constructor of an empty GenericAccumulator, copying the (non existent) config from another GenericAccumulator More...

template<typename... Args>
	GenericAccumulator (std::in_place_t, Args &&... args)

	GenericAccumulator (const GenericAccumulator &other)

GenericAccumulator &	operator= (const GenericAccumulator &other)

OutputType	value () const

void	reset ()

template<atomicity ato, typename VH >
void	mergeAndReset (GenericAccumulator< InputType, InnerType, ato, InputTransform, OutputTransform, VH > &&other)

template<atomicity ato, typename VH >
void	operator+ (GenericAccumulator< InputType, InnerType, ato, InputTransform, OutputTransform, 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
void	log ()

Private Attributes
Monitoring::Hub &	m_monitoringHub

const CommonMessagingBase *	logger { nullptr }

std::string	msg

unsigned long	max

Additional Inherited Members
Public Types inherited from Gaudi::Accumulators::GenericAccumulator< InputTypeT, InnerType, Atomicity, InputTransform, OutputTransform, ValueHandler >
using	InputType = InputTypeT

using	OutputType = std::decay_t< std::result_of_t< OutputTransform(InnerType)> >

using	InternalType = InnerType

using	JSONStringEntriesType = std::string

Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< InputTypeT, InnerType, Atomicity, InputTransform, OutputTransform, ValueHandler >
auto	rawValue () const

void	reset (InnerType in)

Static Protected Member Functions inherited from Gaudi::Accumulators::GenericAccumulator< InputTypeT, InnerType, Atomicity, InputTransform, OutputTransform, ValueHandler >
static InnerType	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 1115 of file Accumulators.h.

Constructor & Destructor Documentation

◆ MsgCounter() [1/2]

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

template<typename OWNER >

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

inline

Definition at line 1119 of file Accumulators.h.

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

◆ MsgCounter() [2/2]

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 1134 of file Accumulators.h.

1134 { m_monitoringHub.removeEntity( *this ); }

Member Function Documentation

◆ fromJSON()

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

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

inlinestatic

Definition at line 1151 of file Accumulators.h.

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

◆ log()

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

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

inlineprivate

Definition at line 1162 of file Accumulators.h.

                                      {
       if ( UNLIKELY( 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 1123 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 1127 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/6]

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

virtual MsgStream& Gaudi::Accumulators::PrintableCounter::print

◆ print() [2/6]

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

virtual MsgStream& Gaudi::Accumulators::PrintableCounter::print

inline

Definition at line 843 of file Accumulators.h.

843 { return printImpl( o, tag ); }

◆ print() [3/6]

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 1141 of file Accumulators.h.

1141 { return printImpl( os, tableFormat ); }

◆ print() [4/6]

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

virtual std::ostream& Gaudi::Accumulators::PrintableCounter::print

prints the counter to a stream

◆ print() [5/6]

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

virtual std::ostream& Gaudi::Accumulators::PrintableCounter::print

inline

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

Definition at line 842 of file Accumulators.h.

842 { return printImpl( o, tag ); }

◆ print() [6/6]

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

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

inlineoverridevirtual

prints the counter to a stream

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 1140 of file Accumulators.h.

1140 { 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 1136 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 1142 of file Accumulators.h.

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

◆ toJSON()

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

virtual nlohmann::json Gaudi::Accumulators::MsgCounter< level, Atomicity >::toJSON ( ) const

inlineoverridevirtual

Basic JSON export for Gaudi::Monitoring::Hub support.

Implements Gaudi::Accumulators::PrintableCounter.

Definition at line 1143 of file Accumulators.h.

                                                  {
       return { { "type", typeString },
                { "empty", this->value() == 0 },
                { "nEntries", this->value() },
                { "level", level },
                { "max", max },
                { "msg", 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 1159 of file Accumulators.h.

◆ m_monitoringHub

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

Monitoring::Hub& Gaudi::Accumulators::MsgCounter< level, Atomicity >::m_monitoringHub

private

Definition at line 1158 of file Accumulators.h.

◆ max

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

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

private

Definition at line 1161 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 1160 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 1117 of file Accumulators.h.

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

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ MsgCounter() [1/2]

◆ MsgCounter() [2/2]

◆ ~MsgCounter()

Member Function Documentation

◆ fromJSON()

◆ log()

◆ operator++()

◆ operator+=()

◆ operator=()

◆ print() [1/6]

◆ print() [2/6]

◆ print() [3/6]

◆ print() [4/6]

◆ print() [5/6]

◆ print() [6/6]

◆ printImpl()

◆ toBePrinted()

◆ toJSON()

Member Data Documentation

◆ logger

◆ m_monitoringHub

◆ max

◆ msg

◆ typeString

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