CP::OutOfValidityHelper Class Reference

a helper to translate a CP::CorrectionCode into a ::StatusCode More...

#include <OutOfValidityHelper.h>

Inheritance diagram for CP::OutOfValidityHelper:

Collaboration diagram for CP::OutOfValidityHelper:

Public Member Functions
template<typename T >
	OutOfValidityHelper (T *owner, const std::string &propertyName="outOfValidity", const std::string &propertyDescription="how to handle out of validity results")
	standard constructor More...
::StatusCode	initialize ()
	standard initialize More...
::StatusCode	check (const xAOD::IParticle &particle, const CP::CorrectionCode &code, const char *context) const
	check the correction code and do the proper thing More...
bool	get (const xAOD::IParticle &particle) const
	retrieve the OutOfValidity decision, where true = particle passes validity check 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
unsigned	m_action {unsigned (OutOfValidityAction::ABORT)}
	the action to take More...
std::unique_ptr< ISelectionWriteAccessor >	m_write_accessor
	the accessor if we apply one More...
std::unique_ptr< ISelectionReadAccessor >	m_read_accessor
std::string	m_decorationName
	the decoration name we use (if we have one) More...
bool	m_isInitialized = false
	whether we have been initialized More...
std::function< MsgStream &()>	m_msg
	the message stream we use More...

Detailed Description

a helper to translate a CP::CorrectionCode into a ::StatusCode

The prolem is OutOfValidityRange which does not have an equivalent in StatusCode and which does not have a unique, correct handling in all situations. This helper allows to configure a variety of behaviors via properties.

Definition at line 72 of file OutOfValidityHelper.h.

Constructor & Destructor Documentation

OutOfValidityHelper()

template<typename T >

CP::OutOfValidityHelper::OutOfValidityHelper	(	T *	owner,
		const std::string &	propertyName = "outOfValidity",
		const std::string &	propertyDescription = "how to handle out of validity results"
	)

standard constructor

Definition at line 119 of file OutOfValidityHelper.h.

    : asg::AsgMessagingForward (owner)
  {
    owner->declareProperty (propertyName, m_action,
                            propertyDescription);
    owner->declareProperty (propertyName + "Deco", m_decorationName,
                            "decoration to set alongside action described by " + propertyName);
  }

Member Function Documentation

check()

StatusCode CP::OutOfValidityHelper::check	(	const xAOD::IParticle &	particle,
		const CP::CorrectionCode &	code,
		const char *	context
	)		const

check the correction code and do the proper thing

Definition at line 38 of file OutOfValidityHelper.cxx.

  {
    assert (m_isInitialized);
 
    switch (code)
    {
    case CP::CorrectionCode::Ok:
      if (m_write_accessor) m_write_accessor->setBool (particle, true);
      return StatusCode::SUCCESS;
    case CP::CorrectionCode::Error:
      return StatusCode::FAILURE;
    case CP::CorrectionCode::OutOfValidityRange:
      if (m_write_accessor) m_write_accessor->setBool (particle, false);
      switch (OutOfValidityAction (m_action))
      {
      case OutOfValidityAction::ABORT:
        ANA_MSG_ERROR ("encountered OutOfValidity: " << context);
        return StatusCode::FAILURE;
      case OutOfValidityAction::WARNING:
        ANA_MSG_WARNING ("encountered OutOfValidity: " << context);
        return StatusCode::SUCCESS;
      case OutOfValidityAction::SILENT:
        return StatusCode::SUCCESS;
      }
    }
    ANA_MSG_ERROR (__FILE__ << ":" << __LINE__ << ": invalid enum value encountered " << code << " " << int (m_action));
    return StatusCode::FAILURE;
  }

get()

bool CP::OutOfValidityHelper::get

(

const xAOD::IParticle &

particle

)

const

retrieve the OutOfValidity decision, where true = particle passes validity check

Definition at line 70 of file OutOfValidityHelper.cxx.

                                            {
    return m_read_accessor->getBool(particle);
  }

initialize()

StatusCode CP::OutOfValidityHelper::initialize

(

)

standard initialize

Definition at line 24 of file OutOfValidityHelper.cxx.

  {
    if (!m_decorationName.empty())
    {
      ANA_CHECK (makeSelectionWriteAccessor (m_decorationName, m_write_accessor));
      ANA_CHECK (makeSelectionReadAccessor (m_decorationName, m_read_accessor));
    }
      
    m_isInitialized = true;
    return StatusCode::SUCCESS;
  }

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;
    }
  }

Member Data Documentation

m_action

unsigned CP::OutOfValidityHelper::m_action {unsigned (OutOfValidityAction::ABORT)}

private

the action to take

Definition at line 97 of file OutOfValidityHelper.h.

m_decorationName

std::string CP::OutOfValidityHelper::m_decorationName

private

the decoration name we use (if we have one)

Definition at line 106 of file OutOfValidityHelper.h.

m_isInitialized

bool CP::OutOfValidityHelper::m_isInitialized = false

private

whether we have been initialized

This is only used in debug mode to indicate a programming fault. Otherwise it is too easy for users to forget to initialize this object.

Definition at line 114 of file OutOfValidityHelper.h.

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_read_accessor

std::unique_ptr<ISelectionReadAccessor> CP::OutOfValidityHelper::m_read_accessor

private

Definition at line 102 of file OutOfValidityHelper.h.

m_write_accessor

std::unique_ptr<ISelectionWriteAccessor> CP::OutOfValidityHelper::m_write_accessor

private

the accessor if we apply one

Definition at line 101 of file OutOfValidityHelper.h.

---

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

• OutOfValidityHelper.h
• OutOfValidityHelper.cxx