fwlite::Run Class Reference

#include <Run.h>

Inheritance diagram for fwlite::Run:

Public Member Functions
bool	atEnd () const override
std::vector< edm::BranchDescription > const &	getBranchDescriptions () const
virtual std::string const	getBranchNameFor (std::type_info const &, char const *, char const *, char const *) const
bool	getByLabel (std::type_info const &, char const *, char const *, char const *, void *) const override
edm::WrapperBase const *	getByProductID (edm::ProductID const &) const
bool	isValid () const
	operator bool () const
const Run &	operator++ () override
const Run &	operator= (const Run &)=delete
	Run (TFile *iFile)
	Run (std::shared_ptr< BranchMapReader > branchMap)
	Run (const Run &)=delete
edm::RunAuxiliary const &	runAuxiliary () const override
Long64_t	size () const
bool	to (edm::RunNumber_t run)
	Go to event by Run & Run number. More...
const Run &	toBegin () override
	~Run () override
Public Member Functions inherited from fwlite::RunBase
virtual Long64_t	fileIndex () const
	RunBase ()
virtual Long64_t	secondaryFileIndex () const
	~RunBase () override
Public Member Functions inherited from edm::RunBase
Timestamp const &	beginTime () const
Timestamp const &	endTime () const
template<typename PROD >
bool	getByLabel (InputTag const &tag, Handle< PROD > &result) const
	same as above, but using the InputTag class More...
template<typename T >
bool	getByLabel (InputTag const &tag, Handle< T > &result) const
RunID const &	id () const
RunNumber_t	run () const
	RunBase ()

Static Public Member Functions
static void	throwProductNotFoundException (std::type_info const &, char const *, char const *, char const *)

Private Member Functions
const edm::ProcessHistory &	history () const
void	updateAux (Long_t runIndex) const

Private Attributes
edm::RunAuxiliary	aux_
TBranch *	auxBranch_
std::shared_ptr< BranchMapReader >	branchMap_
fwlite::DataGetterHelper	dataHelper_
EntryFinder	entryFinder_
int	fileVersion_
edm::ProcessHistoryMap	historyMap_
std::vector< char const * >	labels_
edm::RunAuxiliary const *	pAux_
edm::RunAux const *	pOldAux_
std::vector< std::string >	procHistoryNames_

Friends
class	internal::ProductGetter
class	RunHistoryGetter

Detailed Description

Definition at line 54 of file Run.h.

Constructor & Destructor Documentation

Run() [1/3]

Run::Run

(

TFile *

iFile

)

Definition at line 44 of file Run.cc.

References auxBranch_, branchMap_, edm::BranchTypeToAuxiliaryBranchName(), Exception, fileVersion_, edm::InRun, pAux_, and edm::poolNames::runTreeName().

      : branchMap_(new BranchMapReader(iFile)),
        pAux_(&aux_),
        pOldAux_(nullptr),
        fileVersion_(-1),
        dataHelper_(branchMap_->getRunTree(), std::make_shared<RunHistoryGetter>(this), branchMap_) {
    if (nullptr == iFile) {
      throw cms::Exception("NoFile") << "The TFile pointer passed to the constructor was null";
    }

    if (nullptr == branchMap_->getRunTree()) {
      throw cms::Exception("NoRunTree") << "The TFile contains no TTree named " << edm::poolNames::runTreeName();
    }
    //need to know file version in order to determine how to read the basic product info
    fileVersion_ = branchMap_->getFileVersion(iFile);

    //got this logic from IOPool/Input/src/RootFile.cc

    TTree* runTree = branchMap_->getRunTree();
    if (fileVersion_ >= 3) {
      auxBranch_ = runTree->GetBranch(edm::BranchTypeToAuxiliaryBranchName(edm::InRun).c_str());
      if (nullptr == auxBranch_) {
        throw cms::Exception("NoRunAuxilliary")
            << "The TTree " << edm::poolNames::runTreeName() << " does not contain a branch named 'RunAuxiliary'";
      }
      auxBranch_->SetAddress(&pAux_);
    } else {
      throw cms::Exception("OldFileVersion") << "The FWLite Run code des not support old file versions";
      //       This code commented from fwlite::Event. May be portable if needed.
      //       pOldAux_ = new edm::EventAux();
      //       auxBranch_ = runTree->GetBranch(edm::BranchTypeToAuxBranchName(edm::InRun).c_str());
      //       if(nullptr == auxBranch_) {
      //         throw cms::Exception("NoRunAux")<<"The TTree "
      //           <<edm::poolNames::runTreeName()
      //           <<" does not contain a branch named 'RunAux'";
      //       }
      //       auxBranch_->SetAddress(&pOldAux_);
    }
    branchMap_->updateRun(0);
    //     getter_ = std::make_shared<ProductGetter>(this);
  }

Run() [2/3]

Run::Run

(

std::shared_ptr< BranchMapReader >

branchMap

)

Definition at line 86 of file Run.cc.

References auxBranch_, branchMap_, edm::BranchTypeToAuxiliaryBranchName(), Exception, fileVersion_, edm::InRun, pAux_, and edm::poolNames::runTreeName().

      : branchMap_(branchMap),
        pAux_(&aux_),
        pOldAux_(nullptr),
        fileVersion_(-1),
        dataHelper_(branchMap_->getRunTree(), std::make_shared<RunHistoryGetter>(this), branchMap_) {
    if (nullptr == branchMap_->getRunTree()) {
      throw cms::Exception("NoRunTree") << "The TFile contains no TTree named " << edm::poolNames::runTreeName();
    }
    //need to know file version in order to determine how to read the basic event info
    fileVersion_ = branchMap_->getFileVersion();
    //got this logic from IOPool/Input/src/RootFile.cc

    TTree* runTree = branchMap_->getRunTree();
    if (fileVersion_ >= 3) {
      auxBranch_ = runTree->GetBranch(edm::BranchTypeToAuxiliaryBranchName(edm::InRun).c_str());
      if (nullptr == auxBranch_) {
        throw cms::Exception("NoRunAuxilliary")
            << "The TTree " << edm::poolNames::runTreeName() << " does not contain a branch named 'RunAuxiliary'";
      }
      auxBranch_->SetAddress(&pAux_);
    } else {
      throw cms::Exception("OldFileVersion") << "The FWLite Run code des not support old file versions";
      /*      pOldAux_ = new edm::EventAux();
      auxBranch_ = runTree->GetBranch(edm::BranchTypeToAuxBranchName(edm::InRun).c_str());
      if(nullptr == auxBranch_) {
        throw cms::Exception("NoRunAux")<<"The TTree "
          <<edm::poolNames::runTreeName()
          <<" does not contain a branch named 'RunAux'";
      }
      auxBranch_->SetAddress(&pOldAux_);*/
    }
    branchMap_->updateRun(0);

    //     if(fileVersion_ >= 7) {
    //       eventHistoryTree_ = dynamic_cast<TTree*>(iFile->Get(edm::poolNames::eventHistoryTreeName().c_str()));
    //     }

    //     getter_ = std::make_shared<ProductGetter>(this);
  }

Run() [3/3]

fwlite::Run::Run ( const Run &  )

delete

~Run()

Run::~Run ( )

override

Definition at line 127 of file Run.cc.

References label, labels_, and pOldAux_.

            {
    for (auto const& label : labels_) {
      delete[] label;
    }
    delete pOldAux_;
  }

Member Function Documentation

atEnd()

bool Run::atEnd ( ) const

overridevirtual

Implements fwlite::RunBase.

Definition at line 172 of file Run.cc.

References branchMap_, or, csv2json::runIndex, and size().

Referenced by getByLabel().

                        {
    Long_t runIndex = branchMap_->getRunEntry();
    return runIndex == -1 or runIndex == size();
  }

getBranchDescriptions()

std::vector<edm::BranchDescription> const& fwlite::Run::getBranchDescriptions ( ) const

inline

Definition at line 89 of file Run.h.

References branchMap_.

                                                                         {
      return branchMap_->getBranchDescriptions();
    }

getBranchNameFor()

std::string const Run::getBranchNameFor ( std::type_info const &  iInfo, char const *  iModuleLabel, char const *  iProductInstanceLabel, char const *  iProcessLabel  ) const

virtual

Definition at line 177 of file Run.cc.

References dataHelper_, and fwlite::DataGetterHelper::getBranchNameFor().

                                                                           {
    return dataHelper_.getBranchNameFor(iInfo, iModuleLabel, iProductInstanceLabel, iProcessLabel);
  }

getByLabel()

bool Run::getByLabel ( std::type_info const &  iInfo, char const *  iModuleLabel, char const *  iProductInstanceLabel, char const *  iProcessLabel, void *  oData  ) const

overridevirtual

Implements fwlite::RunBase.

Definition at line 184 of file Run.cc.

References atEnd(), branchMap_, dataHelper_, Exception, fwlite::DataGetterHelper::getByLabel(), and csv2json::runIndex.

Referenced by FWMagField::checkFieldInfo().

                                          {
    if (atEnd()) {
      throw cms::Exception("OffEnd") << "You have requested data past the last run";
    }
    Long_t runIndex = branchMap_->getRunEntry();
    return dataHelper_.getByLabel(iInfo, iModuleLabel, iProductInstanceLabel, iProcessLabel, oData, runIndex);
  }

getByProductID()

edm::WrapperBase const * Run::getByProductID

(

edm::ProductID const &

iID

)

const

Definition at line 271 of file Run.cc.

References branchMap_, dataHelper_, fwlite::DataGetterHelper::getByProductID(), and csv2json::runIndex.

                                                                         {
    Long_t runIndex = branchMap_->getRunEntry();
    return dataHelper_.getByProductID(iID, runIndex);
  }

history()

const edm::ProcessHistory & Run::history ( ) const

private

Definition at line 212 of file Run.cc.

References aux_, b, branchMap_, Exception, fileVersion_, historyMap_, edm::poolNames::metaDataTreeName(), edm::poolNames::processHistoryBranchName(), edm::RunAuxiliary::processHistoryID(), edm::poolNames::processHistoryMapBranchName(), procHistoryNames_, csv2json::runIndex, edm::ProcessHistory::setProcessHistoryID(), and updateAux().

Referenced by fwlite::RunHistoryGetter::history().

                                              {
    edm::ProcessHistoryID processHistoryID;

    bool newFormat = false;  //(fileVersion_ >= 5);

    Long_t runIndex = branchMap_->getRunEntry();
    updateAux(runIndex);
    if (!newFormat) {
      processHistoryID = aux_.processHistoryID();
    }

    if (historyMap_.empty() || newFormat) {
      procHistoryNames_.clear();
      TTree* meta = dynamic_cast<TTree*>(branchMap_->getFile()->Get(edm::poolNames::metaDataTreeName().c_str()));
      if (nullptr == meta) {
        throw cms::Exception("NoMetaTree")
            << "The TFile does not appear to contain a TTree named " << edm::poolNames::metaDataTreeName();
      }
      if (historyMap_.empty()) {
        if (fileVersion_ < 11) {
          edm::ProcessHistoryMap* pPhm = &historyMap_;
          TBranch* b = meta->GetBranch(edm::poolNames::processHistoryMapBranchName().c_str());
          b->SetAddress(&pPhm);
          b->GetEntry(0);
        } else {
          edm::ProcessHistoryVector historyVector;
          edm::ProcessHistoryVector* pPhv = &historyVector;
          TBranch* b = meta->GetBranch(edm::poolNames::processHistoryBranchName().c_str());
          b->SetAddress(&pPhv);
          b->GetEntry(0);
          for (auto& history : historyVector) {
            historyMap_.insert(std::make_pair(history.setProcessHistoryID(), history));
          }
        }
      }
      //     if (newFormat) {
      //       if (fileVersion_ >= 7) {
      //         edm::History history;
      //         edm::History* pHistory = &history;
      //         TBranch* eventHistoryBranch = eventHistoryTree_->GetBranch(edm::poolNames::eventHistoryBranchName().c_str());
      //         if (!eventHistoryBranch)
      //           throw edm::Exception(edm::errors::FatalRootError)
      //             << "Failed to find history branch in event history tree";
      //         eventHistoryBranch->SetAddress(&pHistory);
      //         eventHistoryTree_->GetEntry(runIndex);
      //         processHistoryID = history.processHistoryID();
      //       } else {
      //         std::vector<edm::EventProcessHistoryID> *pEventProcessHistoryIDs = &eventProcessHistoryIDs_;
      //         TBranch* b = meta->GetBranch(edm::poolNames::eventHistoryBranchName().c_str());
      //         b->SetAddress(&pEventProcessHistoryIDs);
      //         b->GetEntry(0);
      //         edm::EventProcessHistoryID target(aux_.id(), edm::ProcessHistoryID());
      //         processHistoryID = std::lower_bound(eventProcessHistoryIDs_.begin(), eventProcessHistoryIDs_.end(), target)->processHistoryID_;
      //       }
      //     }
    }
    return historyMap_[processHistoryID];
  }

isValid()

bool Run::isValid

(

void

)

const

Definition at line 165 of file Run.cc.

References branchMap_, csv2json::runIndex, and size().

Referenced by ntupleDataFormat._Object::_checkIsValid(), and core.AutoHandle.AutoHandle::ReallyLoad().

                          {
    Long_t runIndex = branchMap_->getRunEntry();
    return runIndex != -1 and runIndex < size();
  }

operator bool()

Run::operator bool

(

)

const

Definition at line 170 of file Run.cc.

References sistrip::SpyUtilities::isValid().

{ return isValid(); }

operator++()

const Run & Run::operator++ ( )

overridevirtual

Implements fwlite::RunBase.

Definition at line 138 of file Run.cc.

References branchMap_, csv2json::runIndex, and size().

                             {
    Long_t runIndex = branchMap_->getRunEntry();
    if (runIndex < size()) {
      branchMap_->updateRun(++runIndex);
    }
    return *this;
  }

operator=()

const Run& fwlite::Run::operator= ( const Run &  )

delete

runAuxiliary()

edm::RunAuxiliary const & Run::runAuxiliary ( ) const

overridevirtual

Implements edm::RunBase.

Definition at line 196 of file Run.cc.

References aux_, branchMap_, csv2json::runIndex, and updateAux().

                                                 {
    Long_t runIndex = branchMap_->getRunEntry();
    updateAux(runIndex);
    return aux_;
  }

size()

Long64_t Run::size

(

void

)

const

Definition at line 163 of file Run.cc.

References branchMap_.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), atEnd(), isValid(), and operator++().

{ return branchMap_->getRunTree()->GetEntries(); }

throwProductNotFoundException()

void Run::throwProductNotFoundException ( std::type_info const &  iType, char const *  iModule, char const *  iProduct, char const *  iProcess  )

static

Definition at line 279 of file Run.cc.

References Exception, and edm::errors::ProductNotFound.

                                                                {
    edm::TypeID type(iType);
    throw edm::Exception(edm::errors::ProductNotFound)
        << "A branch was found for \n  type ='" << type.className() << "'\n  module='" << iModule
        << "'\n  productInstance='" << ((nullptr != iProduct) ? iProduct : "") << "'\n  process='"
        << ((nullptr != iProcess) ? iProcess : "")
        << "'\n"
           "but no data is available for this Run";
  }

to()

bool Run::to

(

edm::RunNumber_t

run

)

Go to event by Run & Run number.

Definition at line 146 of file Run.cc.

References branchMap_, mps_splice::entry, entryFinder_, fwlite::EntryFinder::fillIndex(), fwlite::EntryFinder::findRun(), fwlite::EntryFinder::invalidEntry, and edm::RunBase::run().

                                 {
    entryFinder_.fillIndex(*branchMap_);
    EntryFinder::EntryNumber_t entry = entryFinder_.findRun(run);
    if (entry == EntryFinder::invalidEntry) {
      return false;
    }
    return branchMap_->updateRun(entry);
  }

toBegin()

const Run & Run::toBegin ( )

overridevirtual

Implements fwlite::RunBase.

Definition at line 155 of file Run.cc.

References branchMap_.

                          {
    branchMap_->updateRun(0);
    return *this;
  }

updateAux()

void Run::updateAux ( Long_t  runIndex ) const

private

Definition at line 202 of file Run.cc.

References aux_, auxBranch_, edm::conversion(), pOldAux_, and csv2json::runIndex.

Referenced by history(), and runAuxiliary().

                                           {
    if (auxBranch_->GetEntryNumber() != runIndex) {
      auxBranch_->GetEntry(runIndex);
      //handling dealing with old version
      if (nullptr != pOldAux_) {
        conversion(*pOldAux_, aux_);
      }
    }
  }

Friends And Related Function Documentation

internal::ProductGetter

friend class internal::ProductGetter

friend

Definition at line 103 of file Run.h.

RunHistoryGetter

friend class RunHistoryGetter

friend

Definition at line 104 of file Run.h.

Member Data Documentation

aux_

edm::RunAuxiliary fwlite::Run::aux_

mutableprivate

Definition at line 117 of file Run.h.

Referenced by history(), runAuxiliary(), and updateAux().

auxBranch_

TBranch* fwlite::Run::auxBranch_

private

Definition at line 121 of file Run.h.

Referenced by Run(), and updateAux().

branchMap_

std::shared_ptr<BranchMapReader> fwlite::Run::branchMap_

mutableprivate

Definition at line 111 of file Run.h.

Referenced by atEnd(), getBranchDescriptions(), getByLabel(), getByProductID(), history(), isValid(), operator++(), Run(), runAuxiliary(), size(), to(), and toBegin().

dataHelper_

fwlite::DataGetterHelper fwlite::Run::dataHelper_

private

Definition at line 124 of file Run.h.

Referenced by getBranchNameFor(), getByLabel(), and getByProductID().

entryFinder_

EntryFinder fwlite::Run::entryFinder_

mutableprivate

Definition at line 118 of file Run.h.

Referenced by to().

fileVersion_

int fwlite::Run::fileVersion_

private

Definition at line 122 of file Run.h.

Referenced by history(), and Run().

historyMap_

edm::ProcessHistoryMap fwlite::Run::historyMap_

mutableprivate

Definition at line 115 of file Run.h.

Referenced by history().

labels_

std::vector<char const*> fwlite::Run::labels_

mutableprivate

Definition at line 114 of file Run.h.

Referenced by ~Run().

pAux_

edm::RunAuxiliary const* fwlite::Run::pAux_

private

Definition at line 119 of file Run.h.

Referenced by Run().

pOldAux_

edm::RunAux const* fwlite::Run::pOldAux_

private

Definition at line 120 of file Run.h.

Referenced by updateAux(), and ~Run().

procHistoryNames_

std::vector<std::string> fwlite::Run::procHistoryNames_

mutableprivate

Definition at line 116 of file Run.h.

Referenced by history().