RNTupleWriterHelper.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef RNTUPLEWRITERHELPER_H
#define RNTUPLEWRITERHELPER_H
 
#include "StorageSvc/DbPrint.h"
 
#include "ROOT/REntry.hxx"
#include "ROOT/RField.hxx"
#include "ROOT/RNTuple.hxx"
#include "ROOT/RNTupleWriteOptions.hxx"
#include "ROOT/RNTupleWriter.hxx"
 
#include <tuple>
#include <map>
#include <set>
#include <string>
#include <string_view>
#include <memory>
 
class TFile;
 
namespace RootStorageSvc {
 
class RNTupleWriterHelper : public pool::APRMessaging {
 public:
  RNTupleWriterHelper(TFile* file, const std::string& ntupleName,
                      bool enableBufferedWrite, bool enableMetrics);

  ~RNTupleWriterHelper() = default;

  void makeNewEntry();

  // The convention for the tuple is <name, type, data>
  typedef std::tuple<std::string, std::string, void*> attrDataTuple;
  void addAttribute(const attrDataTuple& in);

  void addField(const std::string& field_name, const std::string& attr_type);

  void addFieldValue(const std::string& field_name, void* attr_data);

  int commit();

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

  size_t size() const { return m_rowN; }

  bool needsCommit() const { return m_needsCommit; }

  bool isGrouped() const { return m_clients > 1; }

  void increaseClientCount() { m_clients++; }

  void close();

  void setUnsplitFieldsList(std::string_view unsplitFieldsList);
 
 private:
  std::map<std::string, void*> m_attrDataMap;

  std::set<std::string, std::less<>> m_unsplitFields;

  std::unique_ptr<ROOT::RNTupleModel> m_model;

  std::unique_ptr<ROOT::REntry> m_entry;

  std::unique_ptr<ROOT::RNTupleWriter> m_ntupleWriter;
 
  std::string m_ntupleName;
  TFile* m_tfile;
  ROOT::RNTupleWriteOptions m_opts;
  int m_rowN = 0;

  int m_clients = 0;
  bool m_needsCommit = false;

  bool m_collectMetrics;
};
 
}  // namespace RootStorageSvc
#endif