JaggedVecDecorator.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_JAGGEDVECDECORATOR_H
#define ATHCONTAINERS_JAGGEDVECDECORATOR_H
 
 
#include "AthContainersInterfaces/AuxTypes.h"
#include "AthContainersInterfaces/IAuxElement.h"
#include "AthContainers/Decorator.h"
#include "AthContainers/JaggedVecConstAccessor.h"
#include "AthContainers/JaggedVecImpl.h"
#include "AthContainers/tools/JaggedVecVectorFactory.h"
#include "AthContainers/AuxVectorData.h"
#include "AthContainers/AuxTypeRegistry.h"
#include "AthContainers/tools/AuxElementConcepts.h"
#include "AthContainers/tools/JaggedVecConversions.h"
#include "CxxUtils/ranges.h"
#include "CxxUtils/checker_macros.h"
#include "CxxUtils/range_with_at.h"
#include "CxxUtils/range_with_conv.h"
#include <string>
#include <typeinfo>
#include <iterator>
 
 
namespace SG {
 

template <class PAYLOAD_T, class ALLOC>
class Decorator<JaggedVecElt<PAYLOAD_T>, ALLOC>
  : public detail::LinkedVarAccessorBase
{
public:
  using Payload_t = PAYLOAD_T;

  using PayloadAlloc_t = typename std::allocator_traits<ALLOC>::template rebind_alloc<Payload_t>;

  using Elt_t = SG::JaggedVecElt<PAYLOAD_T>;

  using JVecProxy = detail::JaggedVecProxyT<Payload_t, detail::JaggedVecProxyValBase>;
  using JVecProxyInSpan = detail::JaggedVecProxyT<Payload_t, detail::JaggedVecProxyRefBase>;

  using Converter_t = detail::JaggedVecConverter<Payload_t>;
  
  using ConstConverter_t = detail::JaggedVecConstConverter<Payload_t>;

  using const_Elt_span = typename AuxDataTraits<JaggedVecElt<Payload_t>, ALLOC>::const_span;
  using const_Payload_span = typename AuxDataTraits<Payload_t, PayloadAlloc_t>::const_span;
  using Elt_span = typename AuxDataTraits<JaggedVecElt<Payload_t>, ALLOC>::span;
  using Payload_span = typename AuxDataTraits<Payload_t, PayloadAlloc_t>::span;

  using const_span = CxxUtils::transform_view_with_at<const_Elt_span, ConstConverter_t>;
  using span = CxxUtils::transform_view_with_at<Elt_span, Converter_t>;

  using element_type = typename ConstConverter_t::element_type;

  using const_reference_type = element_type;

  using reference_type = JVecProxy;

  using rhs_const_reference_type = std::span<const Payload_t>;

  using container_pointer_type = void;
  using const_container_pointer_type = void;
 

  Decorator (const std::string& name);
 

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

  Decorator (const SG::auxid_t auxid);
 

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

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

  template <IsConstAuxElement ELT,
            CxxUtils::InputRangeOverT<PAYLOAD_T> RANGE>
  void set (const ELT& e, const RANGE& x) const;
 

  template <CxxUtils::InputRangeOverT<PAYLOAD_T> RANGE>
  void set (const AuxVectorData& container, size_t index, const RANGE& x) const;
 

  const Elt_t* getEltArray (const AuxVectorData& container) const;
 

  const Payload_t* getPayloadArray (const AuxVectorData& container) const;
 

  Elt_t* getEltDecorArray (const AuxVectorData& container) const;
 

  Payload_t* getPayloadDecorArray (const AuxVectorData& container) const;
 

  const_Elt_span
  getEltSpan (const AuxVectorData& container) const;
 

  const_Payload_span
  getPayloadSpan (const AuxVectorData& container) const;
 

  const_span
  getDataSpan (const AuxVectorData& container) const;
 

  Elt_span
  getEltDecorSpan (const AuxVectorData& container) const;
 

  Payload_span
  getPayloadDecorSpan (const AuxVectorData& container) const;
 

  span
  getDecorationSpan (const AuxVectorData& container) const;
 

  template <IsConstAuxElement ELT>
  bool isAvailableWritable (const ELT& e) const;
 

  bool isAvailableWritable (const AuxVectorData& c) const;
 
 
protected:
  Decorator (const std::string& name,
             const std::string& clsname,
             const SG::AuxVarFlags flags);
};
 
 
} // namespace SG
 
 
#include "AthContainers/JaggedVecDecorator.icc"
 
 
#endif // not ATHCONTAINERS_JAGGEDVECDECORATOR_H