Decorator.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-2024 CERN for the benefit of the ATLAS collaboration.
 */
#ifndef ATHCONTAINERS_DECORATOR_H
#define ATHCONTAINERS_DECORATOR_H
 
 
#include "AthContainersInterfaces/AuxTypes.h"
#include "AthContainersInterfaces/IAuxElement.h"
#include "AthContainers/AuxVectorData.h"
#include "AthContainers/AuxTypeRegistry.h"
#include "AthContainers/tools/AuxElementConcepts.h"
#include <string>
#include <typeinfo>
 
 
namespace SG {
 
 
template <class T, class ALLOC = AuxAllocator_t<T> >
class Decorator
{
public:
  using reference_type = typename AuxDataTraits<T, ALLOC>::reference_type;
 
  using element_type = typename AuxDataTraits<T, ALLOC>::element_type;
 
  using container_pointer_type =
    typename AuxDataTraits<T, ALLOC>::container_pointer_type;
  using const_container_pointer_type =
    typename AuxDataTraits<T, ALLOC>::const_container_pointer_type;
 
  using span = typename AuxDataTraits<T, ALLOC>::span;
  using const_span = typename AuxDataTraits<T, ALLOC>::const_span;
 
 
  Decorator (const std::string& name);
 
 
  Decorator (const std::string& name, const std::string& clsname);
 
 
  Decorator (const SG::auxid_t auxid);
 
 
  template <class ELT>
  ATH_REQUIRES( IsConstAuxElement<ELT> )
  reference_type operator() (const ELT& e) const;
 
 
  reference_type
  operator() (const AuxVectorData& container, size_t index) const;
 
 
  template <class ELT>
  ATH_REQUIRES( IsConstAuxElement<ELT> )
  void set (const ELT& e, const element_type& x) const;
 
 
  const_container_pointer_type getDataArray (const AuxVectorData& container) const;
    
 
  container_pointer_type getDecorationArray (const AuxVectorData& container) const;
    
 
  const_span
  getDataSpan (const AuxVectorData& container) const;
 
 
  span
  getDecorationSpan (const AuxVectorData& container) const;
 
 
  template <class ELT>
  ATH_REQUIRES( IsConstAuxElement<ELT> )
  bool isAvailable (const ELT& e) const;
 
 
  template <class ELT>
  ATH_REQUIRES( IsConstAuxElement<ELT> )
  bool isAvailableWritable (const ELT& e) const;
 
 
  SG::auxid_t auxid() const;
 
 
protected:
  Decorator (const std::string& name,
             const std::string& clsname,
             const SG::AuxVarFlags flags);
 
 
  Decorator (const SG::auxid_t auxid,
             const SG::AuxVarFlags flags);
 
 
private:
  SG::auxid_t m_auxid;
};
 
 
} // namespace SG
 
 
#include "AthContainers/Decorator.icc"
 
 
#endif // not ATHCONTAINERS_DECORATOR_H