StoreGate/StoreGate/WriteDecorHandle.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_WRITEDECORHANDLE_H
#define STOREGATE_WRITEDECORHANDLE_H
 
 
#include "StoreGate/WriteDecorHandleKey.h"
#include "StoreGate/ReadHandle.h"
#include "StoreGate/DecorKeyHelpers.h"
#include "AthContainers/AuxElement.h"
#include "CxxUtils/bitmask.h"
#include "GaudiKernel/EventContext.h"
#include <type_traits>
 
 
namespace SG {
 
 
template <class T, class D>
class WriteDecorHandle
  : public ReadHandle<T>
{
public:
  using Base = ReadHandle<T>;
 
  using accessor_t = SG::AuxElement::Decorator<D>;
 
  using reference_type = typename accessor_t::reference_type;
 
  using container_pointer_type = typename accessor_t::container_pointer_type;
 
  using span = typename accessor_t::span;
 
 
  explicit WriteDecorHandle (const WriteDecorHandleKey<T>& key);
 
 
  explicit WriteDecorHandle (const WriteDecorHandleKey<T>& key,
                             const EventContext& ctx);
 
 
  // Disallow initialization from a temporary Key object.
  explicit WriteDecorHandle (SG::WriteDecorHandleKey<T>&& key) = delete; // Not allowed from a temporary.
  explicit WriteDecorHandle (SG::WriteDecorHandleKey<T>&& key, 
                             const EventContext& ctx) = delete; // Not allowed from a temporary.
 
 
  WriteDecorHandle (const WriteDecorHandle& rhs);
 
 
  WriteDecorHandle (WriteDecorHandle&& rhs);
 
 
  ~WriteDecorHandle();
 
 
  WriteDecorHandle& operator= (const WriteDecorHandle& rhs);
 
 
  WriteDecorHandle& operator= (WriteDecorHandle&& rhs);
 
 
  bool isPresent() const;
 
 
  virtual StatusCode setProxyDict (IProxyDict* store) override;
 
  
  reference_type operator() (const AuxElement& e);
 
 
  reference_type operator() (size_t index);
 
 
  template <class POINTER_TYPE = container_pointer_type,
            typename = std::enable_if_t<!std::is_void_v<POINTER_TYPE> > >
  POINTER_TYPE
  getDecorationArray();
 
 
  span
  getDecorationSpan();
 
 
  bool isAvailable();
 
 
  SG::auxid_t auxid() const;
 
 
  Gaudi::DataHandle::Mode mode() const;
 
 
  const std::string& decorKey() const;
 
  
private:
  void makeDecor (const AuxVectorData* avd);
 
 
  const SG::AuxVectorData* vectorData (std::true_type);
 
 
  const SG::AuxVectorData* vectorData (std::false_type);
 
 
  const SG::AuxVectorData* vectorData();
 
 
  std::string m_decorKey;
 
  accessor_t m_acc;
 
  bool m_renounced;
 
  bool m_decorated;
};
 
 
template <class D, class T>
WriteDecorHandle<T, D> makeHandle (const WriteDecorHandleKey<T>& key);
 
 
template <class D, class T>
WriteDecorHandle<T, D> makeHandle (const WriteDecorHandleKey<T>& key,
                                   const EventContext& ctx);
 
 
template <class T>
void makeHandle (const WriteDecorHandleKey<T>& key);
template <class T>
void makeHandle (const WriteDecorHandleKey<T>& key,
                 const EventContext& ctx);
 
 
} // namespace SG
 
 
#include "StoreGate/WriteDecorHandle.icc"
 
 
#endif // not STOREGATE_WRITEDECORHANDLE_WRITEDECORHANDLE_H