Service to create a root-based D3PD. More...

#include <RootD3PDSvc.h>

Inheritance diagram for D3PD::RootD3PDSvc:

Collaboration diagram for D3PD::RootD3PDSvc:

Public Member Functions
	RootD3PDSvc (const std::string &name, ISvcLocator *svcloc)
	Constructor. More...

virtual StatusCode	initialize () override
	Standard Gaudi initialize method. More...

virtual StatusCode	finalize () override
	Standard Gaudi finalize method. More...

virtual StatusCode	stop () override
	Standard Gaudi stop method. More...

virtual StatusCode	make (const std::string &name, ID3PD *&d3pd) override
	Create a new D3PD tree. More...

Private Member Functions
	RootD3PDSvc (const RootD3PDSvc &)

RootD3PDSvc &	operator= (const RootD3PDSvc &)

Static Private Member Functions
static void	cleanup ()
	Make sure all files are closed before exiting, to prevent crashes. More...

Private Attributes
bool	m_doBranchRef
	Property: If true, then add BranchRef info to the tuple. More...

std::string	m_masterTree
	Property: Name of the master tree. More...

std::string	m_indexMajor
	Property: Major variable name for index making, or null. More...

std::string	m_indexMinor
	Property: Minor variable name for index making, or null. More...

int	m_basketSize
	Property: Basket buffer size, or -1 to use the Root default. More...

int	m_entryOffsetLen
	Property: Basket entry offset buffer size, or -1 to use the Root default. More...

long long	m_autoFlush
	Property: Value to set for ROOT's AutoFlush parameter. More...

std::vector< std::string >	m_allowedNames
	Property: Allowed names for the created D3PD. More...

std::vector< std::string >	m_vetoedNames
	Property: Vetoed names for the created D3PD. More...

ServiceHandle< ITHistSvc >	m_histSvc
	Property: Gaudi THistSvc. More...

std::vector< std::unique_ptr< RootD3PD > >	m_d3pds
	Remember all the tuples we've made. More...

Detailed Description

Service to create a root-based D3PD.

Definition at line 37 of file RootD3PDSvc.h.

Constructor & Destructor Documentation

◆ RootD3PDSvc() [1/2]

D3PD::RootD3PDSvc::RootD3PDSvc	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Constructor.

Parameters

name	Service name.
svcloc	Service locator.

Definition at line 32 of file RootD3PDSvc.cxx.

   : base_class (name, svcloc),
     m_histSvc ("THistSvc", name)
 {
   // See comments on cleanup().
   std::atexit (cleanup);
  
   declareProperty ("HistSvc",        m_histSvc);
   declareProperty ("DoBranchRef",    m_doBranchRef = true);
   declareProperty ("MasterTree",     m_masterTree = "CollectionTree");
   declareProperty ("IndexMajor",     m_indexMajor = "RunNumber");
   declareProperty ("IndexMinor",     m_indexMinor = "EventNumber");
   declareProperty ("BasketSize",     m_basketSize = 32768);
   declareProperty ("EntryOffsetLen", m_entryOffsetLen = 512);
   declareProperty ("AutoFlush",      m_autoFlush = -1,
                    "Value to set for ROOT's AutoFlush parameter. "
                    "(Tells how often the tree baskets will be flushed.) "
                    "0 disables flushing. "
                    "-1 (default) makes no changes to what THistSvc did. "
                    "Any other negative number gives the number of bytes "
                    "after which to flush. "
                    "A positive number gives the number of entries after which "
                    "to flush.");
   declareProperty ("AllowedNames",   m_allowedNames,
                    "Variable names allowed in the output D3PDs. An empty list "
                    "means that all variable names are allowed. Regular expressions "
                    "are allowed.");
   declareProperty ("VetoedNames",    m_vetoedNames,
                    "Variable names that are not allowed to end up in the "
                    "created D3PDs. Regular expressions are allowed.");
 }

◆ RootD3PDSvc() [2/2]

D3PD::RootD3PDSvc::RootD3PDSvc ( const RootD3PDSvc & )

private

Member Function Documentation

◆ cleanup()

void D3PD::RootD3PDSvc::cleanup ( )

staticprivate

Make sure all files are closed before exiting, to prevent crashes.

Root files are normally closed by THistSvc::finalize().

However, if we get an error during initialization, then the program will exit without running the finalize() methods. In that case, the root files will get closed when global destructors are run. But by that time, some of the root objects needed to perform the close may have already been deleted, leading to a crash.

To avoid this, we register this method with atexit(); we just loop through all existing root files and try to close them all.

Definition at line 80 of file RootD3PDSvc.cxx.

 {
   // Sometimes gDirectory is invalid at this point...
   gDirectory = gROOT;
   TIter it (gROOT->GetListOfFiles());
   while (TObject* o = it.Next()) {
     if (TFile* f = dynamic_cast<TFile*> (o))
       f->Close();
   }
 }

◆ finalize()

StatusCode D3PD::RootD3PDSvc::finalize ( )

overridevirtual

Standard Gaudi finalize method.

Definition at line 106 of file RootD3PDSvc.cxx.

 {
   return StatusCode::SUCCESS;
 }

◆ initialize()

StatusCode D3PD::RootD3PDSvc::initialize ( )

overridevirtual

Standard Gaudi initialize method.

Definition at line 95 of file RootD3PDSvc.cxx.

 {
   CHECK( AthService::initialize() );
   CHECK( m_histSvc.retrieve() );
   return StatusCode::SUCCESS;
 }

◆ make()

StatusCode D3PD::RootD3PDSvc::make	(	const std::string &	name,
		ID3PD *&	d3pd
	)

overridevirtual

Create a new D3PD tree.

Parameters

name	The name of the new tree. If the name contains a slash, it is interpreted as STREAM/NAME. If the stream name contains a colon, then the part of the name before the colon is the ‘parent’ stream name; this is used to locate the master tree.
d3pd[out]	The created tree.
name	The name of the new tree. If the name contains a slash, it is interpreted as STREAM/NAME. If the stream name is of the form ‘pool:FILE’, then this is a request to put the new tree in the given pool file. If the the stream name otherwise contains a colon, then the part of the name before the colon is the ‘parent’ stream name; this is used to locate the master tree.
d3pd[out]	The created tree.

Definition at line 175 of file RootD3PDSvc.cxx.

 {
   std::string tname = name;
   std::string::size_type ipos = name.rfind ('/');
   std::string master = m_masterTree;
   std::string poolfile;
   if (ipos != std::string::npos) {
     tname = name.substr (ipos+1);
     if (!master.empty()) {
       std::string sname = name.substr (0, ipos+1);
       std::string::size_type jpos = sname.find (':');
       if (sname.substr (0, jpos) == "pool" ||
           sname.substr (0, jpos) == "/pool")
       {
         poolfile = sname.substr (jpos+1, std::string::npos);
         if (!poolfile.empty() && poolfile[poolfile.size()-1] == '/')
           poolfile.erase (poolfile.size()-1);
       }
       else {
         if (jpos != std::string::npos){
           sname.erase(jpos,sname.size()-jpos-1);
         }
         master = sname + master;
       }
     }
   }
   TTree* tree = new TTree (tname.c_str(), tname.c_str());
  
   if (m_doBranchRef)
     tree->BranchRef();
   if (m_autoFlush != -1)
     tree->SetAutoFlush (m_autoFlush);
   auto rd3pd = std::make_unique<RootD3PD>
     (tree, master,
      m_allowedNames, m_vetoedNames,
      m_basketSize, m_entryOffsetLen);
  
   if (!poolfile.empty())
     rd3pd->setPoolFile (poolfile);
   else
     CHECK( m_histSvc->regTree (name, tree) );
  
   d3pd = rd3pd.get();
   m_d3pds.push_back (std::move (rd3pd));
   return StatusCode::SUCCESS;
 }

◆ operator=()

RootD3PDSvc& D3PD::RootD3PDSvc::operator= ( const RootD3PDSvc & )

private

◆ stop()

StatusCode D3PD::RootD3PDSvc::stop ( )

overridevirtual

Standard Gaudi stop method.

Definition at line 115 of file RootD3PDSvc.cxx.

 {
   // Run through all the trees we've made.
   for (size_t i = 0; i < m_d3pds.size(); i++) {
     RootD3PD* d3pd = m_d3pds[i].get();
  
     // Make an index if requested.
     if (!m_indexMajor.empty())
       d3pd->tree()->BuildIndex (m_indexMajor.c_str(), m_indexMinor.c_str());
  
     // Was there a master tree specified?
     if (!d3pd->master().empty()) {
       // Yes --- try to find it
       TDirectory* dir = d3pd->tree()->GetDirectory();
       TTree* master =
         dynamic_cast<TTree*> (dir->Get (d3pd->master().c_str()));
       if (!master && d3pd->tree()->GetEntries() > 0)
         CHECK( m_histSvc->getTree (d3pd->master(), master) );
       if (master) {
         // Make an index for the master if needed.
         if (!master->GetTreeIndex()) {
           // AANTupleStream will leave branch addresses in the master
           // tree pointing at dead objects.
           master->ResetBranchAddresses();
  
           master->BuildIndex (m_indexMajor.c_str(), m_indexMinor.c_str());
         }
  
         // Make this tree a friend of the master.
         master->AddFriend (d3pd->tree());
       }
     }
  
     {
       TDirectory::TContext ctx (gDirectory, d3pd->tree()->GetDirectory());
       d3pd->tree()->Write();
     }
   }
  
   // Get rid of the RootD3PD wrappers.
   // (Doesn't delete the root trees themselves.)
   m_d3pds.clear();
  
   return StatusCode::SUCCESS;
 }

Member Data Documentation

◆ m_allowedNames

std::vector< std::string > D3PD::RootD3PDSvc::m_allowedNames

private

Property: Allowed names for the created D3PD.

Definition at line 104 of file RootD3PDSvc.h.

◆ m_autoFlush

long long D3PD::RootD3PDSvc::m_autoFlush

private

Property: Value to set for ROOT's AutoFlush parameter.

(Tells how often the tree baskets will be flushed.) 0 disables flushing. -1 (default) makes no changes to what THistSvc did. Any other negative number gives the number of bytes after which to flush. A positive number gives the number of entries after which to flush.

Definition at line 101 of file RootD3PDSvc.h.

◆ m_basketSize

int D3PD::RootD3PDSvc::m_basketSize

private

Property: Basket buffer size, or -1 to use the Root default.

Definition at line 90 of file RootD3PDSvc.h.

◆ m_d3pds

std::vector<std::unique_ptr<RootD3PD> > D3PD::RootD3PDSvc::m_d3pds

private

Remember all the tuples we've made.

Definition at line 113 of file RootD3PDSvc.h.

◆ m_doBranchRef

bool D3PD::RootD3PDSvc::m_doBranchRef

private

Property: If true, then add BranchRef info to the tuple.

Definition at line 77 of file RootD3PDSvc.h.

◆ m_entryOffsetLen

int D3PD::RootD3PDSvc::m_entryOffsetLen

private

Property: Basket entry offset buffer size, or -1 to use the Root default.

Definition at line 93 of file RootD3PDSvc.h.

◆ m_histSvc

ServiceHandle<ITHistSvc> D3PD::RootD3PDSvc::m_histSvc

private

Property: Gaudi THistSvc.

Definition at line 110 of file RootD3PDSvc.h.

◆ m_indexMajor

std::string D3PD::RootD3PDSvc::m_indexMajor

private

Property: Major variable name for index making, or null.

Definition at line 85 of file RootD3PDSvc.h.

◆ m_indexMinor

std::string D3PD::RootD3PDSvc::m_indexMinor

private

Property: Minor variable name for index making, or null.

Definition at line 87 of file RootD3PDSvc.h.

◆ m_masterTree

std::string D3PD::RootD3PDSvc::m_masterTree

private

Property: Name of the master tree.

If set, then this tree will be made a friend of the master. The master tree will also get an index built.

Definition at line 82 of file RootD3PDSvc.h.

◆ m_vetoedNames

std::vector< std::string > D3PD::RootD3PDSvc::m_vetoedNames

private

Property: Vetoed names for the created D3PD.

Definition at line 107 of file RootD3PDSvc.h.

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

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RootD3PDSvc() [1/2]

◆ RootD3PDSvc() [2/2]

Member Function Documentation

◆ cleanup()

◆ finalize()

◆ initialize()

◆ make()

◆ operator=()

◆ stop()

Member Data Documentation

◆ m_allowedNames

◆ m_autoFlush

◆ m_basketSize

◆ m_d3pds

◆ m_doBranchRef

◆ m_entryOffsetLen

◆ m_histSvc

◆ m_indexMajor

◆ m_indexMinor

◆ m_masterTree

◆ m_vetoedNames