Gaudi::Accumulators::PrintableCounter Struct Reference

An empty ancester of all counters that knows how to print themselves. More...

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

Inheritance diagram for Gaudi::Accumulators::PrintableCounter:

Public Member Functions
	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 &, 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
virtual bool	toBePrinted () const
	hint whether we should print that counter or not. More...
std::string	toString () const
	get a string representation More...
virtual nlohmann::json	toJSON () const =0
	Basic JSON export for Gaudi::Monitoring::Hub support. More...

Detailed Description

An empty ancester of all counters that knows how to print themselves.

See also

Gaudi::Accumulators for detailed documentation

Definition at line 833 of file Accumulators.h.

Constructor & Destructor Documentation

PrintableCounter()

Gaudi::Accumulators::PrintableCounter::PrintableCounter ( )

default

~PrintableCounter()

virtual Gaudi::Accumulators::PrintableCounter::~PrintableCounter ( )

virtualdefault

destructor

Member Function Documentation

print() [1/4]

virtual MsgStream& Gaudi::Accumulators::PrintableCounter::print ( MsgStream &  , bool  tableFormat = true  ) const

pure virtual

Implemented in Gaudi::Accumulators::MsgCounter< level, Atomicity >, Gaudi::Accumulators::MsgCounter< MSG::ERROR >, Gaudi::Accumulators::MsgCounter< MSG::INFO >, Gaudi::Accumulators::MsgCounter< MSG::WARNING >, Gaudi::Accumulators::BinomialCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::StatCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::StatCounter< Unit >, Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::AveragingCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::AveragingCounter< std::size_t >, Gaudi::Accumulators::AveragingCounter< double, Gaudi::Accumulators::atomicity::none >, Gaudi::Accumulators::AveragingCounter< unsigned int >, Gaudi::Accumulators::Counter< Atomicity, Arithmetic >, Gaudi::Accumulators::Counter<>, Gaudi::Accumulators::HistogramingCounterBaseInternal< ND, Atomicity, Arithmetic, Type, Accumulator, std::index_sequence< NDs... > >, and StatEntity.

print() [2/4]

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

inlinevirtual

Reimplemented in Gaudi::Accumulators::BinomialCounter< Arithmetic, Atomicity >, and StatEntity.

Definition at line 848 of file Accumulators.h.

{ return printImpl( o, tag ); }

print() [3/4]

virtual std::ostream& Gaudi::Accumulators::PrintableCounter::print ( std::ostream &  , bool  tableFormat = false  ) const

pure virtual

prints the counter to a stream

Implemented in Gaudi::Accumulators::MsgCounter< level, Atomicity >, Gaudi::Accumulators::MsgCounter< MSG::ERROR >, Gaudi::Accumulators::MsgCounter< MSG::INFO >, Gaudi::Accumulators::MsgCounter< MSG::WARNING >, Gaudi::Accumulators::BinomialCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::StatCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::StatCounter< Unit >, Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::AveragingCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::AveragingCounter< std::size_t >, Gaudi::Accumulators::AveragingCounter< double, Gaudi::Accumulators::atomicity::none >, Gaudi::Accumulators::AveragingCounter< unsigned int >, Gaudi::Accumulators::Counter< Atomicity, Arithmetic >, Gaudi::Accumulators::Counter<>, Gaudi::Accumulators::HistogramingCounterBaseInternal< ND, Atomicity, Arithmetic, Type, Accumulator, std::index_sequence< NDs... > >, and StatEntity.

print() [4/4]

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 in Gaudi::Accumulators::BinomialCounter< Arithmetic, Atomicity >, and StatEntity.

Definition at line 847 of file Accumulators.h.

{ return printImpl( o, tag ); }

printImpl()

template<typename stream >

stream& Gaudi::Accumulators::PrintableCounter::printImpl ( stream &  s, std::string_view  tag  ) const

inline

Definition at line 839 of file Accumulators.h.

                                                             {
      s << boost::format{ " | %|-48.48s|%|50t|" } % ( std::string{ '\"' }.append( tag ).append( "\"" ) );
      return print( s, true );
    }

toBePrinted()

virtual bool Gaudi::Accumulators::PrintableCounter::toBePrinted ( ) const

inlinevirtual

hint whether we should print that counter or not.

Typically empty counters may not be printed

Reimplemented in Gaudi::Accumulators::MsgCounter< level, Atomicity >, Gaudi::Accumulators::BinomialCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::StatCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::AveragingCounter< Arithmetic, Atomicity >, and Gaudi::Accumulators::Counter< Atomicity, Arithmetic >.

Definition at line 851 of file Accumulators.h.

{ return true; }

toJSON()

virtual nlohmann::json Gaudi::Accumulators::PrintableCounter::toJSON ( ) const

pure virtual

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

Implemented in Gaudi::Accumulators::MsgCounter< level, Atomicity >, Gaudi::Accumulators::BinomialCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::StatCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::SigmaCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::AveragingCounter< Arithmetic, Atomicity >, Gaudi::Accumulators::Counter< Atomicity, Arithmetic >, Gaudi::Accumulators::HistogramingCounterBaseInternal< ND, Atomicity, Arithmetic, Type, Accumulator, std::index_sequence< NDs... > >, and StatEntity.

toString()

std::string Gaudi::Accumulators::PrintableCounter::toString ( ) const

inline

get a string representation

Definition at line 853 of file Accumulators.h.

                               {
      std::ostringstream ost;
      print( ost );
      return ost.str();
    }

---

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

• GaudiKernel/include/Gaudi/Accumulators.h