StoreGate/StoreGate/WriteDecorHandleKey.h

Go to the documentation of this file.

// This file's extension implies that it's C, but it's really -*- C++ -*-.
/*
 * Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration.
 */
 
 
#ifndef STOREGATE_WRITEDECORHANDLEKEY_H
#define STOREGATE_WRITEDECORHANDLEKEY_H
 
 
#include "StoreGate/WriteHandleKey.h"
#include "StoreGate/ReadHandleKey.h"
#include <concepts>
 
 
class AthAlgorithm;
class AthReentrantAlgorithm;
class AthAlgTool;
 
 
namespace SG {
 

template <class T>
class WriteDecorHandleKey
  : public WriteHandleKey<T>
{
public:
  typedef WriteHandleKey<T> Base;
 
 
  constexpr static bool isDecorHandleKey = true;
 
  
  explicit
  WriteDecorHandleKey (const std::string& key = "",
                       const std::string& storeName = StoreID::storeName(StoreID::EVENT_STORE));
 

  explicit
  WriteDecorHandleKey (const VarHandleKey& contKey,
                       const std::string& decorKey = "",
                       const std::string& storeName = StoreID::storeName(StoreID::EVENT_STORE));
 

  template <std::derived_from<IProperty> OWNER>
  WriteDecorHandleKey( OWNER* owner,
                      const std::string& name,
                      const std::string& key = {},
                      const std::string& doc = "");

  template <std::derived_from<IProperty> OWNER>
  WriteDecorHandleKey( OWNER* owner,
                      const std::string& name,
                      const VarHandleKey& contKey,
                      const std::string& decorKey = {},
                      const std::string& doc = "");
 

  WriteDecorHandleKey& operator= (const std::string& sgkey);
 

  virtual StatusCode assign (const std::string& sgkey) override;
 
  
  StatusCode initialize (bool used = true);
 

  StatusCode initialize (AllowEmptyEnum);
 

  const ReadHandleKey<T>& contHandleKey() const;
 

  void renounce();
 

  bool renounced() const;
 
 
private:
  friend class ::AthAlgorithm;
  friend class ::AthReentrantAlgorithm;
  friend class ::AthAlgTool;

  virtual std::string pythonRepr() const override;

  ReadHandleKey<T>& contHandleKey_nc();

  ReadHandleKey<T> m_contHandleKey;

  const VarHandleKey* m_contKey = nullptr;

  bool m_renounced = false;
};
 
 
} // namespace SG
 
 
#include "StoreGate/WriteDecorHandleKey.icc"
 
 
#endif // not STOREGATE_WRITEDECORHANDLEKEY_H