AtomicDecorator.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 ATHCONTAINERS_ATOMICDECORATOR_H
#define ATHCONTAINERS_ATOMICDECORATOR_H
 
 
#include "AthContainers/AuxElement.h"
#include "AthContainers/tools/AuxDataTraits.h"
#include <atomic>
#include <type_traits>
 
 
namespace SG {
 

template <class T, class ALLOC = AuxAllocator_t<T> >
class AtomicDecorator
  : public Decorator<T, ALLOC>
{
public:
  using Base = Decorator<T, ALLOC>;

  using reference_type = std::atomic<T>&;

  using element_type = typename AuxDataTraits<T, ALLOC>::element_type;

  using container_pointer_type = std::atomic<T>*;
  using const_container_pointer_type = const std::atomic<T>*;
 
  // Consistency checks.
  static_assert (std::is_same<T, typename Base::element_type>::value,
                 "Bad type for AtomicDecorator");
  static_assert (std::is_same<T&, typename Base::reference_type>::value,
                 "Bad type for AtomicDecorator");
 
  static_assert (std::is_same<T*, typename Base::container_pointer_type>::value,
                 "Bad type for AtomicDecorator");
  static_assert (std::is_same<const T*, typename Base::const_container_pointer_type>::value,
                 "Bad type for AtomicDecorator");
  static_assert (sizeof(T) == sizeof(std::atomic<T>),
                 "Bad type for AtomicDecorator");
  static_assert (std::atomic<T>::is_always_lock_free,
                 "Bad type for AtomicDecorator");
 

  AtomicDecorator (const std::string& name);
 

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

  AtomicDecorator (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;
 

  void set (const AuxElement& e, const element_type& x) const;
 

  const_container_pointer_type getDataArray (const AuxVectorData& container) const;
    

  container_pointer_type getDecorationArray (const AuxVectorData& container) const;
};
 
 
} // namespace SG
 
 
#include "AthContainers/tools/AtomicDecorator.icc"
 
 
#endif // not ATHCONTAINERS_ATOMICDECORATOR_H