The Gaudi Framework  master (594c33fa)
Gaudi::RootDataConnection::Tool Class Referenceabstract

#include <src/RootDataConnection.h>

Inheritance diagram for Gaudi::RootDataConnection::Tool:
Collaboration diagram for Gaudi::RootDataConnection::Tool:

Public Member Functions

TTree * refs () const
 
StringVecdbs () const
 
StringVecconts () const
 
StringVeclinks () const
 
ParamMapparams () const
 
MsgStreammsgSvc () const
 
IIncidentSvcincidentSvc () const
 
const std::stringname () const
 
Sectionssections () const
 
LinkSectionslinkSections () const
 
MergeSectionsmergeSections () const
 
virtual ~Tool ()=default
 Default destructor. More...
 
virtual TBranch * getBranch (std::string_view section, std::string_view n)=0
 Access data branch by name: Get existing branch in read only mode. More...
 
virtual RootRef poolRef (size_t) const
 Internal overload to facilitate the access to POOL files. More...
 
virtual StatusCode readRefs ()=0
 Read references section when opening data file. More...
 
virtual StatusCode saveRefs ()=0
 Save references section when closing data file. More...
 
virtual int loadRefs (std::string_view section, std::string_view cnt, unsigned long entry, RootObjectRefs &refs)=0
 Load references object. More...
 

Protected Types

typedef RootDataConnection::StringVec StringVec
 
typedef RootDataConnection::ParamMap ParamMap
 
typedef RootDataConnection::Sections Sections
 
typedef RootDataConnection::MergeSections MergeSections
 
typedef RootDataConnection::LinkSections LinkSections
 
typedef RootDataConnection::ContainerSection ContainerSection
 
typedef RootDataConnection::ContainerSections ContainerSections
 

Protected Attributes

RootDataConnectionc
 Pointer to containing data connection object. More...
 

Detailed Description

Helper class to facilitate an abstraction layer for reading POOL style files with this package. YES: This class obsoletes POOL.

Author
M.Frank
Version
1.0

Definition at line 212 of file RootDataConnection.h.

Member Typedef Documentation

◆ ContainerSection

◆ ContainerSections

◆ LinkSections

◆ MergeSections

◆ ParamMap

◆ Sections

◆ StringVec

Constructor & Destructor Documentation

◆ ~Tool()

virtual Gaudi::RootDataConnection::Tool::~Tool ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ conts()

StringVec& Gaudi::RootDataConnection::Tool::conts ( ) const
inline

Definition at line 228 of file RootDataConnection.h.

228 { return c->m_conts; }

◆ dbs()

StringVec& Gaudi::RootDataConnection::Tool::dbs ( ) const
inline

Definition at line 227 of file RootDataConnection.h.

227 { return c->m_dbs; }

◆ getBranch()

virtual TBranch* Gaudi::RootDataConnection::Tool::getBranch ( std::string_view  section,
std::string_view  n 
)
pure virtual

Access data branch by name: Get existing branch in read only mode.

Implemented in Gaudi::PoolTool, and Gaudi::RootTool.

◆ incidentSvc()

IIncidentSvc* Gaudi::RootDataConnection::Tool::incidentSvc ( ) const
inline

Definition at line 232 of file RootDataConnection.h.

232 { return c->incidentSvc(); }

◆ links()

StringVec& Gaudi::RootDataConnection::Tool::links ( ) const
inline

Definition at line 229 of file RootDataConnection.h.

229 { return c->m_links; }

◆ linkSections()

LinkSections& Gaudi::RootDataConnection::Tool::linkSections ( ) const
inline

Definition at line 235 of file RootDataConnection.h.

235 { return c->m_linkSects; }

◆ loadRefs()

virtual int Gaudi::RootDataConnection::Tool::loadRefs ( std::string_view  section,
std::string_view  cnt,
unsigned long  entry,
RootObjectRefs refs 
)
pure virtual

Load references object.

Implemented in Gaudi::PoolTool, and Gaudi::RootTool.

◆ mergeSections()

MergeSections& Gaudi::RootDataConnection::Tool::mergeSections ( ) const
inline

Definition at line 236 of file RootDataConnection.h.

236 { return c->m_mergeSects; }

◆ msgSvc()

MsgStream& Gaudi::RootDataConnection::Tool::msgSvc ( ) const
inline

Definition at line 231 of file RootDataConnection.h.

231 { return c->msgSvc(); }

◆ name()

const std::string& Gaudi::RootDataConnection::Tool::name ( ) const
inline

Definition at line 233 of file RootDataConnection.h.

233 { return c->m_name; }

◆ params()

ParamMap& Gaudi::RootDataConnection::Tool::params ( ) const
inline

Definition at line 230 of file RootDataConnection.h.

230 { return c->m_params; }

◆ poolRef()

virtual RootRef Gaudi::RootDataConnection::Tool::poolRef ( size_t  ) const
inlinevirtual

Internal overload to facilitate the access to POOL files.

Reimplemented in Gaudi::PoolTool.

Definition at line 243 of file RootDataConnection.h.

243 { return RootRef(); }

◆ readRefs()

virtual StatusCode Gaudi::RootDataConnection::Tool::readRefs ( )
pure virtual

Read references section when opening data file.

Implemented in Gaudi::RootTool, and Gaudi::PoolTool.

◆ refs()

TTree* Gaudi::RootDataConnection::Tool::refs ( ) const
inline

Definition at line 226 of file RootDataConnection.h.

226 { return c->m_refs; }

◆ saveRefs()

virtual StatusCode Gaudi::RootDataConnection::Tool::saveRefs ( )
pure virtual

Save references section when closing data file.

Implemented in Gaudi::RootTool, and Gaudi::PoolTool.

◆ sections()

Sections& Gaudi::RootDataConnection::Tool::sections ( ) const
inline

Definition at line 234 of file RootDataConnection.h.

234 { return c->m_sections; }

Member Data Documentation

◆ c

RootDataConnection* Gaudi::RootDataConnection::Tool::c
protected

Pointer to containing data connection object.

Definition at line 223 of file RootDataConnection.h.


The documentation for this class was generated from the following file:
Gaudi::RootDataConnection::m_params
ParamMap m_params
Parameter map for file parameters.
Definition: RootDataConnection.h:186
Gaudi::RootDataConnection::Tool::c
RootDataConnection * c
Pointer to containing data connection object.
Definition: RootDataConnection.h:223
Gaudi::RootDataConnection::m_dbs
StringVec m_dbs
Map containing external database file names (fids)
Definition: RootDataConnection.h:178
Gaudi::RootDataConnection::m_linkSects
LinkSections m_linkSects
Database link sections.
Definition: RootDataConnection.h:190
Gaudi::RootDataConnection::m_mergeSects
MergeSections m_mergeSects
Database section map for merged files.
Definition: RootDataConnection.h:188
Gaudi::IDataConnection::m_name
std::string m_name
Connection name/identifier.
Definition: IIODataManager.h:37
Gaudi::RootDataConnection::m_conts
StringVec m_conts
Map containing external container names.
Definition: RootDataConnection.h:180
Gaudi::RootDataConnection::incidentSvc
IIncidentSvc * incidentSvc() const
Definition: RootDataConnection.h:164
Gaudi::RootDataConnection::m_links
StringVec m_links
Map containing internal links names.
Definition: RootDataConnection.h:182
Gaudi::RootDataConnection::m_sections
Sections m_sections
Tree sections in TFile.
Definition: RootDataConnection.h:176
Gaudi::RootDataConnection::msgSvc
MsgStream & msgSvc() const
Allow access to printer service.
Definition: RootDataConnection.h:163
Gaudi::RootDataConnection::m_refs
TTree * m_refs
Pointer to the reference tree.
Definition: RootDataConnection.h:174