MonitoredRange Class Reference

Container which represents a time range and holds a collection of Monitors which monitor this range. More...

#include <MonitoredRange.h>

Collaboration diagram for MonitoredRange:

Public Member Functions
	MonitoredRange ()=delete
	Forbid default constructor. More...
	MonitoredRange (const std::string &name, TrigCostAnalysis *parent)
	Construct Range. More...
	~MonitoredRange ()=default
	Default destructor. More...
MonitoredRange &	operator= (const MonitoredRange &)=delete
	Forbid assignment. More...
	MonitoredRange (const MonitoredRange &)=delete
	Forbid copy. More...
const std::string &	getName () const
	Getter for Range's name. More...
const TrigCostAnalysis *	getParent () const
	Return cached non-owning ptr to this Monitor's parent TrigCostAnalysis Athena algorithm. More...
TH1 *	bookGetPointer (TH1 *hist, const std::string &tDir="") const
	Appends Range's name (to histogram path) and forwards histogram book request to parent Athena algorithm. More...
std::set< std::unique_ptr< MonitorBase > > &	getMonitors ()
	Getter for Range's owned Monitors. More...
StatusCode	addMonitor (std::unique_ptr< MonitorBase > monitor)
	Adds a new Monitor into this Range. More...
StatusCode	newEvent (const CostData &data, const float weight=1., const bool skipMonitoringThisEvent=false)
	Interface called by TrigCostAnalysis algorithm to instruct this Range to trigger all its Monitors. More...

Private Attributes
const std::string	m_name
	Name of the Monitored Range. More...
TrigCostAnalysis *	m_parent
	Cached ptr to the parent Athena algorithm. More...
TH1 *	m_cachedLifetimeHistPtr
	Cached histogram ptr used to store normalisation quantities. More...
std::set< std::unique_ptr< MonitorBase > >	m_monitors
	Storage of Range's Monitors. More...
std::set< uint32_t >	m_seenLB
	Luminosity blocks for which we have seen at least one event. More...

Detailed Description

Container which represents a time range and holds a collection of Monitors which monitor this range.

A job is configured to use a suite of Monitors. However, we also want to separate different regions of the run via lumi block splitting. This class represents one such time interval and hosts a complete set of Monitors which are used to monitor the time range.

Definition at line 29 of file MonitoredRange.h.

Constructor & Destructor Documentation

MonitoredRange() [1/3]

MonitoredRange::MonitoredRange ( )

delete

Forbid default constructor.

MonitoredRange() [2/3]

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

Construct Range.

Range constructor sets up a histogram which is used to keep track of normalisation quantities.

Parameters

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

Definition at line 11 of file MonitoredRange.cxx.

                                                                              : 
  m_name(name),
  m_parent(parent),
  m_cachedLifetimeHistPtr(nullptr),
  m_monitors(),
  m_seenLB()
{
  std::string hisSvcName = getName() + "_walltime";
  std::unique_ptr<TProfile> hist = std::make_unique<TProfile>(hisSvcName.c_str(), "Walltime;;Seconds", 5000, 0, 5000);
  m_cachedLifetimeHistPtr = bookGetPointer(hist.release()); // Now owned by HistSvc
}

~MonitoredRange()

MonitoredRange::~MonitoredRange ( )

default

Default destructor.

MonitoredRange() [3/3]

MonitoredRange::MonitoredRange ( const MonitoredRange &  )

delete

Forbid copy.

Member Function Documentation

addMonitor()

StatusCode MonitoredRange::addMonitor

(

std::unique_ptr< MonitorBase >

monitor

)

Adds a new Monitor into this Range.

@pram[in] Owning unique ptr of new Monitor to add. Typed on Monitor's base class.

Definition at line 49 of file MonitoredRange.cxx.

                                                                        {
  m_monitors.insert( std::move(monitor) );
  return StatusCode::SUCCESS;
}

bookGetPointer()

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

Appends Range's name (to histogram path) and forwards histogram book request to parent Athena algorithm.

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 34 of file MonitoredRange.cxx.

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

getMonitors()

std::set< std::unique_ptr< MonitorBase > > & MonitoredRange::getMonitors

(

)

Getter for Range's owned Monitors.

Returns

Set reference to Range's Monitors

Definition at line 44 of file MonitoredRange.cxx.

                                                                  {
  return m_monitors;
}

getName()

const std::string & MonitoredRange::getName

(

)

const

Getter for Range's name.

Returns

Range's name const string reference.

Definition at line 24 of file MonitoredRange.cxx.

                                               {
  return m_name;
}

getParent()

const TrigCostAnalysis * MonitoredRange::getParent

(

)

const

Return cached non-owning ptr to this Monitor's parent TrigCostAnalysis Athena algorithm.

Returns

Cached pointer to parent TrigCostAnalysis algorithm.

Definition at line 29 of file MonitoredRange.cxx.

                                                        {
  return m_parent;
}

newEvent()

StatusCode MonitoredRange::newEvent	(	const CostData &	data,
		const float	weight = 1.,
		const bool	skipMonitoringThisEvent = false
	)

Interface called by TrigCostAnalysis algorithm to instruct this Range to trigger all its Monitors.

Parameters

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

Definition at line 55 of file MonitoredRange.cxx.

                                                                                                                {
  if (not skipMonitoringThisEvent) {
    for (auto& monitor : getMonitors()) {
      ATH_CHECK(monitor->newEvent(data, weight));
      ATH_CHECK(monitor->endEvent(weight));
    }
  }
  ATH_CHECK(m_cachedLifetimeHistPtr != nullptr);
  const bool isNewLB = m_seenLB.insert( data.lb() ).second; // .second is true if a new element was inserted
  if (data.liveTimeIsPerEvent() or isNewLB) {
    // We have two modes of operation. Either we process an EnhancedBias file where we know exactly how many events to expect
    // and can hence fill a per-event live time (meaning that the normalisation is correct, even if we do not run over all events).
    // For this case we increment this bin for event event this monitor sees.
    // Or, we can process P1 data where we only know the LB length and must assume that all events are collected and processed,
    // otherwise the normalisation will be off. For this case we increment this one for every unique LB this monitor sees.
    m_cachedLifetimeHistPtr->Fill(data.lb(), data.liveTime());
  }
  
  return StatusCode::SUCCESS;
}

operator=()

MonitoredRange& MonitoredRange::operator= ( const MonitoredRange &  )

delete

Forbid assignment.

Member Data Documentation

m_cachedLifetimeHistPtr

TH1* MonitoredRange::m_cachedLifetimeHistPtr

private

Cached histogram ptr used to store normalisation quantities.

Definition at line 103 of file MonitoredRange.h.

m_monitors

std::set< std::unique_ptr<MonitorBase> > MonitoredRange::m_monitors

private

Storage of Range's Monitors.

Keyed by Monitor's name.

Definition at line 104 of file MonitoredRange.h.

m_name

const std::string MonitoredRange::m_name

private

Name of the Monitored Range.

Definition at line 101 of file MonitoredRange.h.

m_parent

TrigCostAnalysis* MonitoredRange::m_parent

private

Cached ptr to the parent Athena algorithm.

Definition at line 102 of file MonitoredRange.h.

m_seenLB

std::set< uint32_t > MonitoredRange::m_seenLB

private

Luminosity blocks for which we have seen at least one event.

Definition at line 105 of file MonitoredRange.h.

---

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

• MonitoredRange.h
• MonitoredRange.cxx