#include "RootInputTree.h"

Public Types
using	BranchMap = input::BranchMap

using	EntryNumber = input::EntryNumber

using	EntryNumbers = input::EntryNumbers

Public Member Functions
	RootInputTree (cet::exempt_ptr< TFile >, BranchType, int64_t saveMemoryObjectThreshold, cet::exempt_ptr< RootInputFile >, bool compactSubRunRanges=false, bool missingOK=false)

	RootInputTree (RootInputTree const &)=delete

RootInputTree &	operator= (RootInputTree const &)=delete

	operator bool () const

bool	isValid () const

bool	hasBranch (std::string const &branchName) const

void	addBranch (BranchKey const &, BranchDescription const &)

void	dropBranch (std::string const &branchName)

bool	next ()

bool	previous ()

bool	current (EntryNumbers const &numbers)

void	rewind ()

EntryNumber	entryNumber () const

EntryNumber	entries () const

void	setEntryNumber (EntryNumber theEntryNumber)

void	fillGroups (Principal &p)

std::unique_ptr< DelayedReader >	makeDelayedReader (FileFormatVersion, cet::exempt_ptr< BranchIDLists const > branchIDLists, BranchType, std::vector< EntryNumber > const &entrySet, EventID)

std::unique_ptr< DelayedReader >	makeDelayedReader (FileFormatVersion, sqlite3 *inputDB, cet::exempt_ptr< BranchIDLists const > branchIDLists, BranchType, std::vector< EntryNumber > const &entrySet, EventID)

std::unique_ptr< BranchMapper >	makeBranchMapper () const

template<typename AUX >
AUX	getAux (EntryNumber const entry)

template<typename AUX >
std::unique_ptr< RangeSetHandler >	fillAux (FileFormatVersion const fileFormatVersion, EntryNumbers const &entries, FileIndex const &fileIndex, sqlite3 *db, std::string const &filename, AUX &aux)

TTree const *	tree () const

TTree const *	metaTree () const

void	setCacheSize (unsigned int cacheSize) const

void	setTreeMaxVirtualSize (int treeMaxVirtualSize)

TBranch *	productProvenanceBranch () const

Private Attributes
cet::exempt_ptr< TFile >	filePtr_

TTree *	tree_ {nullptr}

TTree *	metaTree_ {nullptr}

BranchType	branchType_

int64_t const	saveMemoryObjectThreshold_

TBranch *	auxBranch_ {nullptr}

TBranch *	productProvenanceBranch_ {nullptr}

EntryNumber	entries_ {0}

EntryNumber	entryNumber_ {-1}

BranchMap	branches_ {}

cet::exempt_ptr< RootInputFile >	primaryFile_

bool const	compactSubRunRanges_

Detailed Description

Definition at line 74 of file RootInputTree.h.

Member Typedef Documentation

using art::RootInputTree::BranchMap = input::BranchMap

Definition at line 76 of file RootInputTree.h.

using art::RootInputTree::EntryNumber = input::EntryNumber

Definition at line 77 of file RootInputTree.h.

using art::RootInputTree::EntryNumbers = input::EntryNumbers

Definition at line 78 of file RootInputTree.h.

Constructor & Destructor Documentation

art::RootInputTree::RootInputTree	(	cet::exempt_ptr< TFile >	filePtr,
		BranchType	branchType,
		int64_t	saveMemoryObjectThreshold,
		cet::exempt_ptr< RootInputFile >	primaryFile,
		bool	compactSubRunRanges = `false`,
		bool	missingOK = `false`
	)

Definition at line 17 of file RootInputTree.cc.

References auxBranch_, branchType_, art::BranchTypeToAuxiliaryBranchName(), art::BranchTypeToMetaDataTreeName(), art::BranchTypeToProductTreeName(), art::BranchTypeToString(), compactSubRunRanges_, entries_, filePtr_, art::errors::FileReadError, isValid(), metaTree_, primaryFile_, productProvenanceBranch_, art::productProvenanceBranchName(), saveMemoryObjectThreshold_, and tree_.

     : filePtr_{filePtr}
     , branchType_{branchType}
     , saveMemoryObjectThreshold_{saveMemoryObjectThreshold}
     , primaryFile_{primaryFile}
     , compactSubRunRanges_{compactSubRunRanges}
   {
     if (filePtr_) {
       tree_ = static_cast<TTree*>(
         filePtr->Get(BranchTypeToProductTreeName(branchType).c_str()));
       metaTree_ = static_cast<TTree*>(
         filePtr->Get(BranchTypeToMetaDataTreeName(branchType).c_str()));
     }
     if (tree_) {
       auxBranch_ =
         tree_->GetBranch(BranchTypeToAuxiliaryBranchName(branchType_).c_str());
       entries_ = tree_->GetEntries();
     }
     if (metaTree_) {
       productProvenanceBranch_ =
         metaTree_->GetBranch(productProvenanceBranchName(branchType_).c_str());
     }
     if (!(missingOK || isValid())) {
       throw Exception(errors::FileReadError)
         << "RootInputTree for branch type " << BranchTypeToString(branchType)
         << " could not be initialized correctly from input file.\n";
     }
   }

art::RootInputTree::RootInputTree ( RootInputTree const & )

delete

Member Function Documentation

void art::RootInputTree::addBranch	(	BranchKey const &	key,
		BranchDescription const &	pd
	)

Definition at line 67 of file RootInputTree.cc.

References branches_, art::BranchDescription::branchName(), isValid(), art::BranchDescription::present(), and tree_.

   {
     assert(isValid());
     TBranch* branch = tree_->GetBranch(pd.branchName().c_str());
     assert(pd.present() == (branch != nullptr));
     input::BranchInfo info{pd, branch};
     branches_.emplace(key, std::move(info));
   }

bool art::RootInputTree::current ( EntryNumbers const & numbers )

inline

Definition at line 108 of file RootInputTree.h.

     {
       assert(!numbers.empty());
       return std::all_of(numbers.cbegin(), numbers.cend(), [this](auto entry) {
         return (entry < entries_) && (entry >= 0);
       });
     }

void art::RootInputTree::dropBranch ( std::string const & branchName )

Definition at line 77 of file RootInputTree.cc.

References branches_, compactSubRunRanges_, entries(), makeDelayedReader(), primaryFile_, saveMemoryObjectThreshold_, and tree_.

   {
     TBranch* branch = tree_->GetBranch(branchName.c_str());
     if (!branch) {
       return;
     }
     TObjArray* leaves = tree_->GetListOfLeaves();
     int entries = leaves->GetEntries();
     for (int i = 0; i < entries; ++i) {
       auto leaf = reinterpret_cast<TLeaf*>((*leaves)[i]);
       if (leaf == nullptr) {
         continue;
       }
       TBranch* br = leaf->GetBranch();
       if (br == nullptr) {
         continue;
       }
       if (br->GetMother() == branch) {
         leaves->Remove(leaf);
       }
     }
     leaves->Compress();
     tree_->GetListOfBranches()->Remove(branch);
     tree_->GetListOfBranches()->Compress();
     delete branch;
   }

EntryNumber art::RootInputTree::entries ( ) const

inline

Definition at line 127 of file RootInputTree.h.

Referenced by dropBranch().

     {
       return entries_;
     }

EntryNumber art::RootInputTree::entryNumber ( ) const

inline

Definition at line 122 of file RootInputTree.h.

     {
       return entryNumber_;
     }

template<typename AUX >

std::unique_ptr<RangeSetHandler> art::RootInputTree::fillAux	(	FileFormatVersion const	fileFormatVersion,
		EntryNumbers const &	entries,
		FileIndex const &	fileIndex,
		sqlite3 *	db,
		std::string const &	filename,
		AUX &	aux
	)

inline

Definition at line 186 of file RootInputTree.h.

References e, art::detail::mergeAuxiliary(), art::detail::rangeSetFromFileIndex(), art::detail::resolveRangeSet(), art::detail::resolveRangeSetInfo(), and art::FileFormatVersion::value_.

     {
       auto auxResult = getAux<AUX>(entries[0]);
       if (fileFormatVersion.value_ < 9) {
         auxResult.setRangeSetID(-1u);
         auto const& rs = detail::rangeSetFromFileIndex(
           fileIndex, auxResult.id(), compactSubRunRanges_);
         std::swap(aux, auxResult);
         return std::make_unique<ClosedRangeSetHandler>(rs);
       }
 
       auto resolve_info = [db, &filename](auto const id,
                                           bool const compactSubRunRanges) {
         return detail::resolveRangeSetInfo(
           db, filename, AUX::branch_type, id, compactSubRunRanges);
       };
 
       auto rangeSetInfo =
         resolve_info(auxResult.rangeSetID(), compactSubRunRanges_);
       for (auto i = entries.cbegin() + 1, e = entries.cend(); i != e; ++i) {
         auto const& tmpAux = getAux<AUX>(*i);
         detail::mergeAuxiliary(auxResult, tmpAux);
         rangeSetInfo.update(
           resolve_info(tmpAux.rangeSetID(), compactSubRunRanges_),
           compactSubRunRanges_);
       }
 
       auxResult.setRangeSetID(-1u); // Range set of new auxiliary is invalid
       std::swap(aux, auxResult);
       return std::make_unique<ClosedRangeSetHandler>(
         resolveRangeSet(rangeSetInfo));
     }

void art::RootInputTree::fillGroups ( Principal & p )

inline

Definition at line 135 of file RootInputTree.h.

References art::Principal::fillGroup().

     {
       if ((metaTree_ == nullptr) || (metaTree_->GetNbranches() == 0)) {
         return;
       }
       // Loop over provenance
       for (auto const& b : branches_) {
         p.fillGroup(b.second.branchDescription_);
       }
     }

template<typename AUX >

AUX art::RootInputTree::getAux ( EntryNumber const entry )

inline

Definition at line 174 of file RootInputTree.h.

References art::input::getEntry().

     {
       auto aux = std::make_unique<AUX>();
       auto pAux = aux.get();
       auxBranch_->SetAddress(&pAux);
       setEntryNumber(entry);
       input::getEntry(auxBranch_, entry);
       return *aux;
     }

bool art::RootInputTree::hasBranch ( std::string const & branchName ) const

Definition at line 61 of file RootInputTree.cc.

References tree_.

   {
     return tree_->GetBranch(branchName.c_str()) != nullptr;
   }

bool art::RootInputTree::isValid ( ) const

Definition at line 52 of file RootInputTree.cc.

References auxBranch_, metaTree_, productProvenanceBranch_, and tree_.

Referenced by addBranch(), and RootInputTree().

   {
     if ((metaTree_ == nullptr) || (metaTree_->GetNbranches() == 0)) {
       return tree_ && auxBranch_ && (tree_->GetNbranches() == 1);
     }
     return tree_ && auxBranch_ && metaTree_ && productProvenanceBranch_;
   }

std::unique_ptr< BranchMapper > art::RootInputTree::makeBranchMapper ( ) const

Definition at line 166 of file RootInputTree.cc.

References entryNumber_, and productProvenanceBranch_.

   {
     return std::make_unique<BranchMapperWithReader>(productProvenanceBranch_,
                                                     entryNumber_);
   }

std::unique_ptr<DelayedReader> art::RootInputTree::makeDelayedReader	(	FileFormatVersion	,
		cet::exempt_ptr< BranchIDLists const >	branchIDLists,
		BranchType	,
		std::vector< EntryNumber > const &	entrySet,
		EventID
	)

Referenced by dropBranch().

std::unique_ptr<DelayedReader> art::RootInputTree::makeDelayedReader	(	FileFormatVersion	,
		sqlite3 *	inputDB,
		cet::exempt_ptr< BranchIDLists const >	branchIDLists,
		BranchType	,
		std::vector< EntryNumber > const &	entrySet,
		EventID
	)

TTree const* art::RootInputTree::metaTree ( ) const

inline

Definition at line 230 of file RootInputTree.h.

     {
       return metaTree_;
     }

bool art::RootInputTree::next ( )

inline

Definition at line 97 of file RootInputTree.h.

Referenced by art::RootInputFile::nextEventEntry().

     {
       return ++entryNumber_ < entries_;
     }

art::RootInputTree::operator bool ( ) const

inlineexplicit

Definition at line 89 of file RootInputTree.h.

89 { return isValid(); }

art::RootInputTree::isValid

bool isValid() const

Definition: RootInputTree.cc:52

RootInputTree& art::RootInputTree::operator= ( RootInputTree const & )

delete

bool art::RootInputTree::previous ( )

inline

Definition at line 102 of file RootInputTree.h.

     {
       return --entryNumber_ >= 0;
     }

TBranch* art::RootInputTree::productProvenanceBranch ( ) const

inline

Definition at line 239 of file RootInputTree.h.

     {
       return productProvenanceBranch_;
     }

void art::RootInputTree::rewind ( )

inline

Definition at line 117 of file RootInputTree.h.

Referenced by art::RootInputFile::rewind().

     {
       entryNumber_ = 0;
     }

void art::RootInputTree::setCacheSize ( unsigned int cacheSize ) const

Definition at line 139 of file RootInputTree.cc.

References tree_.

   {
     tree_->SetCacheSize(static_cast<Long64_t>(cacheSize));
   }

void art::RootInputTree::setEntryNumber ( EntryNumber theEntryNumber )

Definition at line 153 of file RootInputTree.cc.

References entryNumber_, and tree_.

   {
     // Note: An entry number of -1 is ok, this can be used
     //       to put the tree an an invalid entry.
     entryNumber_ = theEntryNumber;
     auto err = tree_->LoadTree(theEntryNumber);
     if (err == -2) {
       // FIXME: Throw an error here!
       // FIXME: -2 means entry number too big.
     }
   }

void art::RootInputTree::setTreeMaxVirtualSize ( int treeMaxVirtualSize )

Definition at line 145 of file RootInputTree.cc.

References tree_.

   {
     if (treeMaxVirtualSize >= 0) {
       tree_->SetMaxVirtualSize(static_cast<Long64_t>(treeMaxVirtualSize));
     }
   }

TTree const* art::RootInputTree::tree ( ) const

inline

Definition at line 225 of file RootInputTree.h.

     {
       return tree_;
     }

Member Data Documentation

TBranch* art::RootInputTree::auxBranch_ {nullptr}

private

Definition at line 253 of file RootInputTree.h.

Referenced by isValid(), and RootInputTree().

BranchMap art::RootInputTree::branches_ {}

private

Definition at line 257 of file RootInputTree.h.

Referenced by addBranch(), and dropBranch().

BranchType art::RootInputTree::branchType_

private

Definition at line 251 of file RootInputTree.h.

Referenced by RootInputTree().

bool const art::RootInputTree::compactSubRunRanges_

private

Definition at line 259 of file RootInputTree.h.

Referenced by dropBranch(), and RootInputTree().

EntryNumber art::RootInputTree::entries_ {0}

private

Definition at line 255 of file RootInputTree.h.

Referenced by RootInputTree().

EntryNumber art::RootInputTree::entryNumber_ {-1}

private

Definition at line 256 of file RootInputTree.h.

Referenced by makeBranchMapper(), and setEntryNumber().

cet::exempt_ptr<TFile> art::RootInputTree::filePtr_

private

Definition at line 245 of file RootInputTree.h.

Referenced by RootInputTree().

TTree* art::RootInputTree::metaTree_ {nullptr}

private

Definition at line 250 of file RootInputTree.h.

Referenced by isValid(), and RootInputTree().

cet::exempt_ptr<RootInputFile> art::RootInputTree::primaryFile_

private

Definition at line 258 of file RootInputTree.h.

Referenced by dropBranch(), and RootInputTree().

TBranch* art::RootInputTree::productProvenanceBranch_ {nullptr}

private

Definition at line 254 of file RootInputTree.h.

Referenced by isValid(), makeBranchMapper(), and RootInputTree().

int64_t const art::RootInputTree::saveMemoryObjectThreshold_

private

Definition at line 252 of file RootInputTree.h.

Referenced by dropBranch(), and RootInputTree().

TTree* art::RootInputTree::tree_ {nullptr}

private

Definition at line 249 of file RootInputTree.h.

Referenced by addBranch(), dropBranch(), hasBranch(), isValid(), RootInputTree(), setCacheSize(), setEntryNumber(), and setTreeMaxVirtualSize().

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

art/Framework/IO/Root/RootInputTree.h
art/Framework/IO/Root/RootInputTree.cc

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation