RNTCollection.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef RNTCOLLECTION_H
#define RNTCOLLECTION_H
 
#include "CollectionBase/ICollection.h"
#include "CollectionBase/CollectionDescription.h"
#include "CollectionBase/CollectionRowBuffer.h"
 
#include "FileCatalog/IFileCatalog.h"
#include "CoralBase/MessageStream.h"
 
#include "GaudiKernel/IFileMgr.h"
#include "GaudiKernel/SmartIF.h"
#include "Gaudi/PluginService.h"
 
#include <string>
 
#include "RVersion.h"
 
class TFile;
class IFileMgr;
 
// Import classes from experimental namespace for the time being
#if ROOT_VERSION_CODE >= ROOT_VERSION( 6, 35, 0 )
namespace ROOT {
   class RNTupleModel;
   class RNTupleWriter;
   class RNTupleReader;
}
#else
namespace ROOT::Experimental {
   class RNTupleModel;
   class RNTupleWriter;
   class RNTupleReader;
}
namespace ROOT {
   using RNTupleModel = ROOT::Experimental::RNTupleModel;
   using RNTupleWriter = ROOT::Experimental::RNTupleWriter;
   using RNTupleReader = ROOT::Experimental::RNTupleReader;
}
#endif
 
namespace pool {
 
   class ISession; 
 
   namespace RootCollection {
      class Attribute;
      class AttributeSpecification;
 
      static constexpr auto MODULE_NAME = "RootCollection";
  
      class RNTCollection :  public ICollection {
    
     public:
    typedef Gaudi::PluginService::Factory<ICollection*( const ICollectionDescription*, ICollection::OpenMode, ISession*)> Factory;
    
        
    
        RNTCollection(  const pool::ICollectionDescription* description,
                         pool::ICollection::OpenMode mode,
                         pool::ISession* );
 
        ~RNTCollection();
    
        virtual ICollection::OpenMode openMode() const final override; 
 
        virtual void open() final override;
    
        virtual bool isOpen() const final override;
 
        virtual void insertRow( const pool::CollectionRowBuffer& inputRowBuffer ) final override;
 
        virtual void commit( bool restartTransaction = false ) final override;
    
        virtual void close() final override;
    
        virtual const ICollectionDescription& description() const final override;
 
        virtual ICollectionQuery*             newQuery() final override;
 
     private:    
        RNTCollection(const RNTCollection &) = delete;
        RNTCollection & operator = (const RNTCollection &) = delete;
    
        void delayedFileOpen(const std::string& method);
        std::unique_ptr<ROOT::RNTupleReader> getCollectionRNTuple();
        void addField(ROOT::RNTupleModel* model, const std::string& field_name, const std::string& field_type);
 
        bool fileCatalogRequired() const;
        std::string retrievePFN() const;
        std::string retrieveFID();
        std::string retrieveUniquePFN(const FileCatalog::FileID& fid);
        std::string retrieveBestPFN(const FileCatalog::FileID& fid)const;  
        void retrieveFileCatalog()const;
 
        void cleanup();
 
        CollectionDescription                m_description;
        std::unique_ptr<ROOT::RNTupleReader> m_reader;
        std::unique_ptr<ROOT::RNTupleWriter> m_rntupleWriter;
 
        std::string                          m_name;
        std::string                          m_fileName;
        ICollection::OpenMode                m_mode;
        TFile*                               m_file;
        ISession*                            m_session;
        bool                                 m_open;
        bool                                 m_readOnly;
        
        std::unique_ptr<pool::IFileCatalog>  m_fileCatalog;
        coral::MessageStream                 m_poolOut;
 
        SmartIF<IFileMgr>                    m_fileMgr;
      };
   }
}
#endif