FilterReporter Class Reference

a guard class for use with ref FilterReporterParams More...

#include <FilterReporter.h>

Collaboration diagram for FilterReporter:

Public Member Functions
	FilterReporter (FilterReporterParams &val_params, bool val_passedDefault)
	standard constructor More...
	FilterReporter (const FilterReporterParams &val_params, bool val_passedDefault, const EventContext &val_eventContext)
	standard re-entrant constructor More...
	~FilterReporter () noexcept
	standard destructor More...
void	setPassed (bool val_passed=true) noexcept
	report the filter decision More...

Private Attributes
const FilterReporterParams &	m_params
	the FilterReporterParams object More...
bool	m_passed {false}
	the value of passed we will set More...
const EventContext *	m_eventContext {}
	current EventContext reference More...

Detailed Description

a guard class for use with ref FilterReporterParams

In order to ensure that the filter decision will always be set as part of execute(), this guard class should be used like this:

StatusCode Foo::execute()
{
  ...
  static constexpr bool DEFAULT_DECISION = false;
  FilterReporter filter (m_filterParams, DEFAULT_DECISION);
  ...
  filter.setPassed ();
  return StatusCode::SUCCESS;
}

Definition at line 34 of file FilterReporter.h.

Constructor & Destructor Documentation

FilterReporter() [1/2]

FilterReporter::FilterReporter	(	FilterReporterParams &	val_params,
		bool	val_passedDefault
	)

standard constructor

Guarantee

strong

Failures

out of memory I

Author

Nils Krumnack

Tadej Novak

Definition at line 25 of file FilterReporter.cxx.

  : m_params (val_params)
  , m_passed (val_passedDefault)
  , m_eventContext (&Gaudi::Hive::currentContext())
{
  if (!m_params.m_isInitialized)
  {
    throw std::logic_error ("using uninitialized FilterReporterParams");
  }
}

FilterReporter() [2/2]

FilterReporter::FilterReporter	(	const FilterReporterParams &	val_params,
		bool	val_passedDefault,
		const EventContext &	val_eventContext
	)

standard re-entrant constructor

Guarantee

strong

Failures

out of memory I

Definition at line 40 of file FilterReporter.cxx.

  : m_params (val_params)
  , m_passed (val_passedDefault)
  , m_eventContext (&val_eventContext)
{
  if (!m_params.m_isInitialized)
  {
    throw std::logic_error ("using uninitialized FilterReporterParams");
  }
}

~FilterReporter()

FilterReporter::~FilterReporter ( )

noexcept

standard destructor

Guarantee

no-fail

Definition at line 56 of file FilterReporter.cxx.

{
  m_params.m_setFilterPassed (m_passed, m_eventContext);
 
  if (m_passed)
    m_params.m_passed += 1;
  m_params.m_total += 1;
 
#ifndef XAOD_STANDALONE
  if (m_passed && m_params.m_cutID != 0)
  {
    SG::ReadHandle<xAOD::EventInfo> evtInfo (m_params.m_eventInfoKey, *m_eventContext);
    // Only try to access the mcEventWeight if we are running on Monte Carlo
    if (evtInfo.isValid() && evtInfo->eventType(xAOD::EventInfo::IS_SIMULATION)) {
      m_params.m_cutFlowSvc->addEvent (m_params.m_cutID, evtInfo->mcEventWeights());
    } else {
      m_params.m_cutFlowSvc->addEvent (m_params.m_cutID, 1.0);
    }
  }
#endif
}

Member Function Documentation

setPassed()

void FilterReporter::setPassed ( bool  val_passed = true )

noexcept

report the filter decision

Guarantee

no-fail

Definition at line 81 of file FilterReporter.cxx.

{
  m_passed = val_passed;
}

Member Data Documentation

m_eventContext

const EventContext* FilterReporter::m_eventContext {}

private

current EventContext reference

Definition at line 89 of file FilterReporter.h.

m_params

const FilterReporterParams& FilterReporter::m_params

private

the FilterReporterParams object

Definition at line 81 of file FilterReporter.h.

m_passed

bool FilterReporter::m_passed {false}

private

the value of passed we will set

Definition at line 85 of file FilterReporter.h.

---

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

• FilterReporter.h
• FilterReporter.cxx