---

edm::RootTree Class Reference

#include <IOPool/Input/src/RootTree.h>

List of all members.

Public Types
typedef input::BranchMap	BranchMap
typedef input::EntryNumber	EntryNumber
Public Member Functions
void	addBranch (BranchKey const &key, BranchDescription const &prod, std::string const &oldBranchName)
BranchMap const &	branches () const
std::vector< std::string > const &	branchNames () const
bool	current ()
void	dropBranch (std::string const &oldBranchName)
EntryNumber const &	entries () const
EntryNumber const &	entryNumber () const
template<typename T>
void	fillAux (T *&pAux) const
template<typename T>
void	fillGroups (T &item)
void	fillStatus ()
bool	isValid () const
template<typename T>
boost::shared_ptr< BranchMapper >	makeBranchMapper () const
boost::shared_ptr< DelayedReader >	makeDelayedReader () const
TTree const *	metaTree () const
bool	next ()
bool	previous ()
std::vector< ProductStatus > const &	productStatuses () const
void	rewind ()
	RootTree (boost::shared_ptr< TFile > filePtr, BranchType const &branchType)
void	setCacheSize (unsigned int cacheSize) const
void	setEntryNumber (EntryNumber theEntryNumber)
void	setPresence (BranchDescription const &prod)
void	setTreeMaxVirtualSize (int treeMaxVirtualSize)
TTree const *	tree () const
	~RootTree ()
Private Attributes
TBranch *const	auxBranch_
TBranch *const	branchEntryInfoBranch_
boost::shared_ptr< BranchMap >	branches_
std::vector< std::string >	branchNames_
BranchType	branchType_
EntryNumber	entries_
EntryNumber	entryNumber_
boost::shared_ptr< TFile >	filePtr_
TTree *const	infoTree_
TTree *const	metaTree_
std::vector< ProductStatus > *	pProductStatuses_
std::vector< ProductStatus >	productStatuses_
TBranch *const	statusBranch_
TTree *const	tree_

---

Detailed Description

Definition at line 29 of file RootTree.h.

---

Member Typedef Documentation

typedef input::BranchMap edm::RootTree::BranchMap

Definition at line 31 of file RootTree.h.

typedef input::EntryNumber edm::RootTree::EntryNumber

Definition at line 32 of file RootTree.h.

---

Constructor & Destructor Documentation

edm::RootTree::RootTree	(	boost::shared_ptr< TFile >	filePtr,
		BranchType const &	branchType
	)

Definition at line 34 of file RootTree.cc.

                                                                                 :
    filePtr_(filePtr),
    tree_(dynamic_cast<TTree *>(filePtr_.get() != 0 ? filePtr->Get(BranchTypeToProductTreeName(branchType).c_str()) : 0)),
    metaTree_(dynamic_cast<TTree *>(filePtr_.get() != 0 ? filePtr->Get(BranchTypeToMetaDataTreeName(branchType).c_str()) : 0)),
    branchType_(branchType),
    auxBranch_(tree_ ? getAuxiliaryBranch(tree_, branchType_) : 0),
    branchEntryInfoBranch_(metaTree_ ? getEventEntryInfoBranch(metaTree_, branchType_) : 0),
    entries_(tree_ ? tree_->GetEntries() : 0),
    entryNumber_(-1),
    branchNames_(),
    branches_(new BranchMap),
    productStatuses_(),
    pProductStatuses_(&productStatuses_),
    infoTree_(dynamic_cast<TTree *>(filePtr_.get() != 0 ? filePtr->Get(BranchTypeToInfoTreeName(branchType).c_str()) : 0)),
    statusBranch_(infoTree_ ? getStatusBranch(infoTree_, branchType_) : 0)
  { }

edm::RootTree::~RootTree

(

)

[inline]

Definition at line 34 of file RootTree.h.

{}

---

Member Function Documentation

void edm::RootTree::addBranch	(	BranchKey const &	key,
		BranchDescription const &	prod,
		std::string const &	oldBranchName
	)

Definition at line 71 of file RootTree.cc.

References branches_, edm::BranchDescription::branchName(), branchNames_, info, edm::BranchDescription::init(), isValid(), metaTree_, edm::BranchDescription::present(), edm::input::BranchInfo::productBranch_, edm::input::BranchInfo::provenanceBranch_, and tree_.

                                                      {
      assert(isValid());
      prod.init();
      //use the translated branch name 
      TBranch * branch = tree_->GetBranch(oldBranchName.c_str());
      assert (prod.present() == (branch != 0));
      input::BranchInfo info = input::BranchInfo(ConstBranchDescription(prod));
      info.productBranch_ = 0;
      if (prod.present()) {
        info.productBranch_ = branch;
        //we want the new branch name for the JobReport
        branchNames_.push_back(prod.branchName());
      }
      info.provenanceBranch_ = metaTree_->GetBranch(oldBranchName.c_str());
      branches_->insert(std::make_pair(key, info));
  }

BranchMap const& edm::RootTree::branches

(

)

const [inline]

Definition at line 65 of file RootTree.h.

References branches_.

Referenced by edm::RootFile::makeBranchMapper().

{return *branches_;}

std::vector<std::string> const& edm::RootTree::branchNames

(

)

const [inline]

Definition at line 49 of file RootTree.h.

References branchNames_.

Referenced by edm::RootFile::reportOpened().

{return branchNames_;}

bool edm::RootTree::current

(

void

)

[inline]

Definition at line 44 of file RootTree.h.

Referenced by edm::RootFile::readCurrentEvent().

{return entryNumber_ < entries_ && entryNumber_ >= 0;} 

void edm::RootTree::dropBranch

(

std::string const &

oldBranchName

)

Definition at line 91 of file RootTree.cc.

References entries(), i, python::Node::leaf, and tree_.

                                                     {
      //use the translated branch name 
      TBranch * branch = tree_->GetBranch(oldBranchName.c_str());
      if (branch != 0) {
        TObjArray * leaves = tree_->GetListOfLeaves();
        int entries = leaves->GetEntries();
        for (int i = 0; i < entries; ++i) {
          TLeaf *leaf = (TLeaf *)(*leaves)[i];
          if (leaf == 0) continue;
          TBranch* br = leaf->GetBranch();
          if (br == 0) continue;
          if (br->GetMother() == branch) {
            leaves->Remove(leaf);
          }
        }
        leaves->Compress();
        tree_->GetListOfBranches()->Remove(branch);
        tree_->GetListOfBranches()->Compress();
        delete branch;
      }
  }

EntryNumber const& edm::RootTree::entries

(

)

const [inline]

Definition at line 47 of file RootTree.h.

References entries_.

Referenced by dropBranch(), and edm::RootFile::setIfFastClonable().

{return entries_;}

EntryNumber const& edm::RootTree::entryNumber

(

)

const [inline]

Definition at line 46 of file RootTree.h.

References entryNumber_.

Referenced by edm::RootFile::fillFileIndex(), edm::RootFile::fillHistory(), and edm::RootFile::makeBranchMapper().

{return entryNumber_;}

template<typename T>

void edm::RootTree::fillAux

(

T *&

pAux

)

const [inline]

Definition at line 57 of file RootTree.h.

References auxBranch_, entryNumber_, and edm::input::getEntry().

Referenced by edm::RootFile::fillEventAuxiliary(), edm::RootFile::fillLumiAuxiliary(), and edm::RootFile::fillRunAuxiliary().

                                  {
      auxBranch_->SetAddress(&pAux);
      input::getEntry(auxBranch_, entryNumber_);
    }

template<typename T>

void edm::RootTree::fillGroups

(

T &

item

)

[inline]

Definition at line 98 of file RootTree.h.

References branches_, and metaTree_.

Referenced by edm::RootFile::readCurrentEvent(), edm::RootFile::readLumi(), and edm::RootFile::readRun().

                              {
    if (metaTree_ == 0 || metaTree_->GetNbranches() == 0) return;
    // Loop over provenance
    for (BranchMap::const_iterator pit = branches_->begin(), pitEnd = branches_->end(); pit != pitEnd; ++pit) {
      item.addGroup(pit->second.branchDescription_);
    }
  }

void edm::RootTree::fillStatus

(

)

[inline]

Definition at line 69 of file RootTree.h.

References entryNumber_, edm::input::getEntry(), pProductStatuses_, and statusBranch_.

Referenced by edm::RootFile::makeBranchMapper().

                      {
      statusBranch_->SetAddress(&pProductStatuses_);
      input::getEntry(statusBranch_, entryNumber_);
    }

bool edm::RootTree::isValid

(

void

)

const

Definition at line 52 of file RootTree.cc.

References auxBranch_, branchEntryInfoBranch_, entries_, metaTree_, statusBranch_, and tree_.

Referenced by addBranch(), edm::RootFile::fillFileIndex(), edm::RootFile::readLumi(), edm::RootFile::readRun(), setPresence(), and edm::RootFile::validateFile().

                          {
    if (metaTree_ == 0 || metaTree_->GetNbranches() == 0) {
      return tree_ != 0 && auxBranch_ != 0 && tree_->GetNbranches() == 1; 
    }
    if (tree_ != 0 && auxBranch_ != 0 && metaTree_ != 0) {
      if (branchEntryInfoBranch_ != 0 || statusBranch_ != 0) return true;
      return (entries_ == metaTree_->GetEntries() && tree_->GetNbranches() <= metaTree_->GetNbranches() + 1); 
    }
    return false;
  }

template<typename T>

boost::shared_ptr< BranchMapper > edm::RootTree::makeBranchMapper

(

)

const [inline]

Definition at line 108 of file RootTree.h.

References branchEntryInfoBranch_, and entryNumber_.

Referenced by edm::RootFile::makeBranchMapper().

                                   {
    assert (branchEntryInfoBranch_);
    boost::shared_ptr<BranchMapper> mapper(new BranchMapperWithReader<T>(branchEntryInfoBranch_, entryNumber_));
    return mapper;
  }

boost::shared_ptr< DelayedReader > edm::RootTree::makeDelayedReader

(

)

const

Definition at line 114 of file RootTree.cc.

References branches_, entryNumber_, and filePtr_.

Referenced by edm::RootFile::readCurrentEvent(), edm::RootFile::readLumi(), and edm::RootFile::readRun().

                                    {
    boost::shared_ptr<DelayedReader> store(new RootDelayedReader(entryNumber_, branches_, filePtr_));
    return store;
  }

TTree const* edm::RootTree::metaTree

(

)

const [inline]

Definition at line 62 of file RootTree.h.

References metaTree_.

Referenced by edm::RootFile::createFileBlock().

{return metaTree_;}

bool edm::RootTree::next

(

void

)

[inline]

Definition at line 42 of file RootTree.h.

References entries_, and entryNumber_.

Referenced by edm::RootFile::fillFileIndex(), edm::RootFile::initializeDuplicateChecker(), edm::RootFile::nextEventEntry(), edm::RootFile::readLumi(), and edm::RootFile::readRun().

{return ++entryNumber_ < entries_;} 

bool edm::RootTree::previous

(

)

[inline]

Definition at line 43 of file RootTree.h.

References entryNumber_.

Referenced by edm::RootFile::readLumi(), and edm::RootFile::readRun().

{return --entryNumber_ >= 0;} 

std::vector<ProductStatus> const& edm::RootTree::productStatuses

(

)

const [inline]

Definition at line 66 of file RootTree.h.

References productStatuses_.

Referenced by edm::RootFile::makeBranchMapper().

{return productStatuses_;}

void edm::RootTree::rewind

(

void

)

[inline]

Definition at line 45 of file RootTree.h.

References entryNumber_.

Referenced by edm::RootFile::rewind().

{entryNumber_ = 0;} 

void edm::RootTree::setCacheSize

(

unsigned int

cacheSize

)

const

Definition at line 120 of file RootTree.cc.

References tree_.

Referenced by edm::RootFile::RootFile().

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

void edm::RootTree::setEntryNumber

(

EntryNumber

theEntryNumber

)

Definition at line 130 of file RootTree.cc.

References branches_, e, entryNumber_, filePtr_, i, tc, and tree_.

Referenced by edm::RootFile::fillFileIndex(), edm::RootFile::initializeDuplicateChecker(), edm::RootFile::readEvent(), edm::RootFile::readLumi(), edm::RootFile::readRun(), edm::RootFile::setAtEventEntry(), edm::RootFile::setEntryAtEvent(), edm::RootFile::setEntryAtLumi(), and edm::RootFile::setEntryAtRun().

                                                     {
    if (TTreeCache *tc = dynamic_cast<TTreeCache *>(filePtr_->GetCacheRead())) {
      if (theEntryNumber >= 0 && tc->GetOwner() == tree_ && tc->IsLearning()) {
        tc->SetLearnEntries(1);
        tc->SetEntryRange(0, tree_->GetEntries());
        for (BranchMap::const_iterator i = branches_->begin(), e = branches_->end(); i != e; ++i) {
          if (i->second.productBranch_) {
            tc->AddBranch(i->second.productBranch_, kTRUE);
          }
        }
        tc->StopLearningPhase();
      }
    }

    entryNumber_ = theEntryNumber;
    tree_->LoadTree(theEntryNumber);
  }

void edm::RootTree::setPresence

(

BranchDescription const &

prod

)

Definition at line 64 of file RootTree.cc.

References edm::BranchDescription::branchName(), edm::BranchDescription::init(), isValid(), edm::BranchDescription::setPresent(), and tree_.

                                                     {
      assert(isValid());
      prod.init();
      prod.setPresent(tree_->GetBranch(prod.branchName().c_str()) != 0);
  }

void edm::RootTree::setTreeMaxVirtualSize

(

int

treeMaxVirtualSize

)

Definition at line 125 of file RootTree.cc.

References tree_.

Referenced by edm::RootFile::RootFile().

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

TTree const* edm::RootTree::tree

(

)

const [inline]

Definition at line 61 of file RootTree.h.

References tree_.

Referenced by edm::RootFile::createFileBlock().

{return tree_;}

---

Member Data Documentation

TBranch* const edm::RootTree::auxBranch_ [private]

Definition at line 82 of file RootTree.h.

Referenced by fillAux(), and isValid().

TBranch* const edm::RootTree::branchEntryInfoBranch_ [private]

Definition at line 83 of file RootTree.h.

Referenced by isValid(), and makeBranchMapper().

boost::shared_ptr<BranchMap> edm::RootTree::branches_ [private]

Definition at line 87 of file RootTree.h.

Referenced by addBranch(), branches(), fillGroups(), makeDelayedReader(), and setEntryNumber().

std::vector<std::string> edm::RootTree::branchNames_ [private]

Definition at line 86 of file RootTree.h.

Referenced by addBranch(), and branchNames().

BranchType edm::RootTree::branchType_ [private]

Definition at line 81 of file RootTree.h.

EntryNumber edm::RootTree::entries_ [private]

Definition at line 84 of file RootTree.h.

Referenced by entries(), isValid(), and next().

EntryNumber edm::RootTree::entryNumber_ [private]

Definition at line 85 of file RootTree.h.

Referenced by entryNumber(), fillAux(), fillStatus(), makeBranchMapper(), makeDelayedReader(), next(), previous(), rewind(), and setEntryNumber().

boost::shared_ptr<TFile> edm::RootTree::filePtr_ [private]

Definition at line 75 of file RootTree.h.

Referenced by makeDelayedReader(), and setEntryNumber().

TTree* const edm::RootTree::infoTree_ [private]

Definition at line 92 of file RootTree.h.

TTree* const edm::RootTree::metaTree_ [private]

Definition at line 80 of file RootTree.h.

Referenced by addBranch(), fillGroups(), isValid(), and metaTree().

std::vector<ProductStatus>* edm::RootTree::pProductStatuses_ [private]

Definition at line 91 of file RootTree.h.

Referenced by fillStatus().

std::vector<ProductStatus> edm::RootTree::productStatuses_ [private]

Definition at line 90 of file RootTree.h.

Referenced by productStatuses().

TBranch* const edm::RootTree::statusBranch_ [private]

Definition at line 93 of file RootTree.h.

Referenced by fillStatus(), and isValid().

TTree* const edm::RootTree::tree_ [private]

Definition at line 79 of file RootTree.h.

Referenced by addBranch(), dropBranch(), isValid(), setCacheSize(), setEntryNumber(), setPresence(), setTreeMaxVirtualSize(), and tree().

---

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

• IOPool/Input/src/RootTree.h
• IOPool/Input/src/RootTree.cc

---