AuxStoreBase.h

Go to the documentation of this file.

// Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
#ifndef XAODROOTACCESS_TOOLS_AUXSTOREBASE_H
#define XAODROOTACCESS_TOOLS_AUXSTOREBASE_H
 
// Framework include(s).
#include "AsgMessaging/StatusCode.h"
#include "AthContainers/AuxStoreInternal.h"
#include "AthContainers/tools/threading.h"
#include "AthContainersInterfaces/IAuxStore.h"
#include "AthContainersInterfaces/IAuxStoreIO.h"
#include "xAODCore/AuxSelection.h"
 
// System include(s).
#include <memory>
#include <string>
#include <string_view>
 
namespace xAOD::details {

class AuxStoreBase : public SG::IAuxStore, public SG::IAuxStoreIO {
 
 public:
  enum class EStructMode {
    kUndefinedStore = 0,  
    kContainerStore = 1,  
    kObjectStore = 2      
  };

  AuxStoreBase(bool topStore = true,
               EStructMode mode = EStructMode::kUndefinedStore);
  virtual ~AuxStoreBase();

  EStructMode structMode() const;
  void setStructMode(EStructMode mode);

  const std::string& prefix() const;
  virtual void setPrefix(std::string_view prefix) = 0;

  bool isTopStore() const;
  void setTopStore(bool value = true);


  virtual const void* getData(SG::auxid_t auxid) const override;

  virtual const SG::IAuxTypeVector* getVector(SG::auxid_t auxid) const override;

  virtual const SG::auxid_set_t& getAuxIDs() const override;

  virtual const SG::auxid_set_t& getDecorIDs() const override;

  virtual void* getDecoration(SG::auxid_t auxid, std::size_t size,
                              std::size_t capacity) override;

  virtual bool isDecoration(SG::auxid_t auxid) const override;

  virtual void lock() override;
  virtual bool clearDecorations() override;

  virtual void lockDecoration(SG::auxid_t auxid) override;

  virtual std::size_t size() const override;

  virtual const SG::IAuxTypeVector* linkedVector(
      SG::auxid_t auxid) const override;
  virtual SG::IAuxTypeVector* linkedVector(SG::auxid_t auxid) override;



  virtual void* getData(SG::auxid_t auxid, std::size_t size,
                        std::size_t capacity) override;

  virtual const SG::auxid_set_t& getWritableAuxIDs() const override;

  virtual bool resize(std::size_t size) override;
  virtual void reserve(std::size_t size) override;
  virtual void shift(std::size_t pos, std::ptrdiff_t offs) override;
  virtual bool insertMove(std::size_t pos, SG::IAuxStore& other,
                          const SG::auxid_set_t& ignore) override;



  virtual const void* getIOData(SG::auxid_t auxid) const override;

  virtual const std::type_info* getIOType(SG::auxid_t auxid) const override;

  virtual const SG::auxid_set_t& getDynamicAuxIDs() const override;

  virtual void selectAux(const std::set<std::string>& attributes);

  virtual SG::auxid_set_t getSelectedAuxIDs() const override;

 
 protected:
  bool isAuxIDSelected(SG::auxid_t auxid) const;


  virtual void reset() = 0;

  virtual bool hasEntryFor(SG::auxid_t auxid) const = 0;
  virtual StatusCode getEntryFor(SG::auxid_t auxid) = 0;
  virtual bool hasOutput() const = 0;

  virtual StatusCode setupInputData(SG::auxid_t auxid) = 0;
  virtual StatusCode setupOutputData(SG::auxid_t auxid) = 0;

  virtual const void* getInputObject(SG::auxid_t auxid) const = 0;
  virtual const std::type_info* getInputType(SG::auxid_t auxid) const = 0;


  struct Members {

    EStructMode m_structMode = EStructMode::kUndefinedStore;
    bool m_topStore = true;
    std::string m_prefix{};
    std::string m_dynPrefix{};

    std::unique_ptr<SG::AuxStoreInternal> m_transientStore{};

    SG::auxid_set_t m_auxIDs{};
    SG::auxid_set_t m_decorIDs{};
    std::vector<std::unique_ptr<SG::IAuxTypeVector> > m_vecs{};
    std::size_t m_size = 0u;

    std::vector<bool> m_isDecoration{};
 
  };  // struct BaseMembers

  Members m_data;

  using mutex_t = AthContainers_detail::mutex;
  using guard_t = AthContainers_detail::lock_guard<mutex_t>;
 
 private:
  AuxSelection m_selection;
  bool m_locked = false;
  mutable mutex_t m_mutex1, m_mutex2;
 
};  // class AuxStoreBase
 
}  // namespace xAOD::details
 
#endif  // XAODROOTACCESS_TOOLS_AUXSTOREBASE_H