| The Gaudi Framework v27r1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

RootDataConnection.h
Go to the documentation of this file.
1 #ifndef GAUDIROOT_ROOTDATACONNECTION_H
2 #define GAUDIROOT_ROOTDATACONNECTION_H
3
4 // Framework include files
5 #include "GaudiKernel/ClassID.h"
6 #include "GaudiKernel/IIncidentSvc.h"
7 #include "GaudiKernel/SmartIF.h"
8 #include "GaudiUtils/IIODataManager.h"
9 #include <string>
10 #include <vector>
11 #include <map>
12 #include <set>
13
14 #include "TFile.h"
15 #include "TTreePerfStats.h"
16 #include "RootCnv/RootRefs.h"
17
18 // Forward declarations
19 class TTree;
20 class TClass;
21 class TBranch;
22
23 class MsgStream;
24 class IRegistry;
25 class DataObject;
26 class IIncidentSvc;
27
28 /*
29 * Gaudi namespace declaration
30 */
31 namespace Gaudi {
32
43 class GAUDI_API RootConnectionSetup final {
44 private:
46 std::unique_ptr<MsgStream> m_msgSvc;
48 SmartIF<IIncidentSvc> m_incidentSvc = nullptr;
49
50 public:
52 typedef std::vector<std::string> StringVec;
53
55 StringVec cacheBranches;
57 StringVec vetoBranches;
59 std::string loadSection;
61 int cacheSize;
63 int learnEntries;
64
66 RootConnectionSetup() = default;
67
69 static long setCompression(const std::string& compression);
71 static int compression();
72
74 void setMessageSvc(MsgStream* m);
76 MsgStream& msgSvc() const { return *m_msgSvc; }
77
79 void setIncidentSvc(IIncidentSvc* m);
81 IIncidentSvc* incidentSvc() const { return m_incidentSvc.get(); }
82 };
83
92 class GAUDI_API RootDataConnection : virtual public Gaudi::IDataConnection {
93 public:
94
95 enum { ROOT_READ_ERROR = 0x2,
96 ROOT_OPEN_ERROR = 0x4
97 };
98
109 struct ContainerSection {
111 ContainerSection() : start(-1), length(0) {}
113 ContainerSection(int s, int l) : start(s), length(l) {}
115 ContainerSection(const ContainerSection& s) : start(s.start), length(s.length) {}
117 ContainerSection& operator=(const ContainerSection& s) {
118 if ( this != &s ) {
119 start=s.start;
120 length=s.length;
121 }
122 return *this;
123 }
125 int start;
127 int length;
128 };
129
131 typedef std::vector<std::string> StringVec;
133 typedef std::vector<std::pair<std::string,std::string> > ParamMap;
135 typedef std::map<std::string,TTree*> Sections;
137 typedef std::vector<ContainerSection> ContainerSections;
139 typedef std::map<std::string,ContainerSections> MergeSections;
141 typedef std::vector<RootRef> LinkSections;
143 typedef std::set<const IInterface*> Clients;
144
146 MsgStream& msgSvc() const { return m_setup->msgSvc(); }
147
148
149 protected:
151 std::shared_ptr<RootConnectionSetup> m_setup;
153 std::unique_ptr<TTreePerfStats> m_statistics;
155 std::unique_ptr<TFile> m_file;
157 TTree *m_refs = nullptr;
159 Sections m_sections;
161 StringVec m_dbs;
163 StringVec m_conts;
165 StringVec m_links;
167 StringVec m_mergeFIDs;
169 ParamMap m_params;
171 MergeSections m_mergeSects;
173 LinkSections m_linkSects;
175 Clients m_clients;
177 std::string m_empty;
178
180 const std::string& empty() const;
181
183 StatusCode saveRefs();
184
185 public:
195 class Tool {
196 protected:
197 typedef RootDataConnection::StringVec StringVec;
198 typedef RootDataConnection::ParamMap ParamMap;
199 typedef RootDataConnection::Sections Sections;
200 typedef RootDataConnection::MergeSections MergeSections;
201 typedef RootDataConnection::LinkSections LinkSections;
202 typedef RootDataConnection::ContainerSection ContainerSection;
203 typedef RootDataConnection::ContainerSections ContainerSections;
204
206 RootDataConnection* c;
207 public:
208 TTree* refs() const { return c->m_refs; }
209 StringVec& dbs() const { return c->m_dbs; }
210 StringVec& conts() const { return c->m_conts; }
211 StringVec& links() const { return c->m_links; }
212 ParamMap& params() const { return c->m_params; }
213 MsgStream& msgSvc() const { return c->msgSvc(); }
214 const std::string& name() const { return c->m_name; }
215 Sections& sections() const { return c->m_sections; }
216 LinkSections& linkSections() const { return c->m_linkSects; }
217 MergeSections& mergeSections() const { return c->m_mergeSects; }
218
220 virtual ~Tool() = default;
222 virtual TBranch* getBranch(const std::string& section, const std::string& n) = 0;
224 virtual RootRef poolRef(size_t /* which */) const { return RootRef(); }
225
227 virtual StatusCode readRefs() = 0;
229 virtual StatusCode saveRefs() = 0;
231 virtual int loadRefs(const std::string& section, const std::string& cnt, unsigned long entry, RootObjectRefs& refs) = 0;
232 };
233 std::unique_ptr<Tool> m_tool;
234 friend class Tool;
235
237 Tool* makeTool();
238
239 public:
240
242 RootDataConnection(const IInterface* own, const std::string& nam, std::shared_ptr<RootConnectionSetup> setup);
244 ~RootDataConnection() override = default;
245
247 TFile* file() const { return m_file.get(); }
249 bool isConnected() const override { return bool(m_file); }
251 bool isWritable() const { return m_file && m_file->IsWritable(); }
253 Tool* tool() const { return m_tool.get(); }
255 const MergeSections& mergeSections() const { return m_mergeSects; }
257 const StringVec& mergeFIDs() const { return m_mergeFIDs; }
258
259
261 void addClient(const IInterface* client);
263 size_t removeClient(const IInterface* client);
265 bool lookupClient(const IInterface* client) const;
266
268 void badWriteError(const std::string& msg) const;
269
271 std::pair<const RootRef*,const ContainerSection*> getMergeSection(const std::string& container, int entry) const;
272
274 void enableStatistics(const std::string& section);
276 void saveStatistics(const std::string& statisticsFile);
277
279 int loadObj(const std::string& section, const std::string& cnt, unsigned long entry, DataObject*& pObj);
280
282 int loadRefs(const std::string& section, const std::string& cnt, unsigned long entry, RootObjectRefs& refs);
283
285 std::pair<int,unsigned long> saveObj(const std::string& section,const std::string& cnt, TClass* cl, DataObject* pObj, int buff_siz, int split_lvl,bool fill_missing=false);
287 std::pair<int,unsigned long> save(const std::string& section,const std::string& cnt, TClass* cl, void* pObj, int buff_siz, int split_lvl,bool fill_missing=false);
288
289
291 StatusCode connectRead() override;
293 StatusCode connectWrite(IoType typ) override;
295 StatusCode disconnect() override;
297 StatusCode read(void* const, size_t) override { return StatusCode::FAILURE; }
299 StatusCode write(const void*, int) override { return StatusCode::FAILURE; }
301 long long int seek(long long int, int) override { return -1; }
302
304 TTree* getSection(const std::string& sect, bool create=false);
305
307 TBranch* getBranch(const std::string& section,const std::string& branch_name)
308 { return m_tool->getBranch(section,branch_name); }
310 TBranch* getBranch(const std::string& section, const std::string& branch_name, TClass* cl, void* ptr, int buff_siz, int split_lvl);
311
313 void makeRef(IRegistry* pA, RootRef& ref);
315 void makeRef(const std::string& name, long clid, int tech, const std::string& db, const std::string& cnt, int entry, RootRef& ref);
316
318 int makeLink(const std::string& p);
319
321 const std::string& getDb(int which) const;
322
324 const std::string& getCont(int which) const
325 { return (which>=0)&&(size_t(which)<m_conts.size()) ? *(m_conts.begin()+which) : empty(); }
326
328 const std::string& getLink(int which) const
329 { return (which>=0)&&(size_t(which)<m_links.size()) ? *(m_links.begin()+which) : empty(); }
330 };
331 } // End namespace Gaudi
332 #endif // GAUDIROOT_ROOTDATACONNECTION_H
Gaudi::RootDataConnection::Tool::name
const std::string & name() const
Definition: RootDataConnection.h:214
Gaudi::RootDataConnection::m_mergeSects
MergeSections m_mergeSects
Database section map for merged files.
Definition: RootDataConnection.h:171
MsgStream
Definition of the MsgStream class used to transmit messages.
Definition: MsgStream.h:24
Gaudi::RootDataConnection::mergeSections
const MergeSections & mergeSections() const
Access merged data section inventory.
Definition: RootDataConnection.h:255
std::shared_ptr
SmartIF< IIncidentSvc >
ClassID.h
Gaudi::RootDataConnection::Tool::Sections
RootDataConnection::Sections Sections
Definition: RootDataConnection.h:199
Gaudi::RootDataConnection::ContainerSections
std::vector< ContainerSection > ContainerSections
Definition of container sections to handle merged files.
Definition: RootDataConnection.h:137
Gaudi::RootDataConnection::m_tool
std::unique_ptr< Tool > m_tool
Definition: RootDataConnection.h:233
Gaudi::RootDataConnection::Tool::dbs
StringVec & dbs() const
Definition: RootDataConnection.h:209
Gaudi::IDataConnection::m_name
std::string m_name
Connection name/identifier.
Definition: IIODataManager.h:27
gaudiComponentHelp.name
name
Definition: gaudiComponentHelp.py:28
Gaudi::RootDataConnection::file
TFile * file() const
Direct access to TFile structure.
Definition: RootDataConnection.h:247
GaudiMP.FdsRegistry.msg
tuple msg
Definition: FdsRegistry.py:8
Gaudi::RootDataConnection::Tool::poolRef
virtual RootRef poolRef(size_t) const
Internal overload to facilitate the access to POOL files.
Definition: RootDataConnection.h:224
Gaudi::RootDataConnection::seek
long long int seek(long long int, int) override
Seek on the file described by ioDesc. Arguments as in ::seek()
Definition: RootDataConnection.h:301
Gaudi::RootDataConnection::m_statistics
std::unique_ptr< TTreePerfStats > m_statistics
I/O read statistics from TTree.
Definition: RootDataConnection.h:153
Gaudi::RootDataConnection::m_clients
Clients m_clients
Client list.
Definition: RootDataConnection.h:175
Gaudi::RootDataConnection::ContainerSection::length
int length
The length of the section.
Definition: RootDataConnection.h:127
Gaudi::RootDataConnection::Tool::StringVec
RootDataConnection::StringVec StringVec
Definition: RootDataConnection.h:197
Gaudi::RootDataConnection::ContainerSection::start
int start
The start entry of the section.
Definition: RootDataConnection.h:125
Gaudi::RootDataConnection::Clients
std::set< const IInterface * > Clients
Client set.
Definition: RootDataConnection.h:143
Gaudi::RootConnectionSetup::msgSvc
MsgStream & msgSvc() const
Retrieve message service.
Definition: RootDataConnection.h:76
Gaudi::RootDataConnection::getLink
const std::string & getLink(int which) const
Access link name from saved index.
Definition: RootDataConnection.h:328
Gaudi::RootDataConnection::StringVec
std::vector< std::string > StringVec
Type definition for string maps.
Definition: RootDataConnection.h:131
Gaudi::RootConnectionSetup::cacheSize
int cacheSize
RootCnvSvc Property: Root data cache size.
Definition: RootDataConnection.h:61
std::map< std::string, TTree * >
GaudiPluginService.cpluginsvc.n
list n
Definition: cpluginsvc.py:217
Gaudi::RootDataConnection::Tool::ContainerSections
RootDataConnection::ContainerSections ContainerSections
Definition: RootDataConnection.h:203
Gaudi::RootObjectRefs
Persistent reference object containing all leafs and links corresponding to a Gaudi DataObject...
Definition: RootRefs.h:58
Gaudi::RootDataConnection::m_links
StringVec m_links
Map containing internal links names.
Definition: RootDataConnection.h:165
Gaudi::RootDataConnection::isConnected
bool isConnected() const override
Check if connected to data source.
Definition: RootDataConnection.h:249
Gaudi::RootDataConnection::ContainerSection::ContainerSection
ContainerSection()
Default constructor.
Definition: RootDataConnection.h:111
IIODataManager.h
Gaudi::RootDataConnection::m_params
ParamMap m_params
Parameter map for file parameters.
Definition: RootDataConnection.h:169
std::string
STL class.
compareRootHistos.ref
string ref
Definition: compareRootHistos.py:14
Gaudi::RootConnectionSetup::loadSection
std::string loadSection
RootCnvSvc Property: Root data cache size.
Definition: RootDataConnection.h:59
Gaudi::RootDataConnection::Tool::params
ParamMap & params() const
Definition: RootDataConnection.h:212
SmartIF::get
TYPE * get() const
Get interface pointer.
Definition: SmartIF.h:76
Gaudi::RootDataConnection::m_mergeFIDs
StringVec m_mergeFIDs
Map containing merge FIDs.
Definition: RootDataConnection.h:167
Gaudi::RootDataConnection::Tool::mergeSections
MergeSections & mergeSections() const
Definition: RootDataConnection.h:217
Gaudi::RootRef
Persistent reference object.
Definition: RootRefs.h:30
Gaudi::RootDataConnection::write
StatusCode write(const void *, int) override
Write root byte buffer to output stream.
Definition: RootDataConnection.h:299
RootRefs.h
StatusCode::FAILURE
Definition: StatusCode.h:29
Gaudi::RootDataConnection::Tool::sections
Sections & sections() const
Definition: RootDataConnection.h:215
IIncidentSvc.h
Gaudi::RootDataConnection::Tool
Helper class to facilitate an abstraction layer for reading POOL style files with this package...
Definition: RootDataConnection.h:195
Gaudi::RootConnectionSetup::learnEntries
int learnEntries
RootCnvSvc Property: ROOT cache learn entries.
Definition: RootDataConnection.h:63
StatusCode
This class is used for returning status codes from appropriate routines.
Definition: StatusCode.h:26
Gaudi::Units::m
constexpr double m
Definition: SystemOfUnits.h:93
Gaudi::RootConnectionSetup::m_msgSvc
std::unique_ptr< MsgStream > m_msgSvc
Reference to message service.
Definition: RootDataConnection.h:46
IInterface
Definition of the basic interface.
Definition: IInterface.h:234
SmartIF.h
Gaudi::RootDataConnection::getBranch
TBranch * getBranch(const std::string &section, const std::string &branch_name)
Access data branch by name: Get existing branch in read only mode.
Definition: RootDataConnection.h:307
Gaudi::RootDataConnection::Tool::ParamMap
RootDataConnection::ParamMap ParamMap
Definition: RootDataConnection.h:198
Gaudi::RootDataConnection::Tool::links
StringVec & links() const
Definition: RootDataConnection.h:211
Gaudi::RootDataConnection::m_conts
StringVec m_conts
Map containing external container names.
Definition: RootDataConnection.h:163
Gaudi::RootDataConnection::m_sections
Sections m_sections
Tree sections in TFile.
Definition: RootDataConnection.h:159
Gaudi::RootConnectionSetup::cacheBranches
StringVec cacheBranches
Vector of strings with branches to be cached for input files.
Definition: RootDataConnection.h:55
Gaudi::RootConnectionSetup::StringVec
std::vector< std::string > StringVec
Type definition for string maps.
Definition: RootDataConnection.h:52
IRegistry
The IRegistry represents the entry door to the environment any data object residing in a transient da...
Definition: IRegistry.h:22
Gaudi::RootDataConnection::LinkSections
std::vector< RootRef > LinkSections
Link sections definition.
Definition: RootDataConnection.h:141
Gaudi::RootDataConnection::Tool::MergeSections
RootDataConnection::MergeSections MergeSections
Definition: RootDataConnection.h:200
Gaudi::RootDataConnection::Tool::msgSvc
MsgStream & msgSvc() const
Definition: RootDataConnection.h:213
Gaudi::RootDataConnection::getCont
const std::string & getCont(int which) const
Access container name from saved index.
Definition: RootDataConnection.h:324
Gaudi::RootDataConnection::tool
Tool * tool() const
Access tool.
Definition: RootDataConnection.h:253
Gaudi::RootDataConnection::ContainerSection::ContainerSection
ContainerSection(int s, int l)
Initializing constructor.
Definition: RootDataConnection.h:113
Gaudi::RootConnectionSetup::vetoBranches
StringVec vetoBranches
Vector of strings with branches to NOT be cached for input files.
Definition: RootDataConnection.h:57
gaudirun.l
dictionary l
Definition: gaudirun.py:421
std::pair
Gaudi::RootDataConnection::mergeFIDs
const StringVec & mergeFIDs() const
Access merged FIDs.
Definition: RootDataConnection.h:257
std::unique_ptr::get
T get(T...args)
std::vector::size
T size(T...args)
std::set< const IInterface * >
Gaudi::RootDataConnection::ContainerSection::operator=
ContainerSection & operator=(const ContainerSection &s)
Assignment operator to copy objects.
Definition: RootDataConnection.h:117
std::vector< std::string >
Gaudi::RootDataConnection::Tool::ContainerSection
RootDataConnection::ContainerSection ContainerSection
Definition: RootDataConnection.h:202
Gaudi::RootDataConnection::isWritable
bool isWritable() const
Is the file writable?
Definition: RootDataConnection.h:251
std::unique_ptr< MsgStream >
Gaudi::IDataConnection
ABC describing basic data connection.
Definition: IIODataManager.h:24
Gaudi::RootDataConnection::ParamMap
std::vector< std::pair< std::string, std::string > > ParamMap
Type definition for the parameter map.
Definition: RootDataConnection.h:133
Gaudi::RootDataConnection::Tool::LinkSections
RootDataConnection::LinkSections LinkSections
Definition: RootDataConnection.h:201
Gaudi::RootConnectionSetup::incidentSvc
IIncidentSvc * incidentSvc() const
Retrieve incident service.
Definition: RootDataConnection.h:81
Gaudi::RootDataConnection::Tool::conts
StringVec & conts() const
Definition: RootDataConnection.h:210
Gaudi::RootDataConnection::Tool::refs
TTree * refs() const
Definition: RootDataConnection.h:208
Gaudi::RootDataConnection::m_setup
std::shared_ptr< RootConnectionSetup > m_setup
Reference to the setup structure.
Definition: RootDataConnection.h:151
std::vector::begin
T begin(T...args)
Gaudi::RootDataConnection::m_linkSects
LinkSections m_linkSects
Database link sections.
Definition: RootDataConnection.h:173
GaudiTesting.BaseTest.which
def which(executable)
Definition: BaseTest.py:547
Gaudi::RootDataConnection::msgSvc
MsgStream & msgSvc() const
Allow access to printer service.
Definition: RootDataConnection.h:146
gaudirun.s
string s
Definition: gaudirun.py:245
Gaudi::RootDataConnection::ContainerSection::ContainerSection
ContainerSection(const ContainerSection &s)
Copy constructor.
Definition: RootDataConnection.h:115
Gaudi::RootDataConnection::Tool::c
RootDataConnection * c
Pointer to containing data connection object.
Definition: RootDataConnection.h:206
Gaudi::RootDataConnection::MergeSections
std::map< std::string, ContainerSections > MergeSections
Definition of database section to handle merged files.
Definition: RootDataConnection.h:139
Gaudi::RootDataConnection::m_file
std::unique_ptr< TFile > m_file
Reference to ROOT file.
Definition: RootDataConnection.h:155
Gaudi::RootConnectionSetup
Definition: RootDataConnection.h:43
Gaudi::RootDataConnection::m_dbs
StringVec m_dbs
Map containing external database file names (fids)
Definition: RootDataConnection.h:161
Gaudi::RootDataConnection::Sections
std::map< std::string, TTree * > Sections
Definition of tree sections.
Definition: RootDataConnection.h:135
Gaudi::RootDataConnection::m_empty
std::string m_empty
Buffer for empty string reference.
Definition: RootDataConnection.h:177
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:107
DataObject
A DataObject is the base class of any identifiable object on any data store.
Definition: DataObject.h:30
Gaudi::RootDataConnection
Concrete implementation of the IDataConnection interface to access ROOT files.
Definition: RootDataConnection.h:92
Gaudi::RootDataConnection::m_refs
TTree * m_refs
Pointer to the reference tree.
Definition: RootDataConnection.h:157
Gaudi::RootDataConnection::read
StatusCode read(void *const, size_t) override
Read root byte buffer from input stream.
Definition: RootDataConnection.h:297
Gaudi
Helper functions to set/get the application return code.
Definition: __init__.py:1
Gaudi::RootDataConnection::ContainerSection
Internal helper class, which described a TBranch section in a ROOT file.
Definition: RootDataConnection.h:109
IIncidentSvc
The interface implemented by the IncidentSvc service.
Definition: IIncidentSvc.h:21
IOTest.start
tuple start
Definition: IOTest.py:88
Gaudi::RootDataConnection::Tool::linkSections
LinkSections & linkSections() const
Definition: RootDataConnection.h:216