#include <LuminosityBlock.h>

Inheritance diagram for fwlite::LuminosityBlock:

Public Member Functions
bool	atEnd () const override

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

virtual const std::string	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

fwlite::Run const &	getRun () const

bool	isValid () const

	LuminosityBlock (std::shared_ptr< BranchMapReader > branchMap, std::shared_ptr< RunFactory > runFactory)

	LuminosityBlock (TFile *iFile)

edm::LuminosityBlockAuxiliary const &	luminosityBlockAuxiliary () const override

	operator bool () const

const LuminosityBlock &	operator++ () override

Long64_t	size () const

bool	to (edm::RunNumber_t run, edm::LuminosityBlockNumber_t lumi)
	Go to event by Run & LuminosityBlock number. More...

const LuminosityBlock &	toBegin () override

	~LuminosityBlock () override

Public Member Functions inherited from fwlite::LuminosityBlockBase
virtual Long64_t	fileIndex () const

	LuminosityBlockBase ()

virtual Long64_t	secondaryFileIndex () const

	~LuminosityBlockBase () override

Public Member Functions inherited from edm::LuminosityBlockBase
Timestamp const &	beginTime () const

Timestamp const &	endTime () const

template<class T >
bool	getByLabel (const InputTag &tag, Handle< T > &result) const

template<typename PROD >
bool	getByLabel (InputTag const &tag, Handle< PROD > &result) const
	same as above, but using the InputTag class More...

LuminosityBlockID	id () const

LuminosityBlockNumber_t	luminosityBlock () const

	LuminosityBlockBase ()

RunNumber_t	run () const

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

	LuminosityBlock (const LuminosityBlock &)=delete

const LuminosityBlock &	operator= (const LuminosityBlock &)=delete

void	updateAux (Long_t lumiIndex) const

Private Attributes
edm::LuminosityBlockAuxiliary	aux_

TBranch *	auxBranch_

std::shared_ptr< BranchMapReader >	branchMap_

DataGetterHelper	dataHelper_

EntryFinder	entryFinder_

int	fileVersion_

edm::ProcessHistoryMap	historyMap_

std::vector< char const * >	labels_

edm::LuminosityBlockAuxiliary const *	pAux_

edm::LuminosityBlockAux const *	pOldAux_

std::vector< std::string >	procHistoryNames_

std::shared_ptr< fwlite::Run >	run_

std::shared_ptr< RunFactory >	runFactory_

Friends
class	internal::ProductGetter

class	LumiHistoryGetter

Detailed Description

Definition at line 57 of file LuminosityBlock.h.

Constructor & Destructor Documentation

◆ LuminosityBlock() [1/3]

LuminosityBlock::LuminosityBlock ( TFile * iFile )

Definition at line 45 of file LuminosityBlock.cc.

       : branchMap_(new BranchMapReader(iFile)),
         pAux_(&aux_),
         pOldAux_(nullptr),
         fileVersion_(-1),
         dataHelper_(branchMap_->getLuminosityBlockTree(), std::make_shared<LumiHistoryGetter>(this), branchMap_) {
     if (nullptr == iFile) {
       throw cms::Exception("NoFile") << "The TFile pointer passed to the constructor was null";
     }
  
     if (nullptr == branchMap_->getLuminosityBlockTree()) {
       throw cms::Exception("NoLumiTree") << "The TFile contains no TTree named "
                                          << edm::poolNames::luminosityBlockTreeName();
     }
     //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* luminosityBlockTree = branchMap_->getLuminosityBlockTree();
     if (fileVersion_ >= 3) {
       auxBranch_ = luminosityBlockTree->GetBranch(edm::BranchTypeToAuxiliaryBranchName(edm::InLumi).c_str());
       if (nullptr == auxBranch_) {
         throw cms::Exception("NoLuminosityBlockAuxilliary")
             << "The TTree " << edm::poolNames::luminosityBlockTreeName()
             << " does not contain a branch named 'LuminosityBlockAuxiliary'";
       }
       auxBranch_->SetAddress(&pAux_);
     } else {
       throw cms::Exception("OldFileVersion") << "The FWLite Luminosity Block code des not support old file versions";
       //       This code commented from fwlite::Event. May be portable if needed.
       //       pOldAux_ = new edm::EventAux();
       //       auxBranch_ = luminosityBlockTree->GetBranch(edm::BranchTypeToAuxBranchName(edm::InLuminosityBlock).c_str());
       //       if(nullptr == auxBranch_) {
       //         throw cms::Exception("NoLuminosityBlockAux")<<"The TTree "
       //           <<edm::poolNames::luminosityBlockTreeName()
       //           <<" does not contain a branch named 'LuminosityBlockAux'";
       //       }
       //       auxBranch_->SetAddress(&pOldAux_);
     }
     branchMap_->updateLuminosityBlock(0);
     runFactory_ = std::make_shared<RunFactory>();
   }

References auxBranch_, branchMap_, edm::BranchTypeToAuxiliaryBranchName(), Exception, fileVersion_, edm::InLumi, edm::poolNames::luminosityBlockTreeName(), pAux_, and runFactory_.

◆ LuminosityBlock() [2/3]

LuminosityBlock::LuminosityBlock	(	std::shared_ptr< BranchMapReader >	branchMap,
		std::shared_ptr< RunFactory >	runFactory
	)

Definition at line 89 of file LuminosityBlock.cc.

       : branchMap_(branchMap),
         pAux_(&aux_),
         pOldAux_(nullptr),
         fileVersion_(-1),
         dataHelper_(branchMap_->getLuminosityBlockTree(), std::make_shared<LumiHistoryGetter>(this), branchMap_),
         runFactory_(runFactory) {
     if (nullptr == branchMap_->getLuminosityBlockTree()) {
       throw cms::Exception("NoLumiTree") << "The TFile contains no TTree named "
                                          << edm::poolNames::luminosityBlockTreeName();
     }
     //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* luminosityBlockTree = branchMap_->getLuminosityBlockTree();
     if (fileVersion_ >= 3) {
       auxBranch_ = luminosityBlockTree->GetBranch(edm::BranchTypeToAuxiliaryBranchName(edm::InLumi).c_str());
       if (nullptr == auxBranch_) {
         throw cms::Exception("NoLuminosityBlockAuxilliary")
             << "The TTree " << edm::poolNames::luminosityBlockTreeName()
             << " does not contain a branch named 'LuminosityBlockAuxiliary'";
       }
       auxBranch_->SetAddress(&pAux_);
     } else {
       throw cms::Exception("OldFileVersion") << "The FWLite Luminosity Block code des not support old file versions";
       /*      pOldAux_ = new edm::EventAux();
       auxBranch_ = luminosityBlockTree->GetBranch(edm::BranchTypeToAuxBranchName(edm::InLuminosityBlock).c_str());
       if(nullptr == auxBranch_) {
         throw cms::Exception("NoLuminosityBlockAux")<<"The TTree "
           <<edm::poolNames::luminosityBlockTreeName()
           <<" does not contain a branch named 'LuminosityBlockAux'";
       }
       auxBranch_->SetAddress(&pOldAux_);*/
     }
     branchMap_->updateLuminosityBlock(0);
  
     //     if(fileVersion_ >= 7) {
     //       eventHistoryTree_ = dynamic_cast<TTree*>(iFile->Get(edm::poolNames::eventHistoryTreeName().c_str()));
     //     }
   }

References auxBranch_, branchMap_, edm::BranchTypeToAuxiliaryBranchName(), Exception, fileVersion_, edm::InLumi, edm::poolNames::luminosityBlockTreeName(), and pAux_.

◆ ~LuminosityBlock()

LuminosityBlock::~LuminosityBlock ( )

override

Definition at line 131 of file LuminosityBlock.cc.

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

References label, labels_, and pOldAux_.

◆ LuminosityBlock() [3/3]

fwlite::LuminosityBlock::LuminosityBlock ( const LuminosityBlock & )

privatedelete

Member Function Documentation

◆ atEnd()

bool LuminosityBlock::atEnd ( ) const

overridevirtual

Implements fwlite::LuminosityBlockBase.

Definition at line 176 of file LuminosityBlock.cc.

                                     {
     Long_t luminosityBlockIndex = branchMap_->getLuminosityBlockEntry();
     return luminosityBlockIndex == -1 or luminosityBlockIndex == size();
   }

References branchMap_, or, and size().

Referenced by getByLabel().

◆ getBranchDescriptions()

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

inline

Definition at line 89 of file LuminosityBlock.h.

                                                                          {
       return branchMap_->getBranchDescriptions();
     }

References branchMap_.

◆ getBranchNameFor()

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

virtual

Definition at line 181 of file LuminosityBlock.cc.

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

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

◆ getByLabel()

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

overridevirtual

Implements fwlite::LuminosityBlockBase.

Definition at line 188 of file LuminosityBlock.cc.

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

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

◆ getByProductID()

edm::WrapperBase const * LuminosityBlock::getByProductID ( edm::ProductID const & iID ) const

Definition at line 275 of file LuminosityBlock.cc.

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

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

◆ getRun()

fwlite::Run const & LuminosityBlock::getRun ( ) const

Definition at line 302 of file LuminosityBlock.cc.

                                                  {
     run_ = runFactory_->makeRun(std::shared_ptr<BranchMapReader>(&*branchMap_, NoDelete()));
     edm::RunNumber_t run = luminosityBlockAuxiliary().run();
     run_->to(run);
     return *run_;
   }

References branchMap_, luminosityBlockAuxiliary(), edm::LuminosityBlockAuxiliary::run(), edm::LuminosityBlockBase::run(), run_, and runFactory_.

◆ history()

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

private

Definition at line 216 of file LuminosityBlock.cc.

                                                           {
     edm::ProcessHistoryID processHistoryID;
  
     bool newFormat = false;  //(fileVersion_ >= 5);
  
     Long_t lumiIndex = branchMap_->getLuminosityBlockEntry();
     updateAux(lumiIndex);
     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(lumiIndex);
       //         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];
   }

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

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

◆ isValid()

bool LuminosityBlock::isValid ( void ) const

Definition at line 169 of file LuminosityBlock.cc.

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

References branchMap_, and size().

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

◆ luminosityBlockAuxiliary()

edm::LuminosityBlockAuxiliary const & LuminosityBlock::luminosityBlockAuxiliary ( ) const

overridevirtual

Implements edm::LuminosityBlockBase.

Definition at line 200 of file LuminosityBlock.cc.

                                                                                      {
     Long_t luminosityBlockIndex = branchMap_->getLuminosityBlockEntry();
     updateAux(luminosityBlockIndex);
     return aux_;
   }

References aux_, branchMap_, and updateAux().

Referenced by getRun().

◆ operator bool()

LuminosityBlock::operator bool ( ) const

Definition at line 174 of file LuminosityBlock.cc.

174 { return isValid(); }

◆ operator++()

const LuminosityBlock & LuminosityBlock::operator++ ( )

overridevirtual

Implements fwlite::LuminosityBlockBase.

Definition at line 142 of file LuminosityBlock.cc.

                                                      {
     Long_t luminosityBlockIndex = branchMap_->getLuminosityBlockEntry();
     if (luminosityBlockIndex < size()) {
       branchMap_->updateLuminosityBlock(++luminosityBlockIndex);
     }
     return *this;
   }

References branchMap_, and size().

◆ operator=()

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

privatedelete

◆ size()

Long64_t LuminosityBlock::size ( void ) const

Definition at line 167 of file LuminosityBlock.cc.

167 { return branchMap_->getLuminosityBlockTree()->GetEntries(); }

References branchMap_.

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

◆ throwProductNotFoundException()

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

static

Definition at line 283 of file LuminosityBlock.cc.

                                                                             {
     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 LuminosityBlock";
   }

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

◆ to()

bool LuminosityBlock::to	(	edm::RunNumber_t	run,
		edm::LuminosityBlockNumber_t	lumi
	)

Go to event by Run & LuminosityBlock number.

Definition at line 150 of file LuminosityBlock.cc.

                                                                                          {
     entryFinder_.fillIndex(*branchMap_);
     EntryFinder::EntryNumber_t entry = entryFinder_.findLumi(run, luminosityBlock);
     if (entry == EntryFinder::invalidEntry) {
       return false;
     }
     return branchMap_->updateLuminosityBlock(entry);
   }

References branchMap_, mps_splice::entry, entryFinder_, fwlite::EntryFinder::fillIndex(), fwlite::EntryFinder::findLumi(), fwlite::EntryFinder::invalidEntry, edm::LuminosityBlockBase::luminosityBlock(), and edm::LuminosityBlockBase::run().

◆ toBegin()

const LuminosityBlock & LuminosityBlock::toBegin ( )

overridevirtual

Implements fwlite::LuminosityBlockBase.

Definition at line 159 of file LuminosityBlock.cc.

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

References branchMap_.

◆ updateAux()

void LuminosityBlock::updateAux ( Long_t lumiIndex ) const

private

Definition at line 206 of file LuminosityBlock.cc.

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

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

Referenced by history(), and luminosityBlockAuxiliary().

Friends And Related Function Documentation

◆ internal::ProductGetter

friend class internal::ProductGetter

friend

Definition at line 104 of file LuminosityBlock.h.

◆ LumiHistoryGetter

friend class LumiHistoryGetter

friend

Definition at line 105 of file LuminosityBlock.h.

Member Data Documentation

◆ aux_

edm::LuminosityBlockAuxiliary fwlite::LuminosityBlock::aux_

mutableprivate

Definition at line 124 of file LuminosityBlock.h.

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

◆ auxBranch_

TBranch* fwlite::LuminosityBlock::auxBranch_

private

Definition at line 128 of file LuminosityBlock.h.

Referenced by LuminosityBlock(), and updateAux().

◆ branchMap_

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

mutableprivate

Definition at line 116 of file LuminosityBlock.h.

Referenced by atEnd(), getBranchDescriptions(), getByLabel(), getByProductID(), getRun(), history(), isValid(), LuminosityBlock(), luminosityBlockAuxiliary(), operator++(), size(), to(), and toBegin().

◆ dataHelper_

DataGetterHelper fwlite::LuminosityBlock::dataHelper_

private

Definition at line 131 of file LuminosityBlock.h.

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

◆ entryFinder_

EntryFinder fwlite::LuminosityBlock::entryFinder_

mutableprivate

Definition at line 125 of file LuminosityBlock.h.

Referenced by to().

◆ fileVersion_

int fwlite::LuminosityBlock::fileVersion_

private

Definition at line 129 of file LuminosityBlock.h.

Referenced by history(), and LuminosityBlock().

◆ historyMap_

edm::ProcessHistoryMap fwlite::LuminosityBlock::historyMap_

mutableprivate

Definition at line 122 of file LuminosityBlock.h.

Referenced by history().

◆ labels_

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

mutableprivate

Definition at line 121 of file LuminosityBlock.h.

Referenced by ~LuminosityBlock().

◆ pAux_

edm::LuminosityBlockAuxiliary const* fwlite::LuminosityBlock::pAux_

private

Definition at line 126 of file LuminosityBlock.h.

Referenced by LuminosityBlock().

◆ pOldAux_

edm::LuminosityBlockAux const* fwlite::LuminosityBlock::pOldAux_

private

Definition at line 127 of file LuminosityBlock.h.

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

◆ procHistoryNames_

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

mutableprivate

Definition at line 123 of file LuminosityBlock.h.

Referenced by history().

◆ run_

std::shared_ptr<fwlite::Run> fwlite::LuminosityBlock::run_

mutableprivate

Definition at line 118 of file LuminosityBlock.h.

Referenced by getRun().

◆ runFactory_

std::shared_ptr<RunFactory> fwlite::LuminosityBlock::runFactory_

mutableprivate

Definition at line 132 of file LuminosityBlock.h.

Referenced by getRun(), and LuminosityBlock().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ LuminosityBlock() [1/3]

◆ LuminosityBlock() [2/3]

◆ ~LuminosityBlock()

◆ LuminosityBlock() [3/3]

Member Function Documentation

◆ atEnd()

◆ getBranchDescriptions()

◆ getBranchNameFor()

◆ getByLabel()

◆ getByProductID()

◆ getRun()

◆ history()

◆ isValid()

◆ luminosityBlockAuxiliary()

◆ operator bool()

◆ operator++()

◆ operator=()

◆ size()

◆ throwProductNotFoundException()

◆ to()

◆ toBegin()

◆ updateAux()

Friends And Related Function Documentation

◆ internal::ProductGetter

◆ LumiHistoryGetter

Member Data Documentation

◆ aux_

◆ auxBranch_

◆ branchMap_

◆ dataHelper_

◆ entryFinder_

◆ fileVersion_

◆ historyMap_

◆ labels_

◆ pAux_

◆ pOldAux_

◆ procHistoryNames_

◆ run_

◆ runFactory_