RNTupleContainer.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
//====================================================================
//    Root Database Container RNTuple implementation
//--------------------------------------------------------------------
//    Author     : M.Nowak
//====================================================================
#ifndef POOL_RNTUPLECONTAINER_H
#define POOL_RNTUPLECONTAINER_H 1
 
// Framework include files
#include "StorageSvc/DbColumn.h"
#include "StorageSvc/DbContainerImp.h"
#include "StorageSvc/DbDatabase.h"
 
#include "RootAuxDynIO/IRootAuxDynIO.h"
 
#include "ROOT/RNTupleView.hxx"
 
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
// Forward declarations
class TClass;
namespace RootAuxDynIO { class IRootAuxDynReader; class IRNTupleAuxDynWriter; }
namespace RootStorageSvc { class RNTupleWriterHelper; }
namespace ROOT { class RNTupleReader; }
 
// Forward declaration
namespace pool {
  class RootDatabase;
}

 
class RNTupleContainer : public pool::DbContainerImp
{
  struct FieldDesc : public pool::DbColumn
  {
    std::string fieldname;
    std::optional< ROOT::RNTupleView<void> > view;
    std::string sgkey;
    TClass*     clazz = nullptr;
    void*       object = nullptr;
 
    // if writing char* keep a copy here as an std::string
    std::string str;
 
    // ----  extra variables used for AuxDyn attributes
    // number of rows written to this branch so far
    size_t rows_written = 0;
 
    // AuxDyn RNTuple reader (managed by the Database)
    std::unique_ptr<RootAuxDynIO::IRootAuxDynReader> auxdyn_reader;
 
    // AuxDyn RNTuple writer
    std::unique_ptr<RootAuxDynIO::IRNTupleAuxDynWriter> auxdyn_writer;
 
    explicit FieldDesc(const DbColumn& c);
    FieldDesc(FieldDesc const& other) = delete;
    FieldDesc(FieldDesc&& other) = default;
    ~FieldDesc() = default;
 
    FieldDesc& operator=(FieldDesc const& other) = delete;
    FieldDesc& operator=(FieldDesc&& other) = default;
 
    const std::string typeName();
  };
 
 private:
   const pool::DbTypeInfo*  m_type{};
   std::vector<FieldDesc>  m_fieldDescs;
   pool::DbDatabase         m_dbH;
   pool::RootDatabase*      m_rootDb;
   int                m_ioBytes;
   bool               m_isDirty;
 
   uint64_t           m_index;
   uint64_t           m_indexSize;
   int64_t            m_indexBump;
   const uint32_t     m_indexMulti;

   RootStorageSvc::RNTupleWriterHelper*     m_ntupleWriter = nullptr;

   ROOT::RNTupleReader*       m_ntupleReader{};

   std::unique_ptr<RootAuxDynIO::IFactoryTool>       m_auxDynTool;
 
 public:
  explicit RNTupleContainer(const std::string& name);
  virtual ~RNTupleContainer();

  virtual pool::DbStatus close() override final;

  virtual pool::DbStatus open(pool::DbDatabase& dbH, const std::string& nam,
                        const pool::DbTypeInfo* info,
                        pool::DbAccessMode mod) override final;

  virtual pool::DbStatus checkAccess(pool::DbDatabase& dbH,
                               const std::string& nam) const override final;


  virtual pool::DbStatus getOption(pool::DbOption& opt) override final;


  virtual pool::DbStatus setOption(const pool::DbOption& opt) override final;

  virtual uint64_t size() override final;

  const std::string& getName() const { return m_name; }

  bool isDirty() const { return m_isDirty; }

  void clearDirty() { m_isDirty = false; }


  virtual pool::DbStatus loadObject(void** ptr, pool::ShapeH shape,
                              Token::OID_t& oid) override final;

  virtual pool::DbStatus writeObject(ActionList::value_type&) override final;
 
  virtual uint64_t nextRecordId() override final;
 
  virtual void useNextRecordId(uint64_t nextID) override final;

  virtual pool::DbStatus select(pool::DbSelect& sel) override final;

  using pool::DbContainerImp::fetch;
  virtual pool::DbStatus fetch(pool::DbSelect& sel) override final;

  virtual pool::DbStatus transAct(pool::Transaction::Action action) override final;

  virtual pool::DbStatus store(const void* object,
                               pool::DbContainer& cntH,
                               pool::ShapeH shape) override final;
 
 private:
  pool::DbStatus initObjectFieldDesc(FieldDesc& dsc);
};
 
#endif