Forward declare. More...

#include <MonitorBase.h>

Inheritance diagram for MonitorBase:

Collaboration diagram for MonitorBase:

Public Member Functions
	MonitorBase ()=delete
	Forbid default constructor. More...

	MonitorBase (const std::string &name, const MonitoredRange *parent)
	Construct monitor. More...

virtual	~MonitorBase ()=default
	Default destructor. More...

MonitorBase &	operator= (const MonitorBase &)=delete
	Forbid assignment. More...

	MonitorBase (const MonitorBase &)=delete
	Forbid copy. More...

const std::string &	getName () const
	Getter for Monitor's name. More...

const MonitoredRange *	getParent () const
	Return cached non-owning const ptr to this Monitor's parent Range. More...

TH1 *	bookGetPointer (TH1 *hist, const std::string &tDir="") const
	Appends Monitor name (to histogram path) and forwards histogram book request to parent Range. More...

bool	counterExists (const std::string &name) const
	Check if a counter of a given name exists. More...

CounterBase *	getCounter (const std::string &name)
	Retrieve counter by name. More...

virtual StatusCode	newEvent (const CostData &data, float weight=1.)=0
	Pure virtual interface called by Range to instruct this Monitor to perform its analysis. More...

virtual StatusCode	endEvent (float weight=1.)
	Called by the framework. More...

MsgStream &	msg ()
	Logging. More...

MsgStream &	msg (const MSG::Level lvl)
	Logging on a given level. More...

bool	msgLvl (const MSG::Level lvl)
	Returns if requested level is same or higher than logging level. More...

Protected Member Functions
virtual std::unique_ptr< CounterBase >	newCounter (const std::string &name)=0
	Pure virtual Counter instantiation specialisation. More...

Protected Attributes
std::unordered_map< std::string, std::unique_ptr< CounterBase > >	m_counters
	Storage of Monitor's collection of Counters. More...

MsgStream	m_msgStream
	Logging member. More...

Private Attributes
const std::string	m_name
	Monitor's name. More...

const MonitoredRange *	m_parent
	Monitor's parent Range. More...

Detailed Description

Forward declare.

Base class for all "Monitor" objects, which maintain a collection of Counters of a given specialisation.

A Monitor is responsible for monitoring a specific feature of an event. It could be, monitoring all Chains, all ROS', all Algorithms, etc. It maintains an internal name-keyed map of Counters of a given specialisation and for a given event it loops over all instances of the feature it monitors and dispatches to the matching Counter objects.

Definition at line 33 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.h.

Constructor & Destructor Documentation

◆ MonitorBase() [1/3]

MonitorBase::MonitorBase ( )

delete

Forbid default constructor.

◆ MonitorBase() [2/3]

MonitorBase::MonitorBase	(	const std::string &	name,
		const MonitoredRange *	parent
	)

Construct monitor.

Parameters

[in]	name	Monitor's name
[in]	parent	Monitor's parent Range, cached non-owning pointer.

Definition at line 11 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.cxx.

                                                                             : 
   m_msgStream(nullptr, name.c_str()),
   m_name(name), 
   m_parent(parent) {
     m_msgStream.setMsgSvc(Athena::getMessageSvc());
 }

◆ ~MonitorBase()

virtual MonitorBase::~MonitorBase ( )

virtualdefault

Default destructor.

◆ MonitorBase() [3/3]

MonitorBase::MonitorBase ( const MonitorBase & )

delete

Forbid copy.

Member Function Documentation

◆ bookGetPointer()

TH1 * MonitorBase::bookGetPointer	(	TH1 *	hist,
		const std::string &	tDir = `""`
	)		const

Appends Monitor name (to histogram path) and forwards histogram book request to parent Range.

Parameters

[in]	hist	Bare pointer to histogram. Ownership transferred to THistSvc.
[in]	tDir	Histogram name & directory.

Returns: Cached pointer to histogram. Used to fill histogram without having to perform THishSvc lookup.

Definition at line 37 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.cxx.

                                                                        {
   std::string dir = getName();
   if (tDir != "") {
     dir += "/";
     dir += tDir;
   }
   return getParent()->bookGetPointer(hist, dir);
 }

◆ counterExists()

bool MonitorBase::counterExists ( const std::string & name ) const

Check if a counter of a given name exists.

Parameters

[in] name Name of Counter.

Returns: True if counter already exists.

Definition at line 47 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.cxx.

                                                            {
   return (m_counters.count(name) == 1);
 }

◆ endEvent()

StatusCode MonitorBase::endEvent ( float weight = 1. )

virtual

Called by the framework.

Causes per-Event Variables to fill their histograms with their accumulated data.

Definition at line 29 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.cxx.

                                              {
   for (auto& nameCounterPair : m_counters ) {
     ATH_CHECK( nameCounterPair.second->endEvent(weight) );
   }
   return StatusCode::SUCCESS;
 }

◆ getCounter()

CounterBase * MonitorBase::getCounter ( const std::string & name )

Retrieve counter by name.

If no such counter exists, a new one will be instanced and returned.

Parameters

[in] name Name of Counter.

Returns: Mutable base-class pointer to Counter.

Definition at line 52 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.cxx.

                                                           {
   auto it = m_counters.find(name);
   if (it != m_counters.end()) {
     return it->second.get();
   }
   // If no counter exists, then we make a new one on the fly & return it.
   auto result = m_counters.insert( std::make_pair(name, newCounter(name)) ); // newCounter is specialised
   it = result.first;
   return it->second.get();
 }

◆ getName()

const std::string & MonitorBase::getName ( ) const

Getter for Monitor's name.

Returns: Counter's name const string reference.

Definition at line 19 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.cxx.

                                             {
   return m_name;
 }

◆ getParent()

const MonitoredRange * MonitorBase::getParent ( ) const

Return cached non-owning const ptr to this Monitor's parent Range.

Returns: Cached pointer parent Range.

Definition at line 24 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.cxx.

                                                    {
   return m_parent;
 }

◆ msg() [1/2]

MsgStream & MonitorBase::msg ( )

Logging.

Returns: Message stream reference.

Definition at line 64 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.cxx.

                             {
   return m_msgStream;
 }

◆ msg() [2/2]

MsgStream & MonitorBase::msg ( const MSG::Level lvl )

Logging on a given level.

Parameters

[in] lvl Verbosity level

Returns: Message stream reference.

Definition at line 68 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.cxx.

                                               {
   return m_msgStream << lvl;
 }

◆ msgLvl()

bool MonitorBase::msgLvl ( const MSG::Level lvl )

Returns if requested level is same or higher than logging level.

Parameters

[in] lvl Verbosity level

Returns: If requested level is same or higher than logging level

Definition at line 72 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.cxx.

                                           {
   return lvl >= m_msgStream.level();
 }

◆ newCounter()

virtual std::unique_ptr<CounterBase> MonitorBase::newCounter ( const std::string & name )

protectedpure virtual

Pure virtual Counter instantiation specialisation.

Derived Monitor must instantiate a concrete Counter of the correct type for the Monitor and return it wrapped in an owning unique ptr.

Parameters

[in] name Name of Counter to mint.

Returns: Owning unique ptr object typed on the CounterBase base class which points to concrete Counter of specialised type.

Implemented in MonitorChain, MonitorSequence, MonitorAlgorithm, MonitorAlgorithmClass, MonitorChainAlgorithm, MonitorGlobal, MonitorROS, and MonitorThreadOccupancy.

◆ newEvent()

virtual StatusCode MonitorBase::newEvent	(	const CostData &	data,
		float	weight = `1.`
	)

pure virtual

Pure virtual interface called by Range to instruct this Monitor to perform its analysis.

Parameters

[in]	data	Access to event data
[in]	weight	Global event weight

Implemented in MonitorChain, MonitorSequence, MonitorAlgorithm, MonitorAlgorithmClass, MonitorChainAlgorithm, MonitorGlobal, MonitorROS, and MonitorThreadOccupancy.

◆ operator=()

MonitorBase& MonitorBase::operator= ( const MonitorBase & )

delete

Forbid assignment.

Member Data Documentation

◆ m_counters

std::unordered_map< std::string, std::unique_ptr<CounterBase> > MonitorBase::m_counters

protected

Storage of Monitor's collection of Counters.

Keyed by name.

Definition at line 138 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.h.

◆ m_msgStream

MsgStream MonitorBase::m_msgStream

protected

Logging member.

Definition at line 140 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.h.

◆ m_name

const std::string MonitorBase::m_name

private

Monitor's name.

Definition at line 144 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.h.

◆ m_parent

const MonitoredRange* MonitorBase::m_parent

private

Monitor's parent Range.

Cached non-owning const ptr.

Definition at line 145 of file Trigger/TrigCost/TrigCostAnalysis/src/MonitorBase.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MonitorBase() [1/3]

◆ MonitorBase() [2/3]

◆ ~MonitorBase()

◆ MonitorBase() [3/3]

Member Function Documentation

◆ bookGetPointer()

◆ counterExists()

◆ endEvent()

◆ getCounter()

◆ getName()

◆ getParent()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ newCounter()

◆ newEvent()

◆ operator=()

Member Data Documentation

◆ m_counters

◆ m_msgStream

◆ m_name

◆ m_parent