ATLAS Offline Software
RNTCollection.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 RNTCOLLECTION_H
6 #define RNTCOLLECTION_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 <memory>
21 
22 #include "RVersion.h"
23 
24 class TFile;
25 class IFileMgr;
26 
27 // Import classes from experimental namespace for the time being
28 #if ROOT_VERSION_CODE >= ROOT_VERSION( 6, 35, 0 )
29 namespace ROOT {
30  class RNTupleModel;
31  class RNTupleWriter;
32  class RNTupleReader;
33 }
34 #else
35 namespace ROOT::Experimental {
36  class RNTupleModel;
37  class RNTupleWriter;
38  class RNTupleReader;
39 }
40 namespace ROOT {
41  using RNTupleModel = ROOT::Experimental::RNTupleModel;
42  using RNTupleWriter = ROOT::Experimental::RNTupleWriter;
43  using RNTupleReader = ROOT::Experimental::RNTupleReader;
44 }
45 #endif
46 
47 namespace pool {
48 
49  class ISession;
50 
51  namespace RootCollection {
52  class Attribute;
53  class AttributeSpecification;
54 
55  static constexpr auto MODULE_NAME = "RootCollection";
56 
61  class RNTCollection : public ICollection {
62 
63  public:
64  typedef Gaudi::PluginService::Factory<ICollection*( const ICollectionDescription*, ICollection::OpenMode, ISession*)> Factory;
65 
92 
93 
96  pool::ISession* );
97 
100 
102  virtual ICollection::OpenMode openMode() const final override;
103 
105  virtual void open() final override;
106 
108  virtual bool isOpen() const final override;
109 
111  virtual void insertRow( const pool::CollectionRowBuffer& inputRowBuffer ) final override;
112 
114  virtual void commit( bool restartTransaction = false ) final override;
115 
117  virtual void close() final override;
118 
120  virtual const ICollectionDescription& description() const final override;
121 
123  virtual ICollectionQuery* newQuery() final override;
124 
125  private:
129 
130  void delayedFileOpen(const std::string& method);
131  std::unique_ptr<ROOT::RNTupleReader> getCollectionRNTuple();
132  void addField(ROOT::RNTupleModel* model, const std::string& field_name, const std::string& field_type);
133 
135  std::string retrievePFN() const;
136  std::string retrieveFID();
137  std::string retrieveUniquePFN(const FileCatalog::FileID& fid);
138  std::string retrieveBestPFN(const FileCatalog::FileID& fid)const;
140 
141  void cleanup();
142 
144  std::unique_ptr<ROOT::RNTupleReader> m_reader;
145  std::unique_ptr<ROOT::RNTupleWriter> m_rntupleWriter;
146 
147  std::string m_name;
148  std::string m_fileName;
150  TFile* m_file;
152  bool m_open;
154 
155  std::unique_ptr<pool::IFileCatalog> m_fileCatalog;
156  coral::MessageStream m_poolOut;
157 
158  SmartIF<IFileMgr> m_fileMgr;
159  };
160  }
161 }
162 #endif
RunTileTBRec.method
method
Definition: RunTileTBRec.py:73
pool::RootCollection::RNTCollection::m_file
TFile * m_file
Definition: RNTCollection.h:150
pool::ICollectionQuery
Definition: ICollectionQuery.h:27
pool::RootCollection::RNTCollection::m_session
ISession * m_session
Definition: RNTCollection.h:151
pool::RootCollection::RNTCollection::retrieveFID
std::string retrieveFID()
pool::RootCollection::RNTCollection::addField
void addField(ROOT::RNTupleModel *model, const std::string &field_name, const std::string &field_type)
pool::RootCollection::RNTCollection::m_description
CollectionDescription m_description
Definition: RNTCollection.h:143
pool::RootCollection::RNTCollection::m_reader
std::unique_ptr< ROOT::RNTupleReader > m_reader
Definition: RNTCollection.h:144
pool::RootCollection::RNTCollection::m_fileName
std::string m_fileName
Definition: RNTCollection.h:148
CollectionDescription.h
pool::RootCollection::RNTCollection::openMode
virtual ICollection::OpenMode openMode() const final override
Return openMode.
pool::RootCollection::RNTCollection::retrieveFileCatalog
void retrieveFileCatalog() const
pool
pool namespace
Definition: libname.h:15
IFileCatalog.h
pool::RootCollection::RNTCollection::m_fileCatalog
std::unique_ptr< pool::IFileCatalog > m_fileCatalog
Definition: RNTCollection.h:155
pool::RootCollection::RNTCollection::m_readOnly
bool m_readOnly
Definition: RNTCollection.h:153
const
bool const RAWDATA *ch2 const
Definition: LArRodBlockPhysicsV0.cxx:560
pool::RootCollection::RNTCollection::RNTCollection
RNTCollection(const pool::ICollectionDescription *description, pool::ICollection::OpenMode mode, pool::ISession *)
Constructor.
pool::RootCollection::RNTCollection::close
virtual void close() final override
Explicitly closes the collection.
pool::ISession
Definition: ISession.h:32
coral
Definition: ISecondaryEventSelector.h:19
pool::RootCollection::RNTCollection::m_fileMgr
SmartIF< IFileMgr > m_fileMgr
Definition: RNTCollection.h:158
pool::RootCollection::RNTCollection
Collection (and CollectionProxy) implementation based on RNTuple.
Definition: RNTCollection.h:61
CollectionRowBuffer.h
pool::IFileCatalog
Definition: IFileCatalog.h:23
pool::RootCollection::RNTCollection::fileCatalogRequired
bool fileCatalogRequired() const
pool::RootCollection::RNTCollection::retrieveUniquePFN
std::string retrieveUniquePFN(const FileCatalog::FileID &fid)
pool::RootCollection::RNTCollection::m_rntupleWriter
std::unique_ptr< ROOT::RNTupleWriter > m_rntupleWriter
Definition: RNTCollection.h:145
pool::ICollection::OpenMode
OpenMode
Enumeration of the possible open modes of the collection.
Definition: ICollection.h:26
pool::CollectionDescription
Definition: CollectionDescription.h:26
ICollection.h
pool::RootCollection::RNTCollection::Factory
Gaudi::PluginService::Factory< ICollection *(const ICollectionDescription *, ICollection::OpenMode, ISession *)> Factory
Definition: RNTCollection.h:64
Preparation.mode
mode
Definition: Preparation.py:107
pool::RootCollection::RNTCollection::newQuery
virtual ICollectionQuery * newQuery() final override
Returns an object used to query the collection.
pool::RootCollection::RNTCollection::retrievePFN
std::string retrievePFN() const
pool::RootCollection::RNTCollection::description
virtual const ICollectionDescription & description() const final override
Returns an object used to describe the collection properties.
pool::FileID
std::string FileID
Definition: FileDescriptor.h:27
pool::RootCollection::RNTCollection::commit
virtual void commit(bool restartTransaction=false) final override
Commits the last changes made to the collection.
pool::CollectionRowBuffer
Definition: CollectionRowBuffer.h:31
pool::RootCollection::RNTCollection::m_open
bool m_open
Definition: RNTCollection.h:152
pool::RootCollection::RNTCollection::insertRow
virtual void insertRow(const pool::CollectionRowBuffer &inputRowBuffer) final override
Adds a new row of data to the collection.
pool::RootCollection::RNTCollection::cleanup
void cleanup()
pool::RootCollection::RNTCollection::m_poolOut
coral::MessageStream m_poolOut
Definition: RNTCollection.h:156
calibdata.delete
list delete
Definition: calibdata.py:45
pool::RootCollection::RNTCollection::isOpen
virtual bool isOpen() const final override
Checks if the collection is open.
pool::RootCollection::RNTCollection::open
virtual void open() final override
Explicitly re-opens the collection after it has been closed.
pool::RootCollection::RNTCollection::m_name
std::string m_name
Definition: RNTCollection.h:147
pool::RootCollection::RNTCollection::getCollectionRNTuple
std::unique_ptr< ROOT::RNTupleReader > getCollectionRNTuple()
correlationModel::model
model
Definition: AsgElectronEfficiencyCorrectionTool.cxx:46
private
#define private
Definition: xAODTruthCnvAlg.h:20
pool::RootCollection::RNTCollection::retrieveBestPFN
std::string retrieveBestPFN(const FileCatalog::FileID &fid) const
pool::RootCollection::RNTCollection::delayedFileOpen
void delayedFileOpen(const std::string &method)
pool::RootCollection::RNTCollection::~RNTCollection
~RNTCollection()
Destructor.
ROOT
Selection rules: declare transient members.
Definition: DataVector.h:580
pool::ICollection
Definition: ICollection.h:23
pool::RootCollection::RNTCollection::m_mode
ICollection::OpenMode m_mode
Definition: RNTCollection.h:149
pool::ICollectionDescription
Definition: ICollectionDescription.h:25