SysWriteDecorHandle.h

Go to the documentation of this file.

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

 
 
#ifndef SYSTEMATICS_HANDLES__SYS_WRITE_DECOR_HANDLE_H
#define SYSTEMATICS_HANDLES__SYS_WRITE_DECOR_HANDLE_H
 
#include <AnaAlgorithm/AnaAlgorithm.h>
#include <AsgDataHandles/VarHandleKey.h>
#include <AsgMessaging/AsgMessagingForward.h>
#include <AthContainers/AuxElement.h>
#include <PATInterfaces/SystematicSet.h>
#include <SystematicsHandles/ISysHandleBase.h>
#include <SystematicsHandles/SysListHandle.h>
#include <SystematicsHandles/SysHandleArray.h>
#include <string>
#include <type_traits>
#include <unordered_map>
 
class StatusCode;
 
namespace CP
{
  class SystematicSet;

  constexpr float invalidScaleFactor () {return -1;}

  constexpr float invalidEfficiency () {return -1;}
 

 
  template<typename T> class SysWriteDecorHandle final
    : public ISysHandleBase, public asg::AsgMessagingForward
  {
    //
    // public interface
    //

  public:
    template<typename T2>
    SysWriteDecorHandle (T2 *owner, const std::string& propertyName,
                             const std::string& propertyValue,
                             const std::string& propertyDescription);

    template<typename T2>
    SysWriteDecorHandle (const std::string& decorName, T2 *owner);

  public:
    virtual bool empty () const noexcept override;

  public:
    explicit operator bool () const noexcept;
 

  public:
    StatusCode initialize (SysListHandle& sysListHandle, ISysObjectHandleBase& objectHandle);
    StatusCode initialize (SysListHandle& sysListHandle, ISysObjectHandleBase& objectHandle, SG::AllowEmptyEnum);
 

  public:
    const std::string& getName (const CP::SystematicSet& sys) const;

  public:
    const std::string& getDecorName () const noexcept;
 

  public:
    void set (const SG::AuxElement& object, const T& value,
              const CP::SystematicSet& sys) const;

  public:
    void lock (const SG::AuxElement& object,
               const CP::SystematicSet& sys) const;
 
 
 
    //
    // inherited interface
    //
 
  private:
    virtual CP::SystematicSet
    getInputAffecting (const ISystematicsSvc& svc) const override;
    virtual StatusCode
    fillSystematics (const ISystematicsSvc& svc,
                     const CP::SystematicSet& fullAffecting,
                     const std::vector<CP::SystematicSet>& sysList) override;
 
 
 
    //
    // private interface
    //

  private:
    std::string m_decorName;

  private:
    ISysObjectHandleBase *m_objectHandle {nullptr};

  private:
    std::unordered_map<CP::SystematicSet,std::tuple<std::string,SG::Decorator<T> > > m_dataCache;

  private:
    const auto&
    getData (const CP::SystematicSet& sys) const;
  };
 
  template <typename T>
  using SysWriteDecorHandleArray = SysHandleArray<SysWriteDecorHandle<T>>;
}
 
#include "SysWriteDecorHandle.icc"
 
#endif