StoreGate/StoreGate/ReadDecorHandle.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_READDECORHANDLE_H
#define STOREGATE_READDECORHANDLE_H
 
 
#include "StoreGate/ReadDecorHandleKey.h"
#include "StoreGate/ReadHandle.h"
#include "StoreGate/DecorKeyHelpers.h"
#include "AthContainers/AuxElement.h"
#include "GaudiKernel/EventContext.h"
#include <type_traits>
 
 
namespace SG {
 

template <class T, class D>
class ReadDecorHandle
  : public ReadHandle<T>
{
public:
  using Base = ReadHandle<T>;

  using accessor_t = SG::AuxElement::ConstAccessor<D>;

  using const_reference_type = typename accessor_t::const_reference_type;

  using const_container_pointer_type = typename accessor_t::const_container_pointer_type;

  using const_span = typename accessor_t::const_span;
 

  explicit ReadDecorHandle (const ReadDecorHandleKey<T>& key);
 

  explicit ReadDecorHandle (const ReadDecorHandleKey<T>& key,
                            const EventContext& ctx);
 
 
  // Disallow initialization from a temporary Key object.
  explicit ReadDecorHandle (SG::ReadDecorHandleKey<T>&& key) = delete; // Not allowed from a temporary.
  explicit ReadDecorHandle (SG::ReadDecorHandleKey<T>&& key, 
                            const EventContext& ctx) = delete; // Not allowed from a temporary.
 

  ReadDecorHandle (const ReadDecorHandle& rhs);
 

  ReadDecorHandle (ReadDecorHandle&& rhs);
 

  ReadDecorHandle& operator= (const ReadDecorHandle& rhs);
 

  ReadDecorHandle& operator= (ReadDecorHandle&& rhs);
 
  
  bool isPresent() const;
 

  const_reference_type operator() (const AuxElement& e) const;
 

  const_reference_type withDefault (size_t index, const D& deflt);
 

  const_reference_type withDefault (const AuxElement& e, const D& deflt) const;
 

  const_reference_type operator() (size_t index);
 

  template <class POINTER_TYPE = const_container_pointer_type>
  requires (!std::is_void_v<POINTER_TYPE>)
  POINTER_TYPE
  getDataArray();
 

  const_span
  getDataSpan();
 

  bool isAvailable();
 

  SG::auxid_t auxid() const;
 

  const std::string& decorKey() const;
 
  
private:
  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;
};
 

template <class D, class T>
ReadDecorHandle<T, D> makeHandle (const ReadDecorHandleKey<T>& key);
 

template <class D, class T>
ReadDecorHandle<T, D> makeHandle (const ReadDecorHandleKey<T>& key,
                                  const EventContext& ctx);
 

template <class T>
void makeHandle (const ReadDecorHandleKey<T>& key);
template <class T>
void makeHandle (const ReadDecorHandleKey<T>& key,
                 const EventContext& ctx);
 
 
} // namespace SG
 
 
#include "StoreGate/ReadDecorHandle.icc"
 
 
#endif // not STOREGATE_READDECORHANDLE_READDECORHANDLE_H