OutOfValidityHelper.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/

 
 
#ifndef SELECTION_HELPERS__OUT_OF_VALIDITY_HELPER_H
#define SELECTION_HELPERS__OUT_OF_VALIDITY_HELPER_H
 
#include <AsgMessaging/AsgMessagingForward.h>
#include <AthContainers/AuxElement.h>
#include <SelectionHelpers/ISelectionWriteAccessor.h>
#include <SelectionHelpers/ISelectionReadAccessor.h>
#include <xAODBase/IParticle.h>
#include <memory>
 
class StatusCode;
 
namespace CP
{
  class CorrectionCode;
 

 
  enum class OutOfValidityAction
  {
    ABORT,

    WARNING,

    SILENT
  };
 
 

 
  class OutOfValidityHelper final : public asg::AsgMessagingForward
  {
  public:
    template<typename T>
    OutOfValidityHelper (T *owner, const std::string& propertyName = "outOfValidity",
                         const std::string& propertyDescription = "how to handle out of validity results");
 

  public:
    ::StatusCode initialize ();

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

  public:
    bool get (const xAOD::IParticle& particle) const;

  private:
    unsigned m_action {unsigned (OutOfValidityAction::ABORT)};

  private:
    std::unique_ptr<ISelectionWriteAccessor> m_write_accessor;
    std::unique_ptr<ISelectionReadAccessor> m_read_accessor;

  private:
    std::string m_decorationName;

  private:
    bool m_isInitialized = false;
  };
 
 
 
  template<typename T> OutOfValidityHelper ::
  OutOfValidityHelper (T *owner, const std::string& propertyName,
                       const std::string& propertyDescription)
    : asg::AsgMessagingForward (owner)
  {
    owner->declareProperty (propertyName, m_action,
                            propertyDescription);
    owner->declareProperty (propertyName + "Deco", m_decorationName,
                            "decoration to set alongside action described by " + propertyName);
  }
}

#define ANA_CHECK_CORRECTION(helper,object,expr)                \
  { if ((helper).check ((object), (expr), #expr).isFailure()) [[unlikely]] \
      return StatusCode::FAILURE; }
 
#endif