Gaudi::RootTool Class Reference

#include <src/RootTool.h>

Inheritance diagram for Gaudi::RootTool:

Collaboration diagram for Gaudi::RootTool:

Public Member Functions
	RootTool (RootDataConnection *con)
	Standard constructor. More...
TBranch *	getBranch (std::string_view section, std::string_view branch_name) override
	Access data branch by name: Get existing branch in read only mode. More...
int	loadRefs (std::string_view section, std::string_view cnt, unsigned long entry, RootObjectRefs &refs) override
	Load references object from file. More...
void	addParam (ParamMap &c, char *p)
	Helper function to read params table. More...
void	addEntry (StringVec &c, char *val)
	Helper function to read string tables. More...
template<class C , class F >
StatusCode	readBranch (TTree *t, const char *nam, C &v, F pmf)
	Helper function to read internal file tables. More...
bool	get (const string &dsc, pair< string, ContainerSection > &e)
	Analyze the Sections table entries. More...
void	analyzeMergeMap (StringVec &tmp)
	Build merge sections from the Sections table entries. More...
StatusCode	readRefs () override
	Read reference tables. More...
string	getEntry (const string &c)
	Helper function to convert string vectors to branch entries. More...
string	getParam (const pair< string, string > &p)
	Helper function to convert parameter vectors to branch entries. More...
template<class C , class F >
StatusCode	saveBranch (const char *nam, C &v, F pmf)
	Helper function to save internal tables. More...
StatusCode	saveRefs () override
	Save/update reference tables. More...
Public Member Functions inherited from Gaudi::RootDataConnection::Tool
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
	Default destructor. More...
virtual RootRef	poolRef (size_t) const
	Internal overload to facilitate the access to POOL files. More...

Additional Inherited Members
Protected Types inherited from Gaudi::RootDataConnection::Tool
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 inherited from Gaudi::RootDataConnection::Tool
RootDataConnection *	c
	Pointer to containing data connection object. More...

Detailed Description

Description:

Concrete implementation to read objects from POOL files.

Author

M.Frank

Version

1.0

Description:

Concrete implementation to read objects from ROOT files.

Author

M.Frank

Version

1.0

Definition at line 26 of file RootTool.h.

Constructor & Destructor Documentation

RootTool()

Gaudi::RootTool::RootTool ( RootDataConnection *  con )

inline

Standard constructor.

Definition at line 29 of file RootTool.h.

{ c = con; }

Member Function Documentation

addEntry()

void Gaudi::RootTool::addEntry ( StringVec &  c, char *  val  )

inline

Helper function to read string tables.

Definition at line 112 of file RootTool.h.

{ c.push_back( val ); }

addParam()

void Gaudi::RootTool::addParam ( ParamMap &  c, char *  p  )

inline

Helper function to read params table.

Definition at line 104 of file RootTool.h.

                                          {
      char* q = strchr( p, '=' );
      if ( q ) {
        *q = 0;
        c.emplace_back( p, ++q );
      }
    }

analyzeMergeMap()

void Gaudi::RootTool::analyzeMergeMap ( StringVec &  tmp )

inline

Build merge sections from the Sections table entries.

Definition at line 159 of file RootTool.h.

                                           {
      LinkSections&                  ls = linkSections();
      MergeSections&                 ms = mergeSections();
      pair<string, ContainerSection> e;
      MsgStream&                     msg = msgSvc();
      RootRef                        r;
      int                            cnt = 0;
      ls.clear();
      ms.clear();
      msg << MSG::VERBOSE;
      r.dbase = r.container = r.link = r.clid = r.svc = r.entry = 0;
      for ( const auto& i : tmp ) {
        if ( get( i, e ) ) {
          msg << "Added Merge Section:" << e.first << endmsg;
          ms[e.first].push_back( e.second );
          if ( e.first == "Links" )
            r.link = e.second.start;
          else if ( e.first == "Containers" )
            r.container = e.second.start;
          else if ( e.first == "Databases" )
            r.dbase = e.second.start;
          else if ( e.first == "Params" )
            r.svc = e.second.start;
        } else if ( i == "[END-OF-SECTION]" ) {
          r.entry = cnt;
          if ( msg.isActive() ) {
            msg << "Link Section [" << r.entry << "," << ls.size() << "] -> D:" << r.dbase << " C:" << r.container
                << " L:" << r.link << " P:" << r.svc << endmsg;
          }
          ls.push_back( r );
          cnt++;
        }
      }
    }

get()

bool Gaudi::RootTool::get ( const string &  dsc, pair< string, ContainerSection > &  e  )

inline

Analyze the Sections table entries.

Definition at line 140 of file RootTool.h.

                                                                     {
      if ( dsc != "[END-OF-SECTION]" ) {
        size_t id1 = dsc.find( "[CNT=" );
        size_t id2 = dsc.find( "[START=" );
        size_t id3 = dsc.find( "[LEN=" );
        if ( id1 != string::npos && id2 != string::npos && id3 != string::npos ) {
          string cnt            = dsc.substr( id1 + 5, id2 - 1 - 5 );
          int    section_start  = std::stoi( dsc.substr( id2 + 7, id3 - id2 - 8 ) );
          int    section_length = std::stoi( dsc.substr( id3 + 5, dsc.find( "]", id3 + 5 ) - id3 - 5 ) );
          e.first               = cnt;
          e.second              = ContainerSection( section_start, section_length );
          return true;
        }
      }
      e.first.clear();
      e.second = ContainerSection( -1, -1 );
      return false;
    }

getBranch()

TBranch* Gaudi::RootTool::getBranch ( std::string_view  section, std::string_view  branch_name  )

inlineoverridevirtual

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

Implements Gaudi::RootDataConnection::Tool.

Definition at line 31 of file RootTool.h.

                                                                                      {
      std::string n{branch_name};
      n += '.';
      for ( int i = 0, m = n.length() - 1; i < m; ++i )
        if ( !isalnum( n[i] ) ) n[i] = '_';
      TTree*   t = c->getSection( section );
      TBranch* b = t ? t->GetBranch( n.c_str() ) : nullptr;
      if ( !b ) b = t ? t->GetBranch( std::string{branch_name}.c_str() ) : nullptr;
      if ( b ) b->SetAutoDelete( kFALSE );
      return b;
    }

getEntry()

string Gaudi::RootTool::getEntry ( const string &  c )

inline

Helper function to convert string vectors to branch entries.

Definition at line 211 of file RootTool.h.

{ return c; }

getParam()

string Gaudi::RootTool::getParam ( const pair< string, string > &  p )

inline

Helper function to convert parameter vectors to branch entries.

Definition at line 213 of file RootTool.h.

{ return p.first + "=" + p.second; }

loadRefs()

int Gaudi::RootTool::loadRefs ( std::string_view  section, std::string_view  cnt, unsigned long  entry, RootObjectRefs &  refs  )

inlineoverridevirtual

Load references object from file.

Link manager:

Implements Gaudi::RootDataConnection::Tool.

Definition at line 43 of file RootTool.h.

                                                                                                                   {
      TBranch*        b     = getBranch( section, std::string{cnt} + "#R" );
      RootObjectRefs* prefs = &refs;
      if ( b ) {
        b->SetAddress( &prefs );
        int nb = b->GetEntry( entry );
        if ( nb >= 1 ) {
          const MergeSections& ms = c->mergeSections();
          if ( !ms.empty() ) {
            MsgStream& msg = msgSvc();
            msgSvc() << MSG::VERBOSE;
            pair<const RootRef*, const ContainerSection*> ls = c->getMergeSection( cnt, entry );
            if ( ls.first ) {
              if ( ls.first->dbase >= 0 ) {
                // Now patch the references and links 'en block' to be efficient
                // First the leafs from the TES
                if ( msg.isActive() ) {
                  msg << "Refs: LS [" << entry << "] -> " << ls.first->dbase << "," << ls.first->container << ","
                      << ls.first->link << "," << ls.first->entry << endmsg;
                }
                for ( size_t j = 0, n = refs.refs.size(); j < n; ++j ) {
                  RootRef& r = refs.refs[j];
                  if ( r.entry >= 0 && r.dbase >= 0 ) {
                    int db = r.dbase + ls.first->dbase;
                    if ( c->getDb( db ) == c->fid() ) {
                      if ( r.dbase ) r.dbase += ls.first->dbase;
                      if ( r.container ) r.container += ls.first->container;
                      if ( r.link ) r.link += ls.first->link;
                      const string& rc = c->getCont( r.container );
                      auto          k  = ms.find( rc );
                      if ( k != ms.end() ) {
                        const auto& cs = ( *k ).second;
                        r.entry        = ( ls.first->entry >= 0 && ls.first->entry < (int)cs.size() )
                                      ? cs[ls.first->entry].start + r.entry
                                      : -1;
                        if ( msg.isActive() ) {
                          msg << "Add link [" << r.entry << "," << ls.first->entry << "," << ls.first->container << ","
                              << r.container << "," << r.entry << "] to -> " << rc << endmsg;
                        }
                      } else {
                        msg << MSG::WARNING << c->fid() << "  [" << c->getDb( db ) << "] Evt:" << entry
                            << " Invalid link to " << rc << endmsg;
                        msg << MSG::VERBOSE;
                      }
                    }
                  }
                }
                std::for_each( std::begin( refs.links ), std::end( refs.links ),
                               [&]( int& i ) { i += ls.first->link; } );
              }
              return nb;
            }
            return -1;
          }
          return nb;
        }
      }
      return -1;
    }

readBranch()

template<class C , class F >

StatusCode Gaudi::RootTool::readBranch ( TTree *  t, const char *  nam, C &  v, F  pmf  )

inline

Helper function to read internal file tables.

Definition at line 115 of file RootTool.h.

                                                                    {
      char     text[2048];
      TBranch* b = t->GetBranch( nam );
      if ( b ) {
        TLeaf* l = b->GetLeaf( nam );
        if ( l ) {
          StatusCode sc = StatusCode::SUCCESS;
          b->SetAddress( text );
          msgSvc() << MSG::VERBOSE;
          for ( Long64_t i = 0, n = b->GetEntries(); i < n; ++i ) {
            if ( b->GetEntry( i ) > 0 ) {
              char* p = (char*)l->GetValuePointer();
              msgSvc() << "Add Value[" << b->GetName() << "]:" << p << endmsg;
              ( this->*pmf )( v, p );
            } else {
              sc = RootDataConnection::Status::ROOT_READ_ERROR;
            }
          }
          return sc;
        }
      }
      msgSvc() << MSG::ERROR << "Failed to read '" << nam << "' table." << endmsg;
      return RootDataConnection::Status::ROOT_READ_ERROR;
    }

readRefs()

StatusCode Gaudi::RootTool::readRefs ( )

inlineoverridevirtual

Read reference tables.

Implements Gaudi::RootDataConnection::Tool.

Definition at line 194 of file RootTool.h.

                                   {
      TTree*     t  = (TTree*)c->file()->Get( "Sections" );
      StatusCode sc = StatusCode::SUCCESS;
      StringVec  tmp;
      if ( t && !( sc = readBranch( t, "Sections", tmp, &RootTool::addEntry ) ).isSuccess() )
        return sc;
      else if ( refs() ) {
        analyzeMergeMap( tmp );
        if ( !( sc = readBranch( refs(), "Databases", dbs(), &RootTool::addEntry ) ).isSuccess() ) return sc;
        if ( !( sc = readBranch( refs(), "Containers", conts(), &RootTool::addEntry ) ).isSuccess() ) return sc;
        if ( !( sc = readBranch( refs(), "Links", links(), &RootTool::addEntry ) ).isSuccess() ) return sc;
        if ( !( sc = readBranch( refs(), "Params", params(), &RootTool::addParam ) ).isSuccess() ) return sc;
        return sc;
      }
      return StatusCode::FAILURE;
    }

saveBranch()

template<class C , class F >

StatusCode Gaudi::RootTool::saveBranch ( const char *  nam, C &  v, F  pmf  )

inline

Helper function to save internal tables.

Definition at line 216 of file RootTool.h.

                                                          {
      Long64_t             i, n;
      string               val, typ = nam;
      StatusCode           sc = StatusCode::SUCCESS;
      TDirectory::TContext ctxt( c->file() );
      TBranch*             b = refs()->GetBranch( nam );
      if ( !b ) b = refs()->Branch( nam, 0, ( typ + "/C" ).c_str() );
      if ( b ) {
        for ( i = b->GetEntries(), n = Long64_t( v.size() ); i < n; ++i ) {
          val = ( this->*pmf )( v[size_t( i )] );
          b->SetAddress( (char*)val.c_str() );
          msgSvc() << MSG::VERBOSE << "Save Value[" << b->GetName() << "]:" << val << endmsg;
          if ( b->Fill() < 0 ) sc = StatusCode::FAILURE;
        }
        return sc;
      }
      return StatusCode::FAILURE;
    }

saveRefs()

StatusCode Gaudi::RootTool::saveRefs ( )

inlineoverridevirtual

Save/update reference tables.

Implements Gaudi::RootDataConnection::Tool.

Definition at line 235 of file RootTool.h.

                                   {
      if ( refs() ) {
        if ( !saveBranch( "Databases", dbs(), &RootTool::getEntry ).isSuccess() ) return StatusCode::FAILURE;
        if ( !saveBranch( "Containers", conts(), &RootTool::getEntry ).isSuccess() ) return StatusCode::FAILURE;
        if ( !saveBranch( "Links", links(), &RootTool::getEntry ).isSuccess() ) return StatusCode::FAILURE;
        if ( !saveBranch( "Params", params(), &RootTool::getParam ).isSuccess() ) return StatusCode::FAILURE;
        return StatusCode::SUCCESS;
      }
      return StatusCode::FAILURE;
    }

---

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

• RootCnv/src/RootTool.h