| # Gaudi Framework, version v23r1 |

Home |  | Generated: Wed Feb 29 2012

Public Member Functions | Protected Types | Protected Attributes

# Gaudi::RootDataConnection::Tool Class Reference

Helper class to facilitate an abstraction layer for reading POOL style files with this package. More...

`#include <src/RootDataConnection.h>`

Inheritance diagram for Gaudi::RootDataConnection::Tool:
[legend]
Collaboration diagram for Gaudi::RootDataConnection::Tool:
[legend]

List of all members.

## Public Member Functions
TTree * | refs () const
StringVec & | dbs () const
StringVec & | conts () const
StringVec & | links () const
ParamMap & | params () const
MsgStream & | msgSvc () const
const std::string & | name () const
Sections & | sections () const
LinkSections & | linkSections () const
MergeSections & | mergeSections () const
virtual | ~Tool ()
| Default destructor.
virtual void | release ()
| Use releasePtr() helper to delete object.
virtual TBranch * | getBranch (const std::string &section, const std::string &n)=0
| Access data branch by name: Get existing branch in read only mode.
virtual RootRef | poolRef (size_t) const
| Internal overload to facilitate the access to POOL files.
virtual StatusCode | readRefs ()=0
| Read references section when opening data file.
virtual StatusCode | saveRefs ()=0
| Save references section when closing data file.
virtual int | loadRefs (const std::string &section, const std::string &cnt, unsigned long entry, RootObjectRefs &refs)=0
| Load references object.
## 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
RootDataConnection * | c
| Pointer to containing data connection object.

## 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 188 of file RootDataConnection.h.

## Member Typedef Documentation

typedef RootDataConnection::ContainerSection Gaudi::RootDataConnection::Tool::ContainerSection`[protected]`

Definition at line 195 of file RootDataConnection.h.

typedef RootDataConnection::ContainerSections Gaudi::RootDataConnection::Tool::ContainerSections`[protected]`

Definition at line 196 of file RootDataConnection.h.

typedef RootDataConnection::LinkSections Gaudi::RootDataConnection::Tool::LinkSections`[protected]`

Definition at line 194 of file RootDataConnection.h.

typedef RootDataConnection::MergeSections Gaudi::RootDataConnection::Tool::MergeSections`[protected]`

Definition at line 193 of file RootDataConnection.h.

typedef RootDataConnection::ParamMap Gaudi::RootDataConnection::Tool::ParamMap`[protected]`

Definition at line 191 of file RootDataConnection.h.

typedef RootDataConnection::Sections Gaudi::RootDataConnection::Tool::Sections`[protected]`

Definition at line 192 of file RootDataConnection.h.

typedef RootDataConnection::StringVec Gaudi::RootDataConnection::Tool::StringVec`[protected]`

Definition at line 190 of file RootDataConnection.h.

## Constructor & Destructor Documentation

virtual Gaudi::RootDataConnection::Tool::~Tool | ( | ) | `[inline, virtual]`

Default destructor.

Definition at line 213 of file RootDataConnection.h.

    {}

## Member Function Documentation

StringVec& Gaudi::RootDataConnection::Tool::conts | ( | ) | const`[inline]`

Definition at line 203 of file RootDataConnection.h.

    { return c->m_conts;      }

StringVec& Gaudi::RootDataConnection::Tool::dbs | ( | ) | const`[inline]`

Definition at line 202 of file RootDataConnection.h.

    { return c->m_dbs;        }

virtual TBranch* Gaudi::RootDataConnection::Tool::getBranch | ( | const std::string & | section,
|  | const std::string & | n
| ) |  | `[pure virtual]`

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

StringVec& Gaudi::RootDataConnection::Tool::links | ( | ) | const`[inline]`

Definition at line 204 of file RootDataConnection.h.

    { return c->m_links;      }

LinkSections& Gaudi::RootDataConnection::Tool::linkSections | ( | ) | const`[inline]`

Definition at line 209 of file RootDataConnection.h.

    { return c->m_linkSects;  }

virtual int Gaudi::RootDataConnection::Tool::loadRefs | ( | const std::string & | section,
|  | const std::string & | cnt,
|  | unsigned long | entry,
|  | RootObjectRefs & | refs
| ) |  | `[pure virtual]`

Load references object.

MergeSections& Gaudi::RootDataConnection::Tool::mergeSections | ( | ) | const`[inline]`

Definition at line 210 of file RootDataConnection.h.

    { return c->m_mergeSects; }

MsgStream& Gaudi::RootDataConnection::Tool::msgSvc | ( | ) | const`[inline]`

Definition at line 206 of file RootDataConnection.h.

    { return c->msgSvc();     }

const std::string& Gaudi::RootDataConnection::Tool::name | ( | ) | const`[inline]`

Definition at line 207 of file RootDataConnection.h.

    { return c->m_name;       }

ParamMap& Gaudi::RootDataConnection::Tool::params | ( | ) | const`[inline]`

Definition at line 205 of file RootDataConnection.h.

    { return c->m_params;     }

virtual RootRef Gaudi::RootDataConnection::Tool::poolRef | ( | size_t | ) | const`[inline, virtual]`

Internal overload to facilitate the access to POOL files.

Reimplemented in Gaudi::PoolTool.

Definition at line 219 of file RootDataConnection.h.

    { return RootRef(); }

virtual StatusCode Gaudi::RootDataConnection::Tool::readRefs | ( | ) | `[pure virtual]`

Read references section when opening data file.

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

TTree* Gaudi::RootDataConnection::Tool::refs | ( | ) | const`[inline]`

Definition at line 201 of file RootDataConnection.h.

    { return c->m_refs;       }

virtual void Gaudi::RootDataConnection::Tool::release | ( | ) | `[inline, virtual]`

Use releasePtr() helper to delete object.

Definition at line 215 of file RootDataConnection.h.

    { delete this; }

virtual StatusCode Gaudi::RootDataConnection::Tool::saveRefs | ( | ) | `[pure virtual]`

Save references section when closing data file.

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

Sections& Gaudi::RootDataConnection::Tool::sections | ( | ) | const`[inline]`

Definition at line 208 of file RootDataConnection.h.

    { return c->m_sections;   }

## Member Data Documentation

RootDataConnection* Gaudi::RootDataConnection::Tool::c`[protected]`

Pointer to containing data connection object.

Definition at line 199 of file RootDataConnection.h.

The documentation for this class was generated from the following file:

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r1/RootCnv/RootCnv/RootDataConnection.h

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines