#include <FWCore/Modules/src/RunLumiEventChecker.cc>

Inheritance diagram for RunLumiEventChecker:

Public Member Functions
	RunLumiEventChecker (edm::ParameterSet const &)

	~RunLumiEventChecker () override

Public Member Functions inherited from edm::global::EDAnalyzer< edm::RunCache< rlec::Cache >, edm::LuminosityBlockCache< rlec::Cache > >
	EDAnalyzer ()=default

	EDAnalyzer (const EDAnalyzer &)=delete

const EDAnalyzer &	operator= (const EDAnalyzer &)=delete

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

bool	wantsStreamLuminosityBlocks () const final

bool	wantsStreamRuns () const final

Public Member Functions inherited from edm::global::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

	~EDAnalyzerBase () override

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase const &)=delete

	EDConsumerBase (EDConsumerBase &&)=default

ESResolverIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESResolverIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const

ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const *> const &labelsToDesc, std::string const &processName) const

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProductResolverIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::global::EDAnalyzerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	analyze (edm::StreamID, edm::Event const &, edm::EventSetup const &) const override

void	beginJob () override

void	check (edm::EventID const &iID, bool isEvent) const

void	endJob () override

std::shared_ptr< rlec::Cache >	globalBeginLuminosityBlock (edm::LuminosityBlock const &lumi, edm::EventSetup const &es) const override

std::shared_ptr< rlec::Cache >	globalBeginRun (edm::Run const &run, edm::EventSetup const &es) const override

void	globalEndLuminosityBlock (edm::LuminosityBlock const &lumi, edm::EventSetup const &es) const override

void	globalEndRun (edm::Run const &run, edm::EventSetup const &es) const override

Private Attributes
std::vector< edm::EventID >	ids_

std::atomic< unsigned int >	index_

unsigned int	maxNEvents_ = 0

unsigned int	minNEvents_ = 0

bool	unorderedEvents_

Additional Inherited Members
Public Types inherited from edm::global::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

void	resetItemsToGetFrom (BranchType iType)

Detailed Description

Description: Checks that the events passed to it come in the order specified in its configuration

Implementation: <Notes on="" implementation>="">

Definition at line 46 of file RunLumiEventChecker.cc.

Constructor & Destructor Documentation

◆ RunLumiEventChecker()

RunLumiEventChecker::RunLumiEventChecker ( edm::ParameterSet const & iConfig )

explicit

Definition at line 86 of file RunLumiEventChecker.cc.

     : ids_(iConfig.getUntrackedParameter<std::vector<edm::EventID>>("eventSequence")),
       index_(0),
       minNEvents_(iConfig.getUntrackedParameter<unsigned int>("minNumberOfEvents")),
       maxNEvents_(iConfig.getUntrackedParameter<unsigned int>("maxNumberOfEvents")),
       unorderedEvents_(iConfig.getUntrackedParameter<bool>("unorderedEvents")) {
   //now do what ever initialization is needed
 }

◆ ~RunLumiEventChecker()

RunLumiEventChecker::~RunLumiEventChecker ( )

override

Definition at line 95 of file RunLumiEventChecker.cc.

                                           {
   // do anything here that needs to be done at desctruction time
   // (e.g. close files, deallocate resources etc.)
 }

Member Function Documentation

◆ analyze()

void RunLumiEventChecker::analyze	(	edm::StreamID	,
		edm::Event const &	iEvent,
		edm::EventSetup const &
	)		const

overrideprivatevirtual

Implements edm::global::EDAnalyzerBase.

Definition at line 124 of file RunLumiEventChecker.cc.

References check(), and iEvent.

                                                                                                  {
   check(iEvent.id(), true);
 }

◆ beginJob()

void RunLumiEventChecker::beginJob ( void )

overrideprivatevirtual

Reimplemented from edm::global::EDAnalyzerBase.

Definition at line 147 of file RunLumiEventChecker.cc.

147 {}

◆ check()

void RunLumiEventChecker::check	(	edm::EventID const &	iID,
		bool	isEvent
	)		const

private

Definition at line 104 of file RunLumiEventChecker.cc.

References Exception, spr::find(), ids_, index_, and unorderedEvents_.

Referenced by analyze(), globalBeginLuminosityBlock(), globalBeginRun(), globalEndLuminosityBlock(), and globalEndRun().

                                                                                {
   if (index_ >= ids_.size()) {
     throw cms::Exception("TooManyEvents")
         << "Was passes " << ids_.size() << " EventIDs but have processed more events than that\n";
   }
   if (unorderedEvents_) {
     auto itFound = std::find(ids_.begin(), ids_.end(), iEventID);
     if (itFound == ids_.end()) {
       throw cms::Exception("UnexpecedEvent") << "The event " << iEventID << " was not expected.";
     }
   } else {
     if (iEventID != ids_[index_]) {
       throw cms::Exception("WrongEvent") << "Was expecting event " << ids_[index_] << " but was given " << iEventID
                                          << "\n";
     }
   }
   ++index_;
 }

◆ endJob()

void RunLumiEventChecker::endJob ( void )

overrideprivatevirtual

Reimplemented from edm::global::EDAnalyzerBase.

Definition at line 150 of file RunLumiEventChecker.cc.

References Exception, ids_, index_, maxNEvents_, and minNEvents_.

                                  {
   if (maxNEvents_ == 0 and index_ != ids_.size()) {
     throw cms::Exception("WrongNumberOfEvents")
         << "Saw " << index_ << " (begin runs)+(begin lumis)+events+(end lumis)+(end runs) but was supposed to see "
         << ids_.size() << "\n";
   }
   if (maxNEvents_ != 0 and (index_ < minNEvents_ or index_ > maxNEvents_)) {
     throw cms::Exception("WrongNumberOfEvents")
         << "Saw " << index_
         << " (begin runs)+(begin lumis)+events+(end lumis)+(end runs) but was supposed to see between " << minNEvents_
         << " and " << maxNEvents_;
   }
 }

◆ fillDescriptions()

void RunLumiEventChecker::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 165 of file RunLumiEventChecker.cc.

References edm::ConfigurationDescriptions::add(), and submitPVResolutionJobs::desc.

                                                                                      {
   edm::ParameterSetDescription desc;
   desc.addUntracked<std::vector<edm::EventID>>("eventSequence");
   desc.addUntracked<unsigned int>("minNumberOfEvents", 0)
       ->setComment(
           "minimum number of Events that must be seen. If max is 0 then this will be ignored and all Events must be "
           "present");
   desc.addUntracked<unsigned int>("maxNumberOfEvents", 0)
       ->setComment("maximum number of Events that must be seen. If set to 0, min and max are ignored");
   desc.addUntracked<bool>("unorderedEvents", false)
       ->setComment("set to true if events are not guaranteed to be in same order as 'eventSequence' specifies.");
   descriptions.add("runLumiEventIDChecker", desc);
 }

◆ globalBeginLuminosityBlock()

std::shared_ptr< rlec::Cache > RunLumiEventChecker::globalBeginLuminosityBlock	(	edm::LuminosityBlock const &	lumi,
		edm::EventSetup const &	es
	)		const

overrideprivate

Definition at line 136 of file RunLumiEventChecker.cc.

References check().

                                                                                                          {
   check(edm::EventID(lumi.id().run(), lumi.id().luminosityBlock(), 0), false);
   return std::shared_ptr<rlec::Cache>{};
 }

◆ globalBeginRun()

std::shared_ptr< rlec::Cache > RunLumiEventChecker::globalBeginRun	(	edm::Run const &	run,
		edm::EventSetup const &	es
	)		const

overrideprivate

Definition at line 128 of file RunLumiEventChecker.cc.

References check(), and writedatasetfile::run.

                                                                                                           {
   check(edm::EventID(run.id().run(), 0, 0), false);
   return std::shared_ptr<rlec::Cache>{};
 }

◆ globalEndLuminosityBlock()

void RunLumiEventChecker::globalEndLuminosityBlock	(	edm::LuminosityBlock const &	lumi,
		edm::EventSetup const &	es
	)		const

overrideprivate

Definition at line 142 of file RunLumiEventChecker.cc.

References check().

                                                                                                              {
   check(edm::EventID(lumi.id().run(), lumi.id().luminosityBlock(), 0), false);
 }

◆ globalEndRun()

void RunLumiEventChecker::globalEndRun	(	edm::Run const &	run,
		edm::EventSetup const &	es
	)		const

overrideprivate

Definition at line 132 of file RunLumiEventChecker.cc.

References check(), and writedatasetfile::run.

                                                                                     {
   check(edm::EventID(run.id().run(), 0, 0), false);
 }

Member Data Documentation

◆ ids_

std::vector<edm::EventID> RunLumiEventChecker::ids_

private

Definition at line 68 of file RunLumiEventChecker.cc.

Referenced by check(), and endJob().

◆ index_

std::atomic<unsigned int> RunLumiEventChecker::index_

mutableprivate

Definition at line 69 of file RunLumiEventChecker.cc.

Referenced by check(), and endJob().

◆ maxNEvents_

unsigned int RunLumiEventChecker::maxNEvents_ = 0

private

Definition at line 71 of file RunLumiEventChecker.cc.

Referenced by endJob().

◆ minNEvents_

unsigned int RunLumiEventChecker::minNEvents_ = 0

private

Definition at line 70 of file RunLumiEventChecker.cc.

Referenced by endJob().

◆ unorderedEvents_

bool RunLumiEventChecker::unorderedEvents_

private

Definition at line 72 of file RunLumiEventChecker.cc.

Referenced by check().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RunLumiEventChecker()

◆ ~RunLumiEventChecker()

Member Function Documentation

◆ analyze()

◆ beginJob()

◆ check()

◆ endJob()

◆ fillDescriptions()

◆ globalBeginLuminosityBlock()

◆ globalBeginRun()

◆ globalEndLuminosityBlock()

◆ globalEndRun()

Member Data Documentation

◆ ids_

◆ index_

◆ maxNEvents_

◆ minNEvents_

◆ unorderedEvents_