edm::VectorInputSource Class Reference

#include <VectorInputSource.h>

Inheritance diagram for edm::VectorInputSource:

Public Member Functions
void	doBeginJob ()
	Called at beginning of job. More...
void	doEndJob ()
	Called at end of job. More...
void	dropUnwantedBranches (std::vector< std::string > const &wantedBranches)
template<typename T >
size_t	loopOverEvents (EventPrincipal &cache, size_t &fileNameHash, size_t number, T eventOperator, CLHEP::HepRandomEngine *=nullptr, EventID const *id=nullptr, bool recycleFiles=true)
template<typename T , typename Iterator >
size_t	loopSpecified (EventPrincipal &cache, size_t &fileNameHash, Iterator const &begin, Iterator const &end, T eventOperator)
ProcessHistoryRegistry const &	processHistoryRegistry () const
ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()
std::shared_ptr< ProductRegistry > &	productRegistry ()
std::shared_ptr< ProductRegistry const >	productRegistry () const
ProductRegistry &	productRegistryUpdate ()
	VectorInputSource (ParameterSet const &pset, VectorInputSourceDescription const &desc)
virtual	~VectorInputSource ()

Private Member Functions
virtual void	beginJob ()=0
void	clearEventPrincipal (EventPrincipal &cache)
virtual void	dropUnwantedBranches_ (std::vector< std::string > const &wantedBranches)=0
virtual void	endJob ()=0
virtual bool	readOneEvent (EventPrincipal &cache, size_t &fileNameHash, CLHEP::HepRandomEngine *, EventID const *id, bool recycleFiles)=0
void	readOneSpecified (EventPrincipal &cache, size_t &fileNameHash, EventID const &event)
virtual void	readOneSpecified (EventPrincipal &cache, size_t &fileNameHash, SecondaryEventIDAndFileInfo const &event)=0
void	throwIfOverLimit (unsigned int consecutiveRejections) const

Private Attributes
unsigned int	consecutiveRejectionsLimit_
edm::propagate_const< std::unique_ptr< ProcessHistoryRegistry > >	processHistoryRegistry_
edm::propagate_const< std::shared_ptr< ProductRegistry > >	productRegistry_

Detailed Description

Definition at line 27 of file VectorInputSource.h.

Constructor & Destructor Documentation

VectorInputSource()

edm::VectorInputSource::VectorInputSource ( ParameterSet const &  pset, VectorInputSourceDescription const &  desc  )

explicit

Definition at line 12 of file VectorInputSource.cc.

      : productRegistry_(desc.productRegistry_),
        processHistoryRegistry_(new ProcessHistoryRegistry),
        consecutiveRejectionsLimit_(pset.getUntrackedParameter<unsigned int>("consecutiveRejectionsLimit", 100)) {}

~VectorInputSource()

edm::VectorInputSource::~VectorInputSource ( )

virtual

Definition at line 17 of file VectorInputSource.cc.

{}

Member Function Documentation

beginJob()

virtual void edm::VectorInputSource::beginJob ( )

privatepure virtual

Implemented in edm::EmbeddedRootSource.

Referenced by doBeginJob().

clearEventPrincipal()

void edm::VectorInputSource::clearEventPrincipal ( EventPrincipal &  cache )

private

Definition at line 23 of file VectorInputSource.cc.

{ cache.clearEventPrincipal(); }

References utilities::cache().

Referenced by loopOverEvents(), and loopSpecified().

doBeginJob()

void edm::VectorInputSource::doBeginJob

(

)

Called at beginning of job.

Definition at line 25 of file VectorInputSource.cc.

{ this->beginJob(); }

References beginJob().

doEndJob()

void edm::VectorInputSource::doEndJob

(

)

Called at end of job.

Definition at line 27 of file VectorInputSource.cc.

{ this->endJob(); }

References endJob().

dropUnwantedBranches()

void edm::VectorInputSource::dropUnwantedBranches

(

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

wantedBranches

)

Definition at line 19 of file VectorInputSource.cc.

                                                                                         {
    this->dropUnwantedBranches_(wantedBranches);
  }

References dropUnwantedBranches_().

dropUnwantedBranches_()

virtual void edm::VectorInputSource::dropUnwantedBranches_ ( std::vector< std::string > const &  wantedBranches )

privatepure virtual

Implemented in edm::EmbeddedRootSource.

Referenced by dropUnwantedBranches().

endJob()

virtual void edm::VectorInputSource::endJob ( )

privatepure virtual

Implemented in edm::EmbeddedRootSource.

Referenced by doEndJob().

loopOverEvents()

template<typename T >

size_t edm::VectorInputSource::loopOverEvents	(	EventPrincipal &	cache,
		size_t &	fileNameHash,
		size_t	number,
		T	eventOperator,
		CLHEP::HepRandomEngine *	engine = nullptr,
		EventID const *	id = nullptr,
		bool	recycleFiles = true
	)

Definition at line 85 of file VectorInputSource.h.

                                                              {
    size_t i = 0U;
    unsigned int consecutiveRejections = 0U;
    while (i < number) {
      clearEventPrincipal(cache);
      bool found = readOneEvent(cache, fileNameHash, engine, id, recycleFiles);
      if (!found)
        break;
      bool used = eventOperator(cache, fileNameHash);
      if (used) {
        ++i;
        consecutiveRejections = 0U;
      } else if (consecutiveRejectionsLimit_ > 0) {
        ++consecutiveRejections;
        throwIfOverLimit(consecutiveRejections);
      }
    }
    return i;
  }

References utilities::cache(), clearEventPrincipal(), consecutiveRejectionsLimit_, newFWLiteAna::found, mps_fire::i, contentValuesFiles::number, readOneEvent(), throwIfOverLimit(), and mitigatedMETSequence_cff::U.

loopSpecified()

template<typename T , typename Iterator >

size_t edm::VectorInputSource::loopSpecified	(	EventPrincipal &	cache,
		size_t &	fileNameHash,
		Iterator const &	begin,
		Iterator const &	end,
		T	eventOperator
	)

Definition at line 112 of file VectorInputSource.h.

                                                                                                                {
    size_t i = 0U;
    for (Iterator iter = begin; iter != end; ++iter) {
      clearEventPrincipal(cache);
      readOneSpecified(cache, fileNameHash, *iter);
      eventOperator(cache, fileNameHash);
      ++i;
    }
    return i;
  }

References utilities::cache(), clearEventPrincipal(), mps_fire::end, mps_fire::i, readOneSpecified(), and mitigatedMETSequence_cff::U.

processHistoryRegistry()

ProcessHistoryRegistry const& edm::VectorInputSource::processHistoryRegistry ( ) const

inline

Definition at line 56 of file VectorInputSource.h.

{ return *processHistoryRegistry_; }

References processHistoryRegistry_.

processHistoryRegistryForUpdate()

ProcessHistoryRegistry& edm::VectorInputSource::processHistoryRegistryForUpdate ( )

inline

Definition at line 57 of file VectorInputSource.h.

{ return *processHistoryRegistry_; }

References processHistoryRegistry_.

productRegistry() [1/2]

std::shared_ptr<ProductRegistry>& edm::VectorInputSource::productRegistry ( )

inline

Definition at line 54 of file VectorInputSource.h.

{ return get_underlying_safe(productRegistry_); }

References edm::get_underlying_safe(), and productRegistry_.

productRegistry() [2/2]

std::shared_ptr<ProductRegistry const> edm::VectorInputSource::productRegistry ( ) const

inline

Definition at line 53 of file VectorInputSource.h.

{ return get_underlying_safe(productRegistry_); }

References edm::get_underlying_safe(), and productRegistry_.

productRegistryUpdate()

ProductRegistry& edm::VectorInputSource::productRegistryUpdate ( )

inline

Definition at line 55 of file VectorInputSource.h.

{ return *productRegistry_; }

References productRegistry_.

readOneEvent()

virtual bool edm::VectorInputSource::readOneEvent ( EventPrincipal &  cache, size_t &  fileNameHash, CLHEP::HepRandomEngine *  , EventID const *  id, bool  recycleFiles  )

privatepure virtual

Implemented in edm::EmbeddedRootSource.

Referenced by loopOverEvents().

readOneSpecified() [1/2]

void edm::VectorInputSource::readOneSpecified ( EventPrincipal &  cache, size_t &  fileNameHash, EventID const &  event  )

inlineprivate

Definition at line 68 of file VectorInputSource.h.

                                                                                             {
      SecondaryEventIDAndFileInfo info(event, fileNameHash);
      readOneSpecified(cache, fileNameHash, info);
    }

References utilities::cache(), info(), and readOneSpecified().

readOneSpecified() [2/2]

virtual void edm::VectorInputSource::readOneSpecified ( EventPrincipal &  cache, size_t &  fileNameHash, SecondaryEventIDAndFileInfo const &  event  )

privatepure virtual

Implemented in edm::EmbeddedRootSource.

Referenced by loopSpecified(), and readOneSpecified().

throwIfOverLimit()

void edm::VectorInputSource::throwIfOverLimit ( unsigned int  consecutiveRejections ) const

private

Definition at line 29 of file VectorInputSource.cc.

                                                                                   {
    if (consecutiveRejections >= consecutiveRejectionsLimit_) {
      throw cms::Exception("LogicError")
          << "VectorInputSource::loopOverEvents() read " << consecutiveRejections
          << " consecutive pileup events that were rejected by the eventOperator. "
          << "This is likely a sign of misconfiguration (of e.g. the adjusted-to pileup probability profile). "
          << "If you know what you're doing, this exception can be turned off by setting consecutiveRejectionsLimit=0.";
    }
  }

References consecutiveRejectionsLimit_, and Exception.

Referenced by loopOverEvents().

Member Data Documentation

consecutiveRejectionsLimit_

unsigned int edm::VectorInputSource::consecutiveRejectionsLimit_

private

Definition at line 81 of file VectorInputSource.h.

Referenced by loopOverEvents(), and throwIfOverLimit().

processHistoryRegistry_

edm::propagate_const<std::unique_ptr<ProcessHistoryRegistry> > edm::VectorInputSource::processHistoryRegistry_

private

Definition at line 80 of file VectorInputSource.h.

Referenced by processHistoryRegistry(), and processHistoryRegistryForUpdate().

productRegistry_

edm::propagate_const<std::shared_ptr<ProductRegistry> > edm::VectorInputSource::productRegistry_

private

Definition at line 79 of file VectorInputSource.h.

Referenced by productRegistry(), and productRegistryUpdate().