ATLAS Offline Software
RootCollection.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 #ifndef ROOTCOLLECTION_ROOTCOLLECTION_H
6 #define ROOTCOLLECTION_ROOTCOLLECTION_H
7 
11 
13 #include "CoralBase/MessageStream.h"
14 
15 #include "GaudiKernel/IFileMgr.h"
16 #include "GaudiKernel/SmartIF.h"
17 #include "Gaudi/PluginService.h"
18 
19 #include <string>
20 #include <vector>
21 #include <memory>
22 
23 class TTree;
24 class TFile;
25 class IFileMgr;
26 
27 
28 namespace pool {
29 
30  class ISession;
31 
32  namespace RootCollection {
33 
34  class Attribute;
35  class AttributeSpecification;
36 
61  class RootCollection : public ICollection {
62 
63  public:
64  typedef Gaudi::PluginService::Factory<ICollection*( const ICollectionDescription*, ICollection::OpenMode, ISession*)> Factory;
65 
101 
102 
105  pool::ISession* );
106 
109 
110  virtual void addTreeBranch( const std::string& name, const std::string& type_name );
111 
113  virtual ICollection::OpenMode openMode() const final override;
114 
116  virtual void open() final override;
117 
119  virtual bool isOpen() const final override;
120 
122  virtual void insertRow( const pool::CollectionRowBuffer& inputRowBuffer ) final override;
123 
125  virtual void commit( bool restartTransaction = false ) final override;
126 
128  virtual void close() final override;
129 
131  virtual const ICollectionDescription& description() const final override;
132 
134  virtual ICollectionQuery* newQuery() final override;
135 
136  private:
137 
142 
143  void delayedFileOpen( const std::string& method );
145  void setupTree() const;
148 
150  std::string retrievePFN()const;
151  std::string retrieveFID();
152  std::string retrieveUniquePFN(const FileCatalog::FileID& fid);
153  std::string retrieveBestPFN(const FileCatalog::FileID& fid)const;
155 
156  void cleanup();
157 
158  public:
159 
160  static const unsigned int c_maxLengthOfStrings = 5000;
161  static const char* const poolOptToRootOpt[];
162  static const Io::IoFlags poolOptToFileMgrOpt[];
163  static const char* const c_tokenBranchName;// = "Token";
164  static const char* const c_attributeListLayoutName;// = "Schema";
165 
166  private:
167 
169 
170  std::string m_name;
171  std::string m_fileName;
173  TTree* m_tree;
174  TFile* m_file;
176  bool m_open;
179 
180  std::unique_ptr<pool::IFileCatalog> m_fileCatalog;
181  coral::MessageStream m_poolOut;
182 
183  SmartIF<IFileMgr> m_fileMgr;
184 
185  };
186  }
187 }
188 #endif
189 
190 
191 
RunTileTBRec.method
method
Definition: RunTileTBRec.py:73
pool::RootCollection::RootCollection::m_file
TFile * m_file
Definition: RootCollection.h:174
pool::RootCollection::RootCollection::open
virtual void open() final override
Explicitly re-opens the collection after it has been closed.
pool::RootCollection::RootCollection::readAttributeListSpecification
void readAttributeListSpecification() const
pool::ICollectionQuery
Definition: ICollectionQuery.h:27
pool::RootCollection::RootCollection::retrieveFileCatalog
void retrieveFileCatalog() const
pool::RootCollection::RootCollection::m_poolOut
coral::MessageStream m_poolOut
Definition: RootCollection.h:181
pool::RootCollection::RootCollection::c_attributeListLayoutName
static const char *const c_attributeListLayoutName
Definition: RootCollection.h:164
pool::RootCollection::RootCollection::~RootCollection
~RootCollection()
Destructor.
pool::RootCollection::RootCollection::m_mode
ICollection::OpenMode m_mode
Definition: RootCollection.h:172
pool::RootCollection::RootCollection::writeAttributeListSpecification
void writeAttributeListSpecification()
pool::RootCollection::RootCollection::commit
virtual void commit(bool restartTransaction=false) final override
Commits the last changes made to the collection.
pool::RootCollection::RootCollection::delayedFileOpen
void delayedFileOpen(const std::string &method)
CollectionDescription.h
pool
pool namespace
Definition: libname.h:15
IFileCatalog.h
pool::RootCollection::RootCollection::cleanup
void cleanup()
pool::RootCollection::RootCollection::m_session
ISession * m_session
Definition: RootCollection.h:175
pool::RootCollection::RootCollection::openMode
virtual ICollection::OpenMode openMode() const final override
Return openMode.
pool::RootCollection::RootCollection::m_open
bool m_open
Definition: RootCollection.h:176
pool::RootCollection::RootCollection::m_fileCatalog
std::unique_ptr< pool::IFileCatalog > m_fileCatalog
Definition: RootCollection.h:180
const
bool const RAWDATA *ch2 const
Definition: LArRodBlockPhysicsV0.cxx:560
pool::RootCollection::RootCollection::m_fileName
std::string m_fileName
Definition: RootCollection.h:171
pool::RootCollection::RootCollection::poolOptToRootOpt
static const char *const poolOptToRootOpt[]
Definition: RootCollection.h:161
pool::ISession
Definition: ISession.h:32
pool::RootCollection::RootCollection::c_tokenBranchName
static const char *const c_tokenBranchName
Definition: RootCollection.h:163
coral
Definition: ISecondaryEventSelector.h:19
pool::RootCollection::RootCollection::fileCatalogRequired
bool fileCatalogRequired() const
pool::RootCollection::RootCollection::insertRow
virtual void insertRow(const pool::CollectionRowBuffer &inputRowBuffer) final override
Adds a new row of data to the collection.
pool::RootCollection::RootCollection
Collection (and CollectionProxy) implementation based on ROOT trees.
Definition: RootCollection.h:61
CollectionRowBuffer.h
pool::IFileCatalog
Definition: IFileCatalog.h:23
pool::RootCollection::RootCollection::addTreeBranch
virtual void addTreeBranch(const std::string &name, const std::string &type_name)
pool::RootCollection::RootCollection::retrieveUniquePFN
std::string retrieveUniquePFN(const FileCatalog::FileID &fid)
pool::ICollection::OpenMode
OpenMode
Enumeration of the possible open modes of the collection.
Definition: ICollection.h:26
pool::RootCollection::RootCollection::close
virtual void close() final override
Explicitly closes the collection.
pool::RootCollection::RootCollection::poolOptToFileMgrOpt
static const Io::IoFlags poolOptToFileMgrOpt[]
Definition: RootCollection.h:162
pool::CollectionDescription
Definition: CollectionDescription.h:26
pool::RootCollection::RootCollection::m_name
std::string m_name
Definition: RootCollection.h:170
ICollection.h
Io
Definition: MetaDataSvc.h:36
pool::RootCollection::RootCollection::m_fileMgr
SmartIF< IFileMgr > m_fileMgr
Definition: RootCollection.h:183
Preparation.mode
mode
Definition: Preparation.py:107
pool::RootCollection::RootCollection::retrievePFN
std::string retrievePFN() const
pool::RootCollection::RootCollection::setupTree
void setupTree() const
pool::RootCollection::RootCollection::m_schemaWritten
bool m_schemaWritten
Definition: RootCollection.h:178
pool::RootCollection::RootCollection::Factory
Gaudi::PluginService::Factory< ICollection *(const ICollectionDescription *, ICollection::OpenMode, ISession *)> Factory
Definition: RootCollection.h:64
pool::FileID
std::string FileID
Definition: FileDescriptor.h:27
pool::RootCollection::RootCollection::retrieveBestPFN
std::string retrieveBestPFN(const FileCatalog::FileID &fid) const
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:240
pool::CollectionRowBuffer
Definition: CollectionRowBuffer.h:31
pool::RootCollection::RootCollection::description
virtual const ICollectionDescription & description() const final override
Returns an object used to describe the collection properties.
pool::RootCollection::RootCollection::m_tree
TTree * m_tree
Definition: RootCollection.h:173
pool::RootCollection::RootCollection::retrieveFID
std::string retrieveFID()
pool::RootCollection::RootCollection::getCollectionTree
TTree * getCollectionTree()
pool::RootCollection::RootCollection::c_maxLengthOfStrings
static const unsigned int c_maxLengthOfStrings
Definition: RootCollection.h:160
private
#define private
Definition: xAODTruthCnvAlg.h:20
pool::RootCollection::RootCollection::m_readOnly
bool m_readOnly
Definition: RootCollection.h:177
pool::RootCollection::RootCollection::newQuery
virtual ICollectionQuery * newQuery() final override
Returns an object used to query the collection.
pool::RootCollection::RootCollection::isOpen
virtual bool isOpen() const final override
Checks if the collection is open.
pool::ICollection
Definition: ICollection.h:23
pool::RootCollection::RootCollection::m_description
CollectionDescription m_description
Definition: RootCollection.h:168
pool::RootCollection::RootCollection::RootCollection
RootCollection(const pool::ICollectionDescription *description, pool::ICollection::OpenMode mode, pool::ISession *)
Constructor.
pool::ICollectionDescription
Definition: ICollectionDescription.h:25