AthToolSupport/AsgDataHandles/AsgDataHandles/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-2020 CERN for the benefit of the ATLAS collaboration.
 */
 
#ifndef ASG_DATA_HANDLES_WRITE_DECOR_HANDLE_KEY_H
#define ASG_DATA_HANDLES_WRITE_DECOR_HANDLE_KEY_H
 
#ifndef XAOD_STANDALONE
#include <StoreGate/WriteDecorHandleKey.h>
#else
 
 
#include "AsgDataHandles/DecorKeyHelpers.h"
#include "AsgDataHandles/ReadHandleKey.h"
#include "AsgDataHandles/WriteHandleKey.h"
 
 
// class AthAlgorithm;
// class AthReentrantAlgorithm;
// class AthAlgTool;
 
 
namespace SG {
 
 
/*
 * @brief Property holding a SG store/key/clid/attr name from which a
 *        WriteDecorHandle is made.
 *
 * See StoreGate/WriteDecorHandleKey for details.
 *
 * This currently (24 Aug 20) contains a number of commented out
 * members that were part of the original handle implementation, but
 * have not yet been implemented in the standalone version.  The plan
 * is to either implement or remove them, depending on what is needed
 * in AnalysisBase as we add more packages.
 *
 */
template <class T>
class WriteDecorHandleKey
  : public WriteHandleKey<T>
{
public:
  typedef WriteHandleKey<T> Base;
 
  
  explicit WriteDecorHandleKey (const std::string& key = ""/*,
                                                    const std::string& storeName = StoreID::storeName(StoreID::EVENT_STORE)*/);
 
 
  template <class OWNER, class K>
  WriteDecorHandleKey (OWNER* owner,
                       const std::string& name,
                       const K& key = {},
                       const std::string& doc = "");
 
 
  WriteDecorHandleKey& operator= (const std::string& sgkey);
 
 
  virtual StatusCode assign (const std::string& sgkey) override;
 
  
  StatusCode initialize (bool used = true);
 
 
  const ReadHandleKey<T>& contHandleKey() const;
 
 
// private:
//   friend class ::AthAlgorithm;
//   friend class ::AthReentrantAlgorithm;
//   friend class ::AthAlgTool;
 
//   /**
//    * @brief Return the handle key for the container.
//    *
//    * Should be used only by AthAlgorithm/AthAlgTool.
//    */
//   ReadHandleKey<T>& contHandleKey_nc();
 
 
  ReadHandleKey<T> m_contHandleKey;
};
 
 
} // namespace SG
 
 
#include "AsgDataHandles/WriteDecorHandleKey.icc"
 
#endif
 
#endif