art::RootInputFile::RootInputTree Class Reference

Public Types
using	BranchMap = input::BranchMap
using	EntryNumber = input::EntryNumber
using	EntryNumbers = input::EntryNumbers

Public Member Functions
	~RootInputTree ()
	RootInputTree (cet::exempt_ptr< TFile >, BranchType, int64_t saveMemoryObjectThreshold, cet::exempt_ptr< RootInputFile >, bool missingOK=false)
	RootInputTree (RootInputTree const &)=delete
	RootInputTree (RootInputTree &&)=delete
RootInputTree &	operator= (RootInputTree const &)=delete
RootInputTree &&	operator= (RootInputTree &&)=delete
bool	isValid () const
EntryNumber	entries () const
TTree *	tree () const
TTree *	metaTree () const
TBranch *	auxBranch () const
TBranch *	productProvenanceBranch () const
BranchMap const &	branches () const
void	addBranch (BranchDescription const &)
void	dropBranch (std::string const &branchName)

Private Attributes
TTree *	tree_ {nullptr}
TTree *	metaTree_ {nullptr}
TBranch *	auxBranch_ {nullptr}
TBranch *	productProvenanceBranch_ {nullptr}
EntryNumber	entries_ {0}
BranchMap	branches_ {}

Detailed Description

Definition at line 57 of file RootInputFile.h.

Member Typedef Documentation

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

Definition at line 59 of file RootInputFile.h.

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

Definition at line 60 of file RootInputFile.h.

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

Definition at line 61 of file RootInputFile.h.

Constructor & Destructor Documentation

art::RootInputFile::RootInputTree::~RootInputTree

(

)

Definition at line 125 of file RootInputFile.cc.

{}

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

Definition at line 127 of file RootInputFile.cc.

  {
    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::RootInputFile::RootInputTree::RootInputTree ( RootInputTree const &  )

delete

art::RootInputFile::RootInputTree::RootInputTree ( RootInputTree &&  )

delete

Member Function Documentation

void art::RootInputFile::RootInputTree::addBranch

(

BranchDescription const &

bd

)

Definition at line 202 of file RootInputFile.cc.

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

TBranch * art::RootInputFile::RootInputTree::auxBranch

(

)

const

Definition at line 157 of file RootInputFile.cc.

  {
    return auxBranch_;
  }

RootInputFile::RootInputTree::BranchMap const & art::RootInputFile::RootInputTree::branches

(

)

const

Definition at line 181 of file RootInputFile.cc.

  {
    return branches_;
  }

void art::RootInputFile::RootInputTree::dropBranch

(

std::string const &

branchName

)

Definition at line 213 of file RootInputFile.cc.

  {
    TBranch* branch = tree_->GetBranch(branchName.c_str());
    if (branch == nullptr) {
      return;
    }
    TObjArray* leaves = tree_->GetListOfLeaves();
    if (leaves == nullptr) {
      return;
    }
    int entries = leaves->GetEntries();
    for (int i = 0; i < entries; ++i) {
      TLeaf* 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;
    branch = nullptr;
  }

RootInputFile::RootInputTree::EntryNumber art::RootInputFile::RootInputTree::entries

(

)

const

Definition at line 163 of file RootInputFile.cc.

  {
    return entries_;
  }

bool art::RootInputFile::RootInputTree::isValid

(

)

const

Definition at line 193 of file RootInputFile.cc.

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

TTree * art::RootInputFile::RootInputTree::metaTree

(

)

const

Definition at line 175 of file RootInputFile.cc.

  {
    return metaTree_;
  }

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

delete

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

delete

TBranch * art::RootInputFile::RootInputTree::productProvenanceBranch

(

)

const

Definition at line 187 of file RootInputFile.cc.

  {
    return productProvenanceBranch_;
  }

TTree * art::RootInputFile::RootInputTree::tree

(

)

const

Definition at line 169 of file RootInputFile.cc.

  {
    return tree_;
  }

Member Data Documentation

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

private

Definition at line 89 of file RootInputFile.h.

BranchMap art::RootInputFile::RootInputTree::branches_ {}

private

Definition at line 92 of file RootInputFile.h.

EntryNumber art::RootInputFile::RootInputTree::entries_ {0}

private

Definition at line 91 of file RootInputFile.h.

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

private

Definition at line 88 of file RootInputFile.h.

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

private

Definition at line 90 of file RootInputFile.h.

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

private

Definition at line 87 of file RootInputFile.h.

---

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

• art/art/Framework/IO/Root/RootInputFile.h
• art/art/Framework/IO/Root/RootInputFile.cc