Concrete implementation of Monitor to monitor all sequences in an event. More...

#include <MonitorSequence.h>

Inheritance diagram for MonitorSequence:

Collaboration diagram for MonitorSequence:

Public Member Functions
	MonitorSequence ()=delete
	Forbid default constructor.
	MonitorSequence (const std::string &name, const MonitoredRange *parent)
	Construct monitor.
virtual	~MonitorSequence ()=default
	Default destructor.
MonitorSequence &	operator= (const MonitorSequence &)=delete
	Forbid assignment.
	MonitorSequence (const MonitorSequence &)=delete
	Forbid copy.
virtual StatusCode	newEvent (const CostData &data, const float weight=1.) override
	Concrete dispatch method.
virtual std::unique_ptr< CounterBase >	newCounter (const std::string &name) override
	Concrete counter instantiation.
const std::string &	getName () const
	Getter for Monitor's name.
const MonitoredRange *	getParent () const
	Return cached non-owning const ptr to this Monitor's parent Range.
TH1 *	bookGetPointer (TH1 *hist, const std::string &tDir="") const
	Appends Monitor name (to histogram path) and forwards histogram book request to parent Range.
bool	counterExists (const std::string &name) const
	Check if a counter of a given name exists.
CounterBase *	getCounter (const std::string &name)
	Retrieve counter by name.
virtual StatusCode	endEvent (float weight=1.)
	Called by the framework.
MsgStream &	msg ()
	Logging.
MsgStream &	msg (const MSG::Level lvl)
	Logging on a given level.
bool	msgLvl (const MSG::Level lvl)
	Returns if requested level is same or higher than logging level.

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

Private Attributes
const std::string	m_name
	Monitor's name.
const MonitoredRange *	m_parent
	Monitor's parent Range.

Detailed Description

Concrete implementation of Monitor to monitor all sequences in an event.

Definition at line 15 of file MonitorSequence.h.

Constructor & Destructor Documentation

◆ MonitorSequence() [1/3]

MonitorSequence::MonitorSequence ( )

delete

Forbid default constructor.

◆ MonitorSequence() [2/3]

MonitorSequence::MonitorSequence	(	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 8 of file MonitorSequence.cxx.

9 : MonitorBase(name, parent) {

10}

MonitorBase::MonitorBase

MonitorBase()=delete

Forbid default constructor.

◆ ~MonitorSequence()

virtual MonitorSequence::~MonitorSequence ( )

virtualdefault

Default destructor.

◆ MonitorSequence() [3/3]

MonitorSequence::MonitorSequence ( const MonitorSequence & )

delete

Forbid copy.

Member Function Documentation

◆ bookGetPointer()

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

inherited

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

inherited

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

virtualinherited

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 )

inherited

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

inherited

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

inherited

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 ( )

inherited

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 )

inherited

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 )

inherited

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()

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

overridevirtual

Concrete counter instantiation.

Mints named counter of CounterSequence type.

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.

Implements MonitorBase.

Definition at line 24 of file MonitorSequence.cxx.

                                                                            {
  return std::make_unique<CounterSequence>(name, this);
} 

◆ newEvent()

StatusCode MonitorSequence::newEvent	(	const CostData &	data,
		const float	weight = 1. )

overridevirtual

Concrete dispatch method.

Iterate over all Algorithms in event data and dispatch to owned Counters

Parameters

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

Implements MonitorBase.

Definition at line 12 of file MonitorSequence.cxx.

                                                                             {
  for (const auto& sequencePair : data.sequencersMap()) {
    if (sequencePair.first.empty()) continue;
    for (const auto& viewAlgsPair : sequencePair.second){
      ATH_CHECK( getCounter(sequencePair.first)->newEvent(data, viewAlgsPair.first, weight) );
    }
  }
 
  return StatusCode::SUCCESS;
}

◆ operator=()

MonitorSequence & MonitorSequence::operator= ( const MonitorSequence & )

delete

Forbid assignment.

Member Data Documentation

◆ m_counters

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

protectedinherited

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

protectedinherited

Logging member.

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

◆ m_name

const std::string MonitorBase::m_name

privateinherited

Monitor's name.

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

◆ m_parent

const MonitoredRange* MonitorBase::m_parent

privateinherited

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 Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MonitorSequence() [1/3]

◆ MonitorSequence() [2/3]

◆ ~MonitorSequence()

◆ MonitorSequence() [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