fwlite::ChainEvent Class Reference

#include <ChainEvent.h>

Inheritance diagram for fwlite::ChainEvent:

Public Member Functions
bool	atEnd () const override
	ChainEvent (std::vector< std::string > const &iFileNames)
template<typename T >
edm::EDGetTokenT< T >	consumes (edm::InputTag const &iTag) const
Event const *	event () const
edm::EventAuxiliary const &	eventAuxiliary () const override
Long64_t	eventIndex () const
Long64_t	fileIndex () const override
void	fillParameterSetRegistry () const
std::vector< edm::BranchDescription > const &	getBranchDescriptions () const
std::string const	getBranchNameFor (std::type_info const &, char const *, char const *, char const *) const override
bool	getByLabel (std::type_info const &, char const *, char const *, char const *, void *) const override
edm::WrapperBase const *	getByProductID (edm::ProductID const &) const override
fwlite::LuminosityBlock const &	getLuminosityBlock ()
std::vector< std::string > const &	getProcessHistory () const
fwlite::Run const &	getRun ()
TFile *	getTFile () const
edm::OptionalThinnedKey	getThinnedKeyFrom (edm::ProductID const &parent, unsigned int key, edm::ProductID const &thinned) const
std::optional< std::tuple< edm::WrapperBase const *, unsigned int > >	getThinnedProduct (edm::ProductID const &pid, unsigned int key) const
void	getThinnedProducts (edm::ProductID const &pid, std::vector< edm::WrapperBase const *> &foundContainers, std::vector< unsigned int > &keys) const
bool	isValid () const
	operator bool () const
ChainEvent const &	operator++ () override
edm::ParameterSet const *	parameterSet (edm::ParameterSetID const &psID) const override
edm::ProcessHistory const &	processHistory () const override
void	setGetter (std::shared_ptr< edm::EDProductGetter const > getter)
Long64_t	size () const
bool	to (Long64_t iIndex)
	Go to the event at index iIndex. More...
bool	to (const edm::EventID &id)
	Go to event with event id "id". More...
bool	to (edm::RunNumber_t run, edm::EventNumber_t event)
bool	to (edm::RunNumber_t run, edm::LuminosityBlockNumber_t lumi, edm::EventNumber_t event)
ChainEvent const &	toBegin () override
edm::TriggerNames const &	triggerNames (edm::TriggerResults const &triggerResults) const override
edm::TriggerResultsByName	triggerResultsByName (edm::TriggerResults const &triggerResults) const override
	~ChainEvent () override
Public Member Functions inherited from fwlite::EventBase
	EventBase ()
virtual Long64_t	secondaryFileIndex () const
	~EventBase () override
Public Member Functions inherited from edm::EventBase
int	bunchCrossing () const
	EventBase ()
edm::EventAuxiliary::ExperimentType	experimentType () const
template<typename T >
bool	get (ProductID const &, Handle< T > &) const
template<>
bool	getByLabel (edm::InputTag const &tag, Handle< FWGenericObject > &result) const
	Specialize the getByLabel method to work with a Handle<FWGenericObject> More...
template<typename T >
bool	getByLabel (InputTag const &, Handle< T > &) const
template<typename T >
bool	getByToken (edm::EDGetTokenT< T > const &token, edm::Handle< T > &result) const
edm::EventID	id () const
bool	isRealData () const
edm::LuminosityBlockNumber_t	luminosityBlock () const
int	orbitNumber () const
edm::Timestamp	time () const

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

Private Member Functions
	ChainEvent (Event const &)
void	findSizes ()
bool	getByTokenImp (edm::EDGetToken, edm::WrapperBase const *&) const override
ChainEvent const &	operator= (Event const &)
void	switchToFile (Long64_t)

Private Attributes
std::vector< Long64_t >	accumulatedSize_
edm::propagate_const< std::shared_ptr< Event > >	event_
Long64_t	eventIndex_
edm::propagate_const< std::shared_ptr< TFile > >	file_
std::vector< std::string >	fileNames_
edm::propagate_const< std::shared_ptr< edm::EDProductGetter > >	getter_

Friends
class	MultiChainEvent

Additional Inherited Members
Static Protected Member Functions inherited from fwlite::EventBase
template<typename T >
static edm::EDGetTokenT< T >	makeTokenUsing (unsigned int iIndex)
Static Protected Member Functions inherited from edm::EventBase
static edm::ParameterSet const *	parameterSetForID_ (edm::ParameterSetID const &psID)
static TriggerNames const *	triggerNames_ (edm::TriggerResults const &triggerResults)

Detailed Description

Definition at line 46 of file ChainEvent.h.

Constructor & Destructor Documentation

ChainEvent() [1/2]

ChainEvent::ChainEvent

(

std::vector< std::string > const &

iFileNames

)

Definition at line 35 of file ChainEvent.cc.

References accumulatedSize_, edm::poolNames::eventTreeName(), Exception, file_, MillePedeFileConverter_cfg::fileName, fileNames_, createIOVlist::nEvents, and switchToFile().

      : fileNames_(), file_(), event_(), eventIndex_(0), accumulatedSize_() {
    Long64_t summedSize = 0;
    accumulatedSize_.reserve(iFileNames.size() + 1);
    fileNames_.reserve(iFileNames.size());

    for (auto const& fileName : iFileNames) {
      TFile* tfilePtr = TFile::Open(fileName.c_str());
      if (nullptr == tfilePtr) {
        throw cms::Exception("FileOpenFailed") << "TFile::Open of " << fileName << " failed";
      }
      file_ = std::shared_ptr<TFile>(tfilePtr);
      gROOT->GetListOfFiles()->Remove(tfilePtr);
      TTree* tree = dynamic_cast<TTree*>(file_->Get(edm::poolNames::eventTreeName().c_str()));
      if (nullptr == tree) {
        throw cms::Exception("NotEdmFile")
            << "The file " << fileName << " has no 'Events' TTree and therefore is not an EDM ROOT file";
      }
      Long64_t nEvents = tree->GetEntries();
      if (nEvents > 0) {  // skip empty files
        fileNames_.push_back(fileName);
        // accumulatedSize_ is the entry # at the beginning of this file
        accumulatedSize_.push_back(summedSize);
        summedSize += nEvents;
      }
    }
    // total accumulated size (last enry + 1) at the end of last file
    accumulatedSize_.push_back(summedSize);

    if (!fileNames_.empty())
      switchToFile(0);
  }

~ChainEvent()

ChainEvent::~ChainEvent ( )

override

Definition at line 73 of file ChainEvent.cc.

{}

ChainEvent() [2/2]

fwlite::ChainEvent::ChainEvent ( Event const &  )

private

Member Function Documentation

atEnd()

bool ChainEvent::atEnd ( ) const

overridevirtual

Implements fwlite::EventBase.

Definition at line 248 of file ChainEvent.cc.

References event_, eventIndex_, fileNames_, and size().

                               {
    if (!size())
      return true;
    if (eventIndex_ == static_cast<Long64_t>(fileNames_.size()) - 1) {
      return event_->atEnd();
    }
    return false;
  }

consumes()

template<typename T >

edm::EDGetTokenT<T> fwlite::ChainEvent::consumes ( edm::InputTag const &  iTag ) const

inline

Definition at line 68 of file ChainEvent.h.

References event_.

                                                              {
      return event_->consumes<T>(iTag);
    }

event()

Event const* fwlite::ChainEvent::event ( ) const

inline

Definition at line 101 of file ChainEvent.h.

References event_.

Referenced by Types.EventID::cppID(), and to().

{ return &*event_; }

eventAuxiliary()

edm::EventAuxiliary const & ChainEvent::eventAuxiliary ( ) const

overridevirtual

Implements edm::EventBase.

Definition at line 206 of file ChainEvent.cc.

References event_.

{ return event_->eventAuxiliary(); }

eventIndex()

Long64_t fwlite::ChainEvent::eventIndex ( ) const

inline

Definition at line 96 of file ChainEvent.h.

References eventIndex_.

{ return eventIndex_; }

fileIndex()

Long64_t fwlite::ChainEvent::fileIndex ( ) const

inlineoverridevirtual

Reimplemented from fwlite::EventBase.

Definition at line 97 of file ChainEvent.h.

References eventIndex_.

Referenced by python.Events::fileIndicies().

{ return eventIndex_; }

fillParameterSetRegistry()

void ChainEvent::fillParameterSetRegistry

(

)

const

Definition at line 267 of file ChainEvent.cc.

References event_.

{ event_->fillParameterSetRegistry(); }

findSizes()

void fwlite::ChainEvent::findSizes ( )

private

getBranchDescriptions()

std::vector< edm::BranchDescription > const & ChainEvent::getBranchDescriptions

(

)

const

Definition at line 198 of file ChainEvent.cc.

References event_.

                                                                                 {
    return event_->getBranchDescriptions();
  }

getBranchNameFor()

std::string const ChainEvent::getBranchNameFor ( std::type_info const &  iType, char const *  iModule, char const *  iInstance, char const *  iProcess  ) const

overridevirtual

Implements fwlite::EventBase.

Definition at line 191 of file ChainEvent.cc.

References event_.

                                                                             {
    return event_->getBranchNameFor(iType, iModule, iInstance, iProcess);
  }

getByLabel()

bool ChainEvent::getByLabel ( std::type_info const &  iType, char const *  iModule, char const *  iInstance, char const *  iProcess, void *  iValue  ) const

overridevirtual

Implements fwlite::EventBase.

Definition at line 212 of file ChainEvent.cc.

References event_.

                                                  {
    return event_->getByLabel(iType, iModule, iInstance, iProcess, iValue);
  }

getByProductID()

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

overridevirtual

Implements fwlite::EventBase.

Definition at line 224 of file ChainEvent.cc.

References event_.

                                                                                {
    return event_->getByProductID(iID);
  }

getByTokenImp()

bool ChainEvent::getByTokenImp ( edm::EDGetToken  iToken, edm::WrapperBase const *&  iValue  ) const

overrideprivatevirtual

Implements fwlite::EventBase.

Definition at line 220 of file ChainEvent.cc.

References event_.

                                                                                          {
    return event_->getByTokenImp(iToken, iValue);
  }

getLuminosityBlock()

fwlite::LuminosityBlock const & ChainEvent::getLuminosityBlock

(

)

Definition at line 208 of file ChainEvent.cc.

References event_.

{ return event_->getLuminosityBlock(); }

getProcessHistory()

std::vector< std::string > const & ChainEvent::getProcessHistory

(

)

const

Definition at line 202 of file ChainEvent.cc.

References event_.

{ return event_->getProcessHistory(); }

getRun()

fwlite::Run const & ChainEvent::getRun

(

)

Definition at line 210 of file ChainEvent.cc.

References event_.

{ return event_->getRun(); }

getTFile()

TFile* fwlite::ChainEvent::getTFile ( ) const

inline

Definition at line 88 of file ChainEvent.h.

References event_.

{ return event_->getTFile(); }

getThinnedKeyFrom()

edm::OptionalThinnedKey ChainEvent::getThinnedKeyFrom	(	edm::ProductID const &	parent,
		unsigned int	key,
		edm::ProductID const &	thinned
	)		const

Definition at line 239 of file ChainEvent.cc.

References event_, submitPVResolutionJobs::key, and class-composition::parent.

                                                                                           {
    return event_->getThinnedKeyFrom(parent, key, thinned);
  }

getThinnedProduct()

std::optional< std::tuple< edm::WrapperBase const *, unsigned int > > ChainEvent::getThinnedProduct	(	edm::ProductID const &	pid,
		unsigned int	key
	)		const

Definition at line 228 of file ChainEvent.cc.

References event_, and submitPVResolutionJobs::key.

                                                       {
    return event_->getThinnedProduct(pid, key);
  }

getThinnedProducts()

void ChainEvent::getThinnedProducts	(	edm::ProductID const &	pid,
		std::vector< edm::WrapperBase const *> &	foundContainers,
		std::vector< unsigned int > &	keys
	)		const

Definition at line 233 of file ChainEvent.cc.

References event_, and relativeConstraints::keys.

                                                                           {
    event_->getThinnedProducts(pid, foundContainers, keys);
  }

isValid()

bool ChainEvent::isValid

(

void

)

const

Definition at line 245 of file ChainEvent.cc.

References event_.

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

{ return event_->isValid(); }

operator bool()

ChainEvent::operator bool

(

)

const

Definition at line 246 of file ChainEvent.cc.

{ return *event_; }

operator++()

ChainEvent const & ChainEvent::operator++ ( )

overridevirtual

Implements fwlite::EventBase.

Definition at line 91 of file ChainEvent.cc.

References event_, eventIndex_, fileNames_, and switchToFile().

                                           {
    if (eventIndex_ != static_cast<Long64_t>(fileNames_.size()) - 1) {
      ++(*event_);
      if (event_->atEnd()) {
        switchToFile(++eventIndex_);
      }
    } else {
      if (*event_) {
        ++(*event_);
      }
    }
    return *this;
  }

operator=()

ChainEvent const& fwlite::ChainEvent::operator= ( Event const &  )

private

parameterSet()

edm::ParameterSet const * ChainEvent::parameterSet ( edm::ParameterSetID const &  psID ) const

overridevirtual

Implements edm::EventBase.

Definition at line 263 of file ChainEvent.cc.

References event_.

                                                                                     {
    return event_->parameterSet(psID);
  }

processHistory()

edm::ProcessHistory const & ChainEvent::processHistory ( ) const

overridevirtual

Implements edm::EventBase.

Definition at line 204 of file ChainEvent.cc.

References event_.

{ return event_->processHistory(); }

setGetter()

void fwlite::ChainEvent::setGetter ( std::shared_ptr< edm::EDProductGetter const >  getter )

inline

Definition at line 99 of file ChainEvent.h.

References event_.

{ event_->setGetter(getter); }

size()

Long64_t ChainEvent::size

(

void

)

const

Definition at line 257 of file ChainEvent.cc.

References accumulatedSize_.

Referenced by ntupleDataFormat._Collection::__iter__(), ntupleDataFormat._Collection::__len__(), atEnd(), and toBegin().

{ return accumulatedSize_.empty() ? 0 : accumulatedSize_.back(); }

switchToFile()

void ChainEvent::switchToFile ( Long64_t  iIndex )

private

Definition at line 180 of file ChainEvent.cc.

References event_, eventIndex_, file_, fileNames_, and edm::propagate_const< T >::get().

Referenced by ChainEvent(), operator++(), to(), and toBegin().

                                               {
    eventIndex_ = iIndex;
    TFile* tfilePtr = TFile::Open(fileNames_[iIndex].c_str());
    file_ = std::shared_ptr<TFile>(tfilePtr);
    gROOT->GetListOfFiles()->Remove(tfilePtr);
    event_ = std::make_shared<Event>(file_.get());
  }

throwProductNotFoundException()

void ChainEvent::throwProductNotFoundException ( std::type_info const &  iType, char const *  iModule, char const *  iInstance, char const *  iProcess  )

static

Definition at line 276 of file ChainEvent.cc.

References fwlite::Event::throwProductNotFoundException().

Referenced by fwlite::MultiChainEvent::throwProductNotFoundException().

                                                                       {
    Event::throwProductNotFoundException(iType, iModule, iInstance, iProcess);
  }

to() [1/4]

bool ChainEvent::to

(

Long64_t

iIndex

)

Go to the event at index iIndex.

Definition at line 106 of file ChainEvent.cc.

References accumulatedSize_, event_, eventIndex_, and switchToFile().

Referenced by to().

                                     {
    if (iIndex >= accumulatedSize_.back()) {
      // if we're here, then iIndex was not valid
      return false;
    }

    Long64_t offsetIndex = eventIndex_;

    // we're going backwards, so start from the beginning
    if (iIndex < accumulatedSize_[offsetIndex]) {
      offsetIndex = 0;
    }

    // is it past the end of this file?
    while (iIndex >= accumulatedSize_[offsetIndex + 1]) {
      ++offsetIndex;
    }

    if (offsetIndex != eventIndex_) {
      switchToFile(eventIndex_ = offsetIndex);
    }

    // adjust to entry # in this file
    return event_->to(iIndex - accumulatedSize_[offsetIndex]);
  }

to() [2/4]

bool ChainEvent::to

(

const edm::EventID &

id

)

Go to event with event id "id".

Definition at line 133 of file ChainEvent.cc.

References event(), edm::EventBase::luminosityBlock(), writedatasetfile::run, and to().

{ return to(id.run(), id.luminosityBlock(), id.event()); }

to() [3/4]

bool ChainEvent::to	(	edm::RunNumber_t	run,
		edm::EventNumber_t	event
	)

Definition at line 166 of file ChainEvent.cc.

References writedatasetfile::run, to(), and mitigatedMETSequence_cff::U.

{ return to(run, 0U, event); }

to() [4/4]

bool ChainEvent::to	(	edm::RunNumber_t	run,
		edm::LuminosityBlockNumber_t	lumi,
		edm::EventNumber_t	event
	)

If lumi is non-zero, go to event with given run, lumi, and event number If lumi is zero, go to event with given run and event number

Definition at line 137 of file ChainEvent.cc.

References event_, eventIndex_, fileNames_, compare_using_db::ifile, writedatasetfile::run, and switchToFile().

                                                                                                 {
    // First try this file
    if (event_->to(run, lumi, event)) {
      // found it, return
      return true;
    } else {
      // Did not find it, try the other files sequentially.
      // Someday I can make this smarter. For now... we get something working.
      Long64_t thisFile = eventIndex_;
      std::vector<std::string>::const_iterator filesBegin = fileNames_.begin(), filesEnd = fileNames_.end(),
                                               ifile = filesBegin;
      for (; ifile != filesEnd; ++ifile) {
        // skip the "first" file that we tried
        if (ifile - filesBegin != thisFile) {
          // switch to the next file
          switchToFile(ifile - filesBegin);
          // check that tree for the desired event
          if (event_->to(run, lumi, event)) {
            // found it, return
            return true;
          }
        }  // end ignore "first" file that we tried
      }    // end loop over files

      // did not find the event with id "id".
      return false;
    }  // end if we did not find event id in "first" file
  }

toBegin()

ChainEvent const & ChainEvent::toBegin ( )

overridevirtual

Go to the very first Event

Implements fwlite::EventBase.

Definition at line 170 of file ChainEvent.cc.

References event_, eventIndex_, size(), and switchToFile().

                                        {
    if (!size())
      return *this;
    if (eventIndex_ != 0) {
      switchToFile(0);
    }
    event_->toBegin();
    return *this;
  }

triggerNames()

edm::TriggerNames const & ChainEvent::triggerNames ( edm::TriggerResults const &  triggerResults ) const

overridevirtual

Implements edm::EventBase.

Definition at line 259 of file ChainEvent.cc.

References event_, and triggerResults.

                                                                                               {
    return event_->triggerNames(triggerResults);
  }

triggerResultsByName()

edm::TriggerResultsByName ChainEvent::triggerResultsByName ( edm::TriggerResults const &  triggerResults ) const

overridevirtual

Implements edm::EventBase.

Definition at line 269 of file ChainEvent.cc.

References event_, and triggerResults.

                                                                                                        {
    return event_->triggerResultsByName(triggerResults);
  }

Friends And Related Function Documentation

MultiChainEvent

friend class MultiChainEvent

friend

Definition at line 132 of file ChainEvent.h.

Member Data Documentation

accumulatedSize_

std::vector<Long64_t> fwlite::ChainEvent::accumulatedSize_

private

Definition at line 145 of file ChainEvent.h.

Referenced by ChainEvent(), size(), and to().

event_

edm::propagate_const<std::shared_ptr<Event> > fwlite::ChainEvent::event_

private

Definition at line 143 of file ChainEvent.h.

Referenced by atEnd(), consumes(), event(), eventAuxiliary(), fillParameterSetRegistry(), getBranchDescriptions(), getBranchNameFor(), getByLabel(), getByProductID(), getByTokenImp(), getLuminosityBlock(), getProcessHistory(), getRun(), getTFile(), getThinnedKeyFrom(), getThinnedProduct(), getThinnedProducts(), isValid(), operator++(), parameterSet(), processHistory(), setGetter(), switchToFile(), to(), toBegin(), triggerNames(), and triggerResultsByName().

eventIndex_

Long64_t fwlite::ChainEvent::eventIndex_

private

Definition at line 144 of file ChainEvent.h.

Referenced by atEnd(), eventIndex(), fileIndex(), operator++(), switchToFile(), to(), and toBegin().

file_

edm::propagate_const<std::shared_ptr<TFile> > fwlite::ChainEvent::file_

private

Definition at line 142 of file ChainEvent.h.

Referenced by ChainEvent(), and switchToFile().

fileNames_

std::vector<std::string> fwlite::ChainEvent::fileNames_

private

Definition at line 141 of file ChainEvent.h.

Referenced by atEnd(), ChainEvent(), operator++(), switchToFile(), and to().

getter_

edm::propagate_const<std::shared_ptr<edm::EDProductGetter> > fwlite::ChainEvent::getter_

private

Definition at line 146 of file ChainEvent.h.