RootCollection.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ROOTCOLLECTION_ROOTCOLLECTION_H
#define ROOTCOLLECTION_ROOTCOLLECTION_H
 
#include "RootCollectionDataEditor.h"
#include "RootCollectionSchemaEditor.h"
 
#include "CollectionBase/ICollection.h"
#include "CollectionBase/CollectionDescription.h"
 
#include "FileCatalog/IFileCatalog.h"
#include "CoralBase/MessageStream.h"
 
#include "GaudiKernel/IFileMgr.h"
#include "GaudiKernel/SmartIF.h"
#include "Gaudi/PluginService.h"
 
#include <string>
#include <vector>
 
class TTree;
class TFile;
class IFileMgr;
 
 
namespace pool {
 
   class ISession; 
 
   namespace RootCollection {
 
      // compressed data size for buffer auto-resize (negative == bytes)
      const int TTREE_AUTO_FLUSH = -1*1024*1024;
      
      const int TBRANCH_DEF_BUFSIZE = 8*1024;
 
      // increase TTree size limit to 100GB
      const unsigned long long TTREE_MAX_SIZE = 100*1024*1024*1024ULL;
 
      class Attribute;
      class AttributeSpecification;
  
      class RootCollection :  public ICollection {
    
     public:
    typedef Gaudi::PluginService::Factory<ICollection*( const ICollectionDescription*, ICollection::OpenMode, ISession*)> Factory;
    
 
    
        RootCollection(  const pool::ICollectionDescription* description,
                         pool::ICollection::OpenMode mode,
                         pool::ISession* );
 
        ~RootCollection();
    
        virtual ICollection::OpenMode openMode() const; 
 
        virtual void open();
    
        virtual bool isOpen() const;
 
        virtual void commit( bool restartTransaction = false );
    
        virtual void close();
    
        virtual const ICollectionDescription& description() const;
 
        virtual ICollectionSchemaEditor& schemaEditor();
 
        virtual ICollectionDataEditor&         dataEditor();
 
        virtual ICollectionQuery*         newQuery();
 
     private:
    
        RootCollection(const RootCollection &);
        RootCollection & operator = (const RootCollection &);
    
        void delayedFileOpen( const std::string& method );
        TTree* getCollectionTree();
        void setupTree() const;
        void readAttributeListSpecification() const;
        void writeAttributeListSpecification();
 
        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();
        
     public:
        
        static const unsigned int c_maxLengthOfStrings = 5000;
        static const char* const poolOptToRootOpt[];
        static const Io::IoFlags poolOptToFileMgrOpt[];
        static const char* const c_tokenBranchName;// = "Token";
        static const char* const c_attributeListLayoutName;// = "Schema"; 
 
     private:
 
        CollectionDescription                m_description;
        
        std::string                          m_name;
        std::string                          m_fileName;
        ICollection::OpenMode                m_mode;
        TTree*                               m_tree;
        TFile*                               m_file;
        ISession*                            m_session;
        bool                                 m_open;
        bool                                 m_readOnly;
        
        std::unique_ptr<pool::IFileCatalog> m_fileCatalog;
        coral::MessageStream                m_poolOut;
 
        RootCollectionSchemaEditor*        m_schemaEditor;
        RootCollectionDataEditor*        m_dataEditor;
 
        SmartIF<IFileMgr>                  m_fileMgr;
 
      };
   }
}
#endif