RCWNTupleCnv.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2026 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
// Include files
#include "RNTupleCnv.h"
#include <Gaudi/NTuple/DiskBuffer.h>
#include <GaudiKernel/Converter.h>
 
#include <filesystem>
#include <map>
#include <memory>
#include <mutex>
#include <set>
#include <string>
#include <vector>
 
#include <TFile.h>
#include <TTree.h>
 
namespace RootHistCnv {

 
  class RCWNTupleCnv : public RNTupleCnv {
  public:
    static const CLID& classID() { return CLID_ColumnWiseTuple; }
    RCWNTupleCnv( ISvcLocator* svc ) : RNTupleCnv( svc, classID() ) {}
 
    StatusCode initialize() override;
    StatusCode finalize() override;
    StatusCode updateRep( IOpaqueAddress* pAddr, DataObject* pObj ) override;

    struct Layout {
      struct Item {
        std::string name;     
        std::string block;    
        std::string leaflist; 
        long        bufPos{ 0 };
        long        bufLen{ 0 };
        long        rangeLower{ 0 };
        long        rangeUpper{ -1 };
        long        indexPos{ -1 }; 
        long        unitBytes{ 0 }; 
        long        maxUnits{ 0 };  
      };
      std::vector<Item> items;
      long              rowBytes{ 0 };
    };
 
  protected:
    StatusCode load( TTree* tree, INTuple*& refpObject ) override;
    StatusCode book( const std::string& desc, INTuple* pObject, TTree*& tree ) override;
    StatusCode writeData( TTree* rtree, INTuple* pObject ) override;
    StatusCode readData( TTree* rtree, INTuple* pObject, long ievt ) override;
 
  private:
    struct Buffered {
      std::string                                        desc;
      Layout                                             layout;
      std::unique_ptr<Gaudi::NTuple::DiskBuffer::Writer> writer;
    };
 
    Layout     analyse( const INTuple& nt );
    StatusCode createTree( const std::string& desc, INTuple* nt, const Layout& layout, TTree*& rtree );
    StatusCode bookBuffered( const std::string& desc, INTuple* nt, Layout layout );
    StatusCode writeBuffered( Buffered& b, INTuple* nt );
    StatusCode replay( IOpaqueAddress* pAddr, INTuple* nt, Buffered& b );
    StatusCode bufferDirectory( std::filesystem::path& dir );
    void       releaseBufferDir();
    Buffered*  buffered( INTuple* nt );
    bool       replayed( INTuple* nt );
 
    std::mutex                   m_mutex; 
    std::map<INTuple*, Buffered> m_buffered;
    std::set<INTuple*>           m_replayed; 
    std::filesystem::path        m_bufferDir;
    unsigned                     m_nextBufferId{ 0 };
    bool                         m_bookDirect{ false }; 

    bool        m_diskBuffer{ false };
    std::string m_diskBufferDirectory;
    int         m_diskBufferLevel{ 0 };
    std::size_t m_diskBufferBlockSize{ 0 };
  };
} // namespace RootHistCnv