#include <PuttableSourceBase.h>

Inheritance diagram for edm::PuttableSourceBase:

Public Member Functions
bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginRuns () const final

PuttableSourceBase &	operator= (const PuttableSourceBase &)=delete

	PuttableSourceBase (const PuttableSourceBase &)=delete

	PuttableSourceBase (ParameterSet const &, InputSourceDescription const &)

void	registerProducts () final
	Register any produced products. More...

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)

Public Member Functions inherited from edm::InputSource
std::shared_ptr< ActivityRegistry >	actReg () const
	Accessor for Activity Registry. More...

std::shared_ptr< BranchIDListHelper > &	branchIDListHelper ()

std::shared_ptr< BranchIDListHelper const >	branchIDListHelper () const
	Accessors for branchIDListHelper. More...

void	closeFile (FileBlock *, bool cleaningUpAfterException)
	close current file More...

void	doBeginJob ()
	Called by framework at beginning of job. More...

void	doEndJob ()
	Called by framework at end of job. More...

void	fillProcessBlockHelper ()
	Fill the ProcessBlockHelper with info for the current file. More...

ProcessingController::ForwardState	forwardState () const

bool	goToEvent (EventID const &eventID)

	InputSource (InputSource const &)=delete

	InputSource (ParameterSet const &, InputSourceDescription const &)
	Constructor. More...

void	issueReports (EventID const &eventID, StreamID streamID)
	issue an event report More...

LuminosityBlockNumber_t	luminosityBlock () const
	Accessor for current luminosity block number. More...

std::shared_ptr< LuminosityBlockAuxiliary >	luminosityBlockAuxiliary () const
	Called by the framework to merge or insert lumi in principal cache. More...

int	maxEvents () const

int	maxLuminosityBlocks () const

ModuleDescription const &	moduleDescription () const
	Accessor for 'module' description. More...

ItemType	nextItemType ()
	Advances the source to the next item. More...

bool	nextProcessBlock (ProcessBlockPrincipal &)
	Next process block, return false if there is none, sets the processName in the principal. More...

InputSource &	operator= (InputSource const &)=delete

std::shared_ptr< ProcessBlockHelper > &	processBlockHelper ()

std::shared_ptr< ProcessBlockHelper const >	processBlockHelper () const
	Accessors for processBlockHelper. More...

ProcessConfiguration const &	processConfiguration () const
	Accessor for Process Configuration. More...

std::string const &	processGUID () const
	Accessor for global process identifier. More...

ProcessHistoryRegistry &	processHistoryRegistry ()

ProcessHistoryRegistry const &	processHistoryRegistry () const
	Accessors for process history registry. More...

ProcessingMode	processingMode () const
	RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...

std::shared_ptr< ProductRegistry > &	productRegistry ()

std::shared_ptr< ProductRegistry const >	productRegistry () const
	Accessors for product registry. More...

bool	randomAccess () const

void	readAndMergeLumi (LuminosityBlockPrincipal &lbp)
	Read next luminosity block (same as a prior lumi) More...

void	readAndMergeRun (RunPrincipal &rp)
	Read next run (same as a prior run) More...

bool	readEvent (EventPrincipal &ep, EventID const &, StreamContext &)
	Read a specific event. More...

void	readEvent (EventPrincipal &ep, StreamContext &)
	Read next event. More...

std::shared_ptr< FileBlock >	readFile ()
	Read next file. More...

void	readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
	Read next luminosity block (new lumi) More...

std::shared_ptr< LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary ()
	Read next luminosity block Auxilary. More...

void	readProcessBlock (ProcessBlockPrincipal &)
	Read next process block. More...

void	readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
	Read next run (new run) More...

std::shared_ptr< RunAuxiliary >	readRunAuxiliary ()
	Read next run Auxiliary. More...

ProcessHistoryID const &	reducedProcessHistoryID () const

int	remainingEvents () const

int	remainingLuminosityBlocks () const

void	repeat ()
	Reset the remaining number of events/lumis to the maximum number. More...

std::pair< SharedResourcesAcquirer , std::recursive_mutex >	resourceSharedWithDelayedReader ()
	Returns nullptr if no resource shared between the Source and a DelayedReader. More...

ProcessingController::ReverseState	reverseState () const

void	rewind ()
	Begin again at the first event. More...

RunNumber_t	run () const
	Accessor for current run number. More...

std::shared_ptr< RunAuxiliary >	runAuxiliary () const
	Called by the framework to merge or insert run in principal cache. More...

void	setLuminosityBlockNumber_t (LuminosityBlockNumber_t lb)
	Set the luminosity block ID. More...

void	setRunNumber (RunNumber_t r)
	Set the run number. More...

void	skipEvents (int offset)

std::shared_ptr< ThinnedAssociationsHelper > &	thinnedAssociationsHelper ()

std::shared_ptr< ThinnedAssociationsHelper const >	thinnedAssociationsHelper () const
	Accessors for thinnedAssociationsHelper. More...

Timestamp const &	timestamp () const
	Accessor for the current time, as seen by the input source. More...

virtual	~InputSource () noexcept(false)
	Destructor. More...

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

std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const

	ProducerBase ()

std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const

std::vector< bool > const &	recordProvenanceList () const

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)

TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...

	~ProducerBase () noexcept(false) override

Protected Member Functions
void	beginJob () override
	Begin protected makes it easier to do template programming. More...

Protected Member Functions inherited from edm::InputSource
void	decreaseRemainingEventsBy (int iSkipped)

bool	eventCached () const

bool	newLumi () const

bool	newRun () const

ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()

ProductRegistry &	productRegistryUpdate ()

void	reset () const

void	resetEventCached ()

void	resetLuminosityBlockAuxiliary (bool isNewLumi=true) const

void	resetNewLumi ()

void	resetNewRun ()

void	resetRunAuxiliary (bool isNewRun=true) const

void	setEventCached ()
	Called by the framework to merge or ached() const {return eventCached_;}. More...

void	setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)

void	setNewLumi ()

void	setNewRun ()

void	setRunAuxiliary (RunAuxiliary *rp)

void	setTimestamp (Timestamp const &theTime)
	To set the current time, as seen by the input source. More...

virtual void	skip (int offset)

ItemType	state () const

Protected Member Functions inherited from edm::ProducerBase
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
	declare what type of product will make and with which optional label More...

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()

BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

ProducesCollector	producesCollector ()

Private Member Functions
virtual void	beginLuminosityBlock (LuminosityBlock &)

virtual void	beginRun (Run &)

void	doBeginLumi (LuminosityBlockPrincipal &lbp, ProcessContext const *) override
	Called by framework at beginning of lumi block. More...

void	doBeginRun (RunPrincipal &rp, ProcessContext const *) override
	Called by framework at beginning of run. More...

Additional Inherited Members
Public Types inherited from edm::InputSource
enum	ItemType { IsInvalid, IsStop, IsFile, IsRun, IsLumi, IsEvent, IsRepeat, IsSynchronize }

enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }

Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const , const char , edm::ProductResolverIndex > >

typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

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

static void	fillDescription (ParameterSetDescription &desc)

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Public Attributes inherited from edm::InputSource
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	postEventReadFromSourceSignal_

signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	preEventReadFromSourceSignal_

Detailed Description

Definition at line 30 of file PuttableSourceBase.h.

Constructor & Destructor Documentation

◆ PuttableSourceBase() [1/2]

PuttableSourceBase::PuttableSourceBase	(	ParameterSet const &	iPSet,
		InputSourceDescription const &	iISD
	)

Definition at line 38 of file PuttableSourceBase.cc.

39 : InputSource(iPSet, iISD) {}

◆ PuttableSourceBase() [2/2]

edm::PuttableSourceBase::PuttableSourceBase ( const PuttableSourceBase & )

delete

Member Function Documentation

◆ beginJob()

void PuttableSourceBase::beginJob ( void )

overrideprotectedvirtual

Begin protected makes it easier to do template programming.

Reimplemented from edm::InputSource.

Reimplemented in edm::IDGeneratorSourceBase< PuttableSourceBase >.

Definition at line 43 of file PuttableSourceBase.cc.

                                   {
   auto r = productRegistry();
   auto const runLookup = r->productLookup(InRun);
   auto const lumiLookup = r->productLookup(InLumi);
   auto const eventLookup = r->productLookup(InEvent);
   auto const& processName = moduleDescription().processName();
   auto const& moduleLabel = moduleDescription().moduleLabel();
  
   auto const& runModuleToIndicies = runLookup->indiciesForModulesInProcess(processName);
   auto const& lumiModuleToIndicies = lumiLookup->indiciesForModulesInProcess(processName);
   auto const& eventModuleToIndicies = eventLookup->indiciesForModulesInProcess(processName);
   resolvePutIndicies(InRun, runModuleToIndicies, moduleLabel);
   resolvePutIndicies(InLumi, lumiModuleToIndicies, moduleLabel);
   resolvePutIndicies(InEvent, eventModuleToIndicies, moduleLabel);
 }

References edm::InEvent, edm::InLumi, edm::InRun, edm::InputSource::moduleDescription(), HerwigMaxPtPartonFilter_cfi::moduleLabel, edm::ModuleDescription::moduleLabel(), SimL1EmulatorRepack_CalouGT_cff::processName, edm::ModuleDescription::processName(), edm::InputSource::productRegistry(), alignCSCRings::r, and edm::ProducerBase::resolvePutIndicies().

◆ beginLuminosityBlock()

void PuttableSourceBase::beginLuminosityBlock ( LuminosityBlock & )

privatevirtual

Reimplemented in DQMRootSource, and dqmservices::DQMProtobufReader.

Definition at line 75 of file PuttableSourceBase.cc.

75 {}

Referenced by doBeginLumi().

◆ beginRun()

void PuttableSourceBase::beginRun ( Run & )

privatevirtual

Reimplemented in DQMRootSource, MCatNLOSource, and AlpgenSource.

Definition at line 73 of file PuttableSourceBase.cc.

73 {}

Referenced by doBeginRun().

◆ doBeginLumi()

void PuttableSourceBase::doBeginLumi	(	LuminosityBlockPrincipal &	lbp,
		ProcessContext const *
	)

overrideprivatevirtual

Called by framework at beginning of lumi block.

Reimplemented from edm::InputSource.

Definition at line 66 of file PuttableSourceBase.cc.

                                                                                          {
   LuminosityBlock lb(lbp, moduleDescription(), nullptr, false);
   lb.setProducer(this);
   callWithTryCatchAndPrint<void>([this, &lb]() { beginLuminosityBlock(lb); }, "Calling Source::beginLuminosityBlock");
   commit_(lb);
 }

References beginLuminosityBlock(), edm::ProducerBase::commit_(), edm::InputSource::moduleDescription(), and edm::LuminosityBlock::setProducer().

◆ doBeginRun()

void PuttableSourceBase::doBeginRun	(	RunPrincipal &	rp,
		ProcessContext const *
	)

overrideprivatevirtual

Called by framework at beginning of run.

Reimplemented from edm::InputSource.

Definition at line 59 of file PuttableSourceBase.cc.

                                                                            {
   Run run(rp, moduleDescription(), nullptr, false);
   run.setProducer(this);
   callWithTryCatchAndPrint<void>([this, &run]() { beginRun(run); }, "Calling Source::beginRun");
   commit_(run);
 }

References beginRun(), edm::ProducerBase::commit_(), edm::InputSource::moduleDescription(), and edm::InputSource::run().

◆ hasAbilityToProduceInBeginLumis()

bool edm::PuttableSourceBase::hasAbilityToProduceInBeginLumis ( ) const

inlinefinalvirtual

Reimplemented from edm::ProductRegistryHelper.

Definition at line 47 of file PuttableSourceBase.h.

47 { return true; }

◆ hasAbilityToProduceInBeginRuns()

bool edm::PuttableSourceBase::hasAbilityToProduceInBeginRuns ( ) const

inlinefinalvirtual

Reimplemented from edm::ProductRegistryHelper.

Definition at line 45 of file PuttableSourceBase.h.

45 { return true; }

◆ operator=()

PuttableSourceBase& edm::PuttableSourceBase::operator= ( const PuttableSourceBase & )

delete

◆ registerProducts() [1/2]

void PuttableSourceBase::registerProducts ( )

finalvirtual

Register any produced products.

Reimplemented from edm::InputSource.

Definition at line 41 of file PuttableSourceBase.cc.

41 { registerProducts(this, &productRegistryUpdate(), moduleDescription()); }

References edm::InputSource::moduleDescription(), and edm::InputSource::productRegistryUpdate().

◆ registerProducts() [2/2]

void edm::ProducerBase::registerProducts

Definition at line 57 of file ProducerBase.cc.

                                                                                                                 {
     if (typeLabelList().empty() && !registrationCallback()) {
       return;
     }
     //If we have a callback, first tell the callback about all the entries already in the
     // product registry, then add any items this producer wants to add to the registry
     // and only after that do we register the callback. This is done so the callback does not
     // get called for items registered by this producer (avoids circular reference problems)
     bool isListener = false;
     if (registrationCallback()) {
       isListener = true;
       iReg->callForEachBranch(registrationCallback());
     }
     TypeLabelList const& plist = typeLabelList();
  
     ProductRegistryHelper::addToRegistry(plist.begin(), plist.end(), md, *(iReg), this, isListener);
     if (registrationCallback()) {
       Service<ConstProductRegistry> regService;
       regService->watchProductAdditions(CallbackWrapper(producer, registrationCallback(), iReg, md));
     }
   }

◆ resolvePutIndicies()

void edm::ProducerBase::resolvePutIndicies

Definition at line 79 of file ProducerBase.cc.

                                                                       {
     auto const& plist = typeLabelList();
     if (putTokenToResolverIndex_.size() != plist.size()) {
       putTokenToResolverIndex_.resize(plist.size(), std::numeric_limits<unsigned int>::max());
     }
     auto range = iIndicies.equal_range(moduleLabel);
     putIndicies_[iBranchType].reserve(iIndicies.count(moduleLabel));
     for (auto it = range.first; it != range.second; ++it) {
       putIndicies_[iBranchType].push_back(std::get<2>(it->second));
       unsigned int i = 0;
       for (auto const& tl : plist) {
         if (convertToBranchType(tl.transition_) == iBranchType and (tl.typeID_ == *std::get<0>(it->second)) and
             (tl.productInstanceName_ == std::get<1>(it->second))) {
           putTokenToResolverIndex_[i] = std::get<2>(it->second);
           //NOTE: The ExternalLHEProducer puts the 'same' product in at
           // both beginRun and endRun. Therefore we can get multiple matches.
           // When the module is finally fixed, we can use the 'break'
           //break;
         }
         ++i;
       }
     }
   }

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PuttableSourceBase() [1/2]

◆ PuttableSourceBase() [2/2]

Member Function Documentation

◆ beginJob()

◆ beginLuminosityBlock()

◆ beginRun()

◆ doBeginLumi()

◆ doBeginRun()

◆ hasAbilityToProduceInBeginLumis()

◆ hasAbilityToProduceInBeginRuns()

◆ operator=()

◆ registerProducts() [1/2]

◆ registerProducts() [2/2]

◆ resolvePutIndicies()