StoreGate/StoreGate/ReadDecorHandleKey.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_READDECORHANDLEKEY_H
#define STOREGATE_READDECORHANDLEKEY_H
 
 
#include "StoreGate/ReadHandleKey.h"
#include "AthenaKernel/TopBase.h"
#include <concepts>
 
 
namespace SG {
 

template <class T>
class ReadDecorHandleKey
  : public ReadHandleKey<T>
{
public:
  typedef ReadHandleKey<T> Base;
 
  constexpr static bool isDecorHandleKey = true;

  typedef typename SG::TopBase<T>::type topbase_t;
 

  explicit
  ReadDecorHandleKey (const std::string& key = "",
                      const std::string& storeName = StoreID::storeName(StoreID::EVENT_STORE));

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

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

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

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

  virtual StatusCode assign (const std::string& sgkey) override;
 
  
  CLID clid() const;
 

  StatusCode initialize (bool used = true);
 

  const ReadHandleKey<T>& contHandleKey() const;
 
 
private:
  virtual std::string pythonRepr() const override;
 

  ReadHandleKey<T> m_contHandleKey;

  const VarHandleKey* m_contKey{nullptr};
};
 
 
} // namespace SG
 
 
#include "StoreGate/ReadDecorHandleKey.icc"
 
 
#endif // not STOREGATE_READDECORHANDLEKEY_H