CP::SysFilterReporterCombiner Class Reference

a reporter class that combines the filter decisions for all systematics More...

#include <SysFilterReporterCombiner.h>

Inheritance diagram for CP::SysFilterReporterCombiner:

Collaboration diagram for CP::SysFilterReporterCombiner:

Public Member Functions
	SysFilterReporterCombiner (SysFilterReporterParams &val_params, bool val_passedDefault)
	standard constructor More...
	~SysFilterReporterCombiner () noexcept
	standard destructor More...
bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object. More...
MsgStream &	msg () const
	The standard message stream. More...
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...

Private Attributes
SysFilterReporterParams &	m_params
	the SysFilterReporterParams object More...
bool	m_passedDefault {false}
	the default value of passed we use for each individual reporter More...
bool	m_passedOne {false}
	whether we passed for at least one/all systematics More...
bool	m_passedAll {true}
std::function< MsgStream &()>	m_msg
	the message stream we use More...

Friends
class	SysFilterReporter

Detailed Description

a reporter class that combines the filter decisions for all systematics

Unlike the non-systematics aware version, when dealing with systematics we need to combine all the individual filter decisions into an overall filter decision for the algorithm, i.e. if and only if the filter decision fails for all systematics we should set filter to failed for the algorithm itself, so that we avoid/skip processing of subsequent algorithms. For details on usage see SysFilterReporter.

Definition at line 33 of file SysFilterReporterCombiner.h.

Constructor & Destructor Documentation

SysFilterReporterCombiner()

CP::SysFilterReporterCombiner::SysFilterReporterCombiner	(	SysFilterReporterParams &	val_params,
		bool	val_passedDefault
	)

standard constructor

Guarantee

strong

Failures

out of memory I

Definition at line 24 of file SysFilterReporterCombiner.cxx.

    : AsgMessagingForward (&val_params)
    , m_params (val_params)
    , m_passedDefault (val_passedDefault)
  {
    if (!m_params.m_isInitialized)
    {
      ANA_MSG_FATAL ("using uninitialized SysFilterReporterParams, throwing exception");
      throw std::logic_error ("using uninitialized SysFilterReporterParams");
    }
  }

~SysFilterReporterCombiner()

CP::SysFilterReporterCombiner::~SysFilterReporterCombiner ( )

noexcept

standard destructor

Guarantee

no-fail

Definition at line 40 of file SysFilterReporterCombiner.cxx.

  {
    ANA_MSG_DEBUG ("setting algorithm-filter-passed flag to " << m_passedOne);
    m_params.m_setFilterPassed (m_passedOne);
    m_params.m_total += 1;
    if (m_passedOne)
      m_params.m_passedOne += 1;
    if (m_passedAll)
      m_params.m_passedAll += 1;
  }

Member Function Documentation

msg() [1/2]

MsgStream & asg::AsgMessagingForward::msg ( ) const

inherited

The standard message stream.

Returns

A reference to the default message stream of this object.

Definition at line 24 of file AsgMessagingForward.cxx.

  {
    return m_msg();
  }

msg() [2/2]

MsgStream & asg::AsgMessagingForward::msg ( const MSG::Level  lvl ) const

inherited

The standard message stream.

Parameters

lvl	The message level to set the stream to

Returns

A reference to the default message stream, set to level "lvl"

Definition at line 29 of file AsgMessagingForward.cxx.

  {
    MsgStream& msg = m_msg ();
    msg << lvl;
    return msg;
  }

msgLvl()

bool asg::AsgMessagingForward::msgLvl ( const MSG::Level  lvl ) const

inherited

Test the output level of the object.

Parameters

lvl	The message level to test against

Returns

boolean Indicting if messages at given level will be printed

true If messages at level "lvl" will be printed

Definition at line 11 of file AsgMessagingForward.cxx.

  {
    MsgStream& msg = m_msg();
    if (msg.level() <= lvl)
    {
      msg << lvl;
      return true;
    } else
    {
      return false;
    }
  }

Friends And Related Function Documentation

SysFilterReporter

friend class SysFilterReporter

friend

Definition at line 63 of file SysFilterReporterCombiner.h.

Member Data Documentation

m_msg

std::function<MsgStream& ()> asg::AsgMessagingForward::m_msg

privateinherited

the message stream we use

This used to be a simple pointer to the MsgStream itself, but in AthenaMT the actual object used is local to the thread. So instead of pointing to it directly we are now using a function to look it up, which will get the thread-local object.

Definition at line 77 of file AsgMessagingForward.h.

m_params

SysFilterReporterParams& CP::SysFilterReporterCombiner::m_params

private

the SysFilterReporterParams object

Definition at line 67 of file SysFilterReporterCombiner.h.

m_passedAll

bool CP::SysFilterReporterCombiner::m_passedAll {true}

private

Definition at line 76 of file SysFilterReporterCombiner.h.

m_passedDefault

bool CP::SysFilterReporterCombiner::m_passedDefault {false}

private

the default value of passed we use for each individual reporter

Definition at line 71 of file SysFilterReporterCombiner.h.

m_passedOne

bool CP::SysFilterReporterCombiner::m_passedOne {false}

private

whether we passed for at least one/all systematics

Definition at line 75 of file SysFilterReporterCombiner.h.

---

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

• SysFilterReporterCombiner.h
• SysFilterReporterCombiner.cxx