PackedLinkConstAccessor.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-2026 CERN for the benefit of the ATLAS collaboration.
 */
 
 
#ifndef ATHCONTAINERS_PACKEDLINKCONSTACCESSOR_H
#define ATHCONTAINERS_PACKEDLINKCONSTACCESSOR_H
 
 
#include "AthContainersInterfaces/AuxTypes.h"
#include "AthContainers/PackedLinkImpl.h"
#include "AthContainers/ConstAccessor.h"
#include "AthContainers/AuxElement.h"
#include "AthContainers/tools/AuxDataTraits.h"
#include "AthContainers/tools/AuxElementConcepts.h"
#include "AthContainers/tools/LinkedVarAccessorBase.h"
#include "AthContainers/tools/PackedLinkConversions.h"
#include "AthLinks/ElementLink.h"
#include "AthLinks/DataLink.h"
#include "CxxUtils/range_with_conv.h"
#include <iterator>
#include <ranges>
 
 
class IProxyDict;
 
 
namespace SG {
 

template <class CONT, class ALLOC>
class ConstAccessor<SG::PackedLink<CONT>, ALLOC>
  : public detail::LinkedVarAccessorBase
{
public:
  // Aliases for the types we're dealing with.
  using Link_t = ElementLink<CONT>;
  using PLink_t = SG::PackedLink<CONT>;
  using DLink_t = DataLink<CONT>;
  using DLinkAlloc_t = typename std::allocator_traits<ALLOC>::template rebind_alloc<DLink_t>;
 

  using const_PackedLink_span = typename AuxDataTraits<PackedLink<CONT>, ALLOC>::const_span;
  using const_DataLink_span = typename AuxDataTraits<DataLink<CONT>, DLinkAlloc_t>::const_span;
 

  using ConstConverter_t = detail::PackedLinkConstConverter<CONT>;
 

  using const_span = std::ranges::transform_view<const_PackedLink_span,
                                                 ConstConverter_t>;
 

  using element_type = Link_t;

  using const_reference_type = element_type;

  using const_container_pointer_type = void;
 

  ConstAccessor (const std::string& name);
 

  ConstAccessor (const std::string& name, const std::string& clsname);
 

  ConstAccessor (const SG::auxid_t auxid);
 

  template <IsConstAuxElement ELT>
  const Link_t operator() (const ELT& e) const;
 

  const Link_t
  operator() (const AuxVectorData& container, size_t index) const;
 

  const PLink_t*
  getPackedLinkArray (const AuxVectorData& container) const;
 

  const DLink_t*
  getDataLinkArray (const AuxVectorData& container) const;
 

  const_PackedLink_span
  getPackedLinkSpan (const AuxVectorData& container) const;
 

  const_DataLink_span
  getDataLinkSpan (const AuxVectorData& container) const;
 

  const_span
  getDataSpan (const AuxVectorData& container) const;
 
 
protected:
  ConstAccessor (const std::string& name,
                 const std::string& clsname,
                 const SG::AuxVarFlags flags);
 

  Link_t
  resolveLink (const AuxVectorData& container, size_t index) const;
};
 
 
//************************************************************************
 

template <class CONT, class ALLOC, class VALLOC>
class ConstAccessor<std::vector<SG::PackedLink<CONT>, VALLOC>, ALLOC>
  : public detail::LinkedVarAccessorBase
{
public:
  // Aliases for the types we're dealing with.
  using Link_t = ElementLink<CONT>;
  using PLink_t = SG::PackedLink<CONT>;
  using VElt_t = std::vector<SG::PackedLink<CONT>, VALLOC>;
  using DLink_t = DataLink<CONT>;
  using DLinkAlloc_t = typename std::allocator_traits<ALLOC>::template rebind_alloc<DLink_t>;

  using const_PackedLinkVector_span = typename AuxDataTraits<VElt_t, ALLOC>::const_span;
  using const_DataLink_span = typename AuxDataTraits<DataLink<CONT>, DLinkAlloc_t>::const_span;

  using const_PackedLink_span = typename AuxDataTraits<PackedLink<CONT>, VALLOC>::const_span;
 

  using ConstVectorTransform_t = detail::PackedLinkVectorConstConverter<CONT>;
  using const_elt_span = typename ConstVectorTransform_t::value_type;
 

  using const_span = std::ranges::transform_view<const_PackedLinkVector_span,
                                                 ConstVectorTransform_t>;
 

  using element_type = const_elt_span;

  using const_reference_type = element_type;

  using const_container_pointer_type = void;
 

  ConstAccessor (const std::string& name);
 

  ConstAccessor (const std::string& name, const std::string& clsname);
 

  ConstAccessor (const SG::auxid_t auxid);
 

  template <IsConstAuxElement ELT>
  const_elt_span operator() (const ELT& e) const;
 

  const_elt_span
  operator() (const AuxVectorData& container, size_t index) const;
 

  const VElt_t*
  getPackedLinkVectorArray (const AuxVectorData& container) const;
 

  const DLink_t*
  getDataLinkArray (const AuxVectorData& container) const;
 

  template <IsConstAuxElement ELT>
  const_PackedLink_span
  getPackedLinkSpan (const ELT& e) const;
 

  const_PackedLink_span
  getPackedLinkSpan (const AuxVectorData& container, size_t index) const;
 

  const_PackedLinkVector_span
  getPackedLinkVectorSpan (const AuxVectorData& container) const;
 

  const_DataLink_span
  getDataLinkSpan (const AuxVectorData& container) const;
 

  const_span
  getDataSpan (const AuxVectorData& container) const;
 
 
protected:
  ConstAccessor (const std::string& name,
                 const std::string& clsname,
                 const SG::AuxVarFlags flags);
};
 
 
} // namespace SG
 
 
#include "AthContainers/PackedLinkConstAccessor.icc"
 
 
#endif // not ATHCONTAINERS_PACKEDLINKCONSTACCESSOR_H