edm::one::EDProducerBase Class Reference

#include <EDProducerBase.h>

Inheritance diagram for edm::one::EDProducerBase:

Public Types
typedef EDProducerBase	ModuleType
Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Member Functions
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
virtual	~EDProducerBase ()
Public Member Functions inherited from edm::ProducerBase
	ProducerBase ()
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
virtual	~ProducerBase ()
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Static Public Member Functions
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
virtual void	beginJob ()
virtual SharedResourcesAcquirer	createAcquirer ()
void	doBeginJob ()
void	doBeginLuminosityBlock (LuminosityBlockPrincipal &lbp, EventSetup const &c, ModuleCallingContext const *)
virtual void	doBeginLuminosityBlock_ (LuminosityBlock const &lbp, EventSetup const &c)
virtual void	doBeginLuminosityBlockProduce_ (LuminosityBlock &lbp, EventSetup const &c)
void	doBeginRun (RunPrincipal &rp, EventSetup const &c, ModuleCallingContext const *)
virtual void	doBeginRun_ (Run const &rp, EventSetup const &c)
virtual void	doBeginRunProduce_ (Run &rp, EventSetup const &c)
void	doEndJob ()
void	doEndLuminosityBlock (LuminosityBlockPrincipal &lbp, EventSetup const &c, ModuleCallingContext const *)
virtual void	doEndLuminosityBlock_ (LuminosityBlock const &lbp, EventSetup const &c)
virtual void	doEndLuminosityBlockProduce_ (LuminosityBlock &lbp, EventSetup const &c)
void	doEndRun (RunPrincipal &rp, EventSetup const &c, ModuleCallingContext const *)
virtual void	doEndRun_ (Run const &rp, EventSetup const &c)
virtual void	doEndRunProduce_ (Run &rp, EventSetup const &c)
bool	doEvent (EventPrincipal &ep, EventSetup const &c, ActivityRegistry *, ModuleCallingContext const *)
void	doPostForkReacquireResources (unsigned int iChildIndex, unsigned int iNumberOfChildren)
void	doPreallocate (PreallocationConfiguration const &)
void	doPreForkReleaseResources ()
void	doRegisterThinnedAssociations (ProductRegistry const &, ThinnedAssociationsHelper &)
void	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenInputFile (FileBlock const &fb)
virtual void	endJob ()
virtual void	postForkReacquireResources (unsigned int, unsigned int)
virtual void	preForkReleaseResources ()
virtual void	produce (Event &, EventSetup const &)=0
void	registerProductsAndCallbacks (EDProducerBase *module, ProductRegistry *reg)
void	setModuleDescription (ModuleDescription const &md)
std::string	workerType () const

Private Attributes
ModuleDescription	moduleDescription_
std::mutex	mutex_
std::vector< BranchID >	previousParentage_
ParentageID	previousParentageId_
SharedResourcesAcquirer	resourcesAcquirer_

Friends
template<typename T >
class	edm::maker::ModuleHolderT
template<typename T >
class	edm::WorkerT

Additional Inherited Members
Protected Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
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 ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
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)

Detailed Description

Definition at line 47 of file EDProducerBase.h.

Member Typedef Documentation

typedef EDProducerBase edm::one::EDProducerBase::ModuleType

Definition at line 53 of file EDProducerBase.h.

Constructor & Destructor Documentation

EDProducerBase::EDProducerBase

(

)

Definition at line 40 of file EDProducerBase.cc.

                                  :
    ProducerBase(),
    moduleDescription_(),
    previousParentage_(),
    previousParentageId_() { }

EDProducerBase::~EDProducerBase ( )

virtual

Definition at line 46 of file EDProducerBase.cc.

    {
    }

Member Function Documentation

const std::string & EDProducerBase::baseType ( )

static

Definition at line 175 of file EDProducerBase.cc.

References edm::one::kBaseType().

                             {
      return kBaseType;
    }

virtual void edm::one::EDProducerBase::beginJob ( void  )

inlineprivatevirtual

Reimplemented in LaserAlignment, GlobalHitsProdHist, edm::BMixingModule, MEtoEDMConverter, L1GtTriggerMenuLiteProducer, TauSpinnerCMS, edm::MixingModule, L1MuGlobalMuonTrigger, and AlcaBeamSpotFromDB.

Definition at line 98 of file EDProducerBase.h.

Referenced by doBeginJob().

{}

SharedResourcesAcquirer EDProducerBase::createAcquirer ( )

privatevirtual

Definition at line 70 of file EDProducerBase.cc.

Referenced by doBeginJob().

                                                           {
      return SharedResourcesAcquirer{};
    }

void EDProducerBase::doBeginJob ( )

private

Definition at line 75 of file EDProducerBase.cc.

References beginJob(), createAcquirer(), and resourcesAcquirer_.

                               {
      resourcesAcquirer_ = createAcquirer();
      
      this->beginJob();
    }

void EDProducerBase::doBeginLuminosityBlock ( LuminosityBlockPrincipal &  lbp, EventSetup const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 109 of file EDProducerBase.cc.

References edm::ProducerBase::commit_(), doBeginLuminosityBlock_(), doBeginLuminosityBlockProduce_(), moduleDescription_, and edm::LuminosityBlock::setConsumer().

                                                                            {
      LuminosityBlock lb(lbp, moduleDescription_, mcc);
      lb.setConsumer(this);
      LuminosityBlock const& cnstLb = lb;
      this->doBeginLuminosityBlock_(cnstLb, c);
      this->doBeginLuminosityBlockProduce_(lb, c);
      commit_(lb);
    }

void EDProducerBase::doBeginLuminosityBlock_ ( LuminosityBlock const &  lbp, EventSetup const &  c  )

privatevirtual

Definition at line 152 of file EDProducerBase.cc.

Referenced by doBeginLuminosityBlock().

{}

void EDProducerBase::doBeginLuminosityBlockProduce_ ( LuminosityBlock &  lbp, EventSetup const &  c  )

privatevirtual

Definition at line 157 of file EDProducerBase.cc.

Referenced by doBeginLuminosityBlock().

{}

void EDProducerBase::doBeginRun ( RunPrincipal &  rp, EventSetup const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 87 of file EDProducerBase.cc.

References edm::ProducerBase::commit_(), doBeginRun_(), doBeginRunProduce_(), moduleDescription_, alignCSCRings::r, and edm::Run::setConsumer().

                                                                {
      Run r(rp, moduleDescription_, mcc);
      r.setConsumer(this);
      Run const& cnstR = r;
      this->doBeginRun_(cnstR, c);
      this->doBeginRunProduce_(r,c);
      commit_(r);
    }

void EDProducerBase::doBeginRun_ ( Run const &  rp, EventSetup const &  c  )

privatevirtual

Definition at line 150 of file EDProducerBase.cc.

Referenced by doBeginRun().

{}

void EDProducerBase::doBeginRunProduce_ ( Run &  rp, EventSetup const &  c  )

privatevirtual

Definition at line 155 of file EDProducerBase.cc.

Referenced by doBeginRun().

{}

void EDProducerBase::doEndJob ( )

private

Definition at line 82 of file EDProducerBase.cc.

References endJob().

                             {
      this->endJob();
    }

void EDProducerBase::doEndLuminosityBlock ( LuminosityBlockPrincipal &  lbp, EventSetup const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 120 of file EDProducerBase.cc.

References edm::ProducerBase::commit_(), doEndLuminosityBlock_(), doEndLuminosityBlockProduce_(), moduleDescription_, and edm::LuminosityBlock::setConsumer().

                                                                          {
      LuminosityBlock lb(lbp, moduleDescription_, mcc);
      lb.setConsumer(this);
      LuminosityBlock const& cnstLb = lb;
      this->doEndLuminosityBlock_(cnstLb, c);
      this->doEndLuminosityBlockProduce_(lb, c);
      commit_(lb);
    }

void EDProducerBase::doEndLuminosityBlock_ ( LuminosityBlock const &  lbp, EventSetup const &  c  )

privatevirtual

Definition at line 153 of file EDProducerBase.cc.

Referenced by doEndLuminosityBlock().

{}

void EDProducerBase::doEndLuminosityBlockProduce_ ( LuminosityBlock &  lbp, EventSetup const &  c  )

privatevirtual

Definition at line 158 of file EDProducerBase.cc.

Referenced by doEndLuminosityBlock().

{}

void EDProducerBase::doEndRun ( RunPrincipal &  rp, EventSetup const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 98 of file EDProducerBase.cc.

References edm::ProducerBase::commit_(), doEndRun_(), doEndRunProduce_(), moduleDescription_, alignCSCRings::r, and edm::Run::setConsumer().

                                                              {
      Run r(rp, moduleDescription_, mcc);
      r.setConsumer(this);
      Run const& cnstR = r;
      this->doEndRun_(cnstR, c);
      this->doEndRunProduce_(r, c);
      commit_(r);
    }

void EDProducerBase::doEndRun_ ( Run const &  rp, EventSetup const &  c  )

privatevirtual

Definition at line 151 of file EDProducerBase.cc.

Referenced by doEndRun().

{}

void EDProducerBase::doEndRunProduce_ ( Run &  rp, EventSetup const &  c  )

privatevirtual

Definition at line 156 of file EDProducerBase.cc.

Referenced by doEndRun().

{}

bool EDProducerBase::doEvent ( EventPrincipal &  ep, EventSetup const &  c, ActivityRegistry *  act, ModuleCallingContext const *  mcc  )

private

Definition at line 51 of file EDProducerBase.cc.

References edm::ProducerBase::commit_(), alignCSCRings::e, moduleDescription_, mutex_, previousParentage_, previousParentageId_, produce(), resourcesAcquirer_, and edm::Event::setConsumer().

                                                             {
      Event e(ep, moduleDescription_, mcc);
      e.setConsumer(this);
      {
        //Temporary: switch order of locks to avoid a deadlock with unscheduled
        // proper fix is to releaes resourcesAcquirer when doing a 'getBy*'
        std::lock_guard<SharedResourcesAcquirer> guard(resourcesAcquirer_);
        {
          std::lock_guard<std::mutex> guard(mutex_);
          EventSignalsSentry sentry(act,mcc);
          this->produce(e, c);
        }
        commit_(e,&previousParentage_, &previousParentageId_);
      }
      return true;
    }

void EDProducerBase::doPostForkReacquireResources ( unsigned int  iChildIndex, unsigned int  iNumberOfChildren  )

private

Definition at line 146 of file EDProducerBase.cc.

References postForkReacquireResources().

                                                                                                         {
      postForkReacquireResources(iChildIndex, iNumberOfChildren);
    }

void edm::one::EDProducerBase::doPreallocate ( PreallocationConfiguration const &  )

inlineprivate

Definition at line 70 of file EDProducerBase.h.

{}

void EDProducerBase::doPreForkReleaseResources ( )

private

Definition at line 141 of file EDProducerBase.cc.

References preForkReleaseResources().

                                              {
      preForkReleaseResources();
    }

void edm::one::EDProducerBase::doRegisterThinnedAssociations ( ProductRegistry const &  , ThinnedAssociationsHelper &    )

inlineprivate

Definition at line 89 of file EDProducerBase.h.

                                                                     { }

void EDProducerBase::doRespondToCloseInputFile ( FileBlock const &  fb )

private

Definition at line 136 of file EDProducerBase.cc.

                                                                 {
      //respondToCloseInputFile(fb);
    }

void EDProducerBase::doRespondToOpenInputFile ( FileBlock const &  fb )

private

Definition at line 131 of file EDProducerBase.cc.

                                                                {
      //respondToOpenInputFile(fb);
    }

virtual void edm::one::EDProducerBase::endJob ( void  )

inlineprivatevirtual

Reimplemented in LaserAlignment, GlobalHitsProdHist, ExternalLHEProducer, edm::BMixingModule, MEtoEDMConverter, L1GtTriggerMenuLiteProducer, TauSpinnerCMS, and AlcaBeamSpotFromDB.

Definition at line 99 of file EDProducerBase.h.

Referenced by doEndJob().

{}

void EDProducerBase::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 161 of file EDProducerBase.cc.

References edm::ConfigurationDescriptions::addDefault(), and edm::ParameterSetDescription::setUnknown().

                                                                            {
      ParameterSetDescription desc;
      desc.setUnknown();
      descriptions.addDefault(desc);
    }

ModuleDescription const& edm::one::EDProducerBase::moduleDescription ( ) const

inline

Definition at line 64 of file EDProducerBase.h.

References moduleDescription_.

Referenced by edm::MixingModule::pileAllWorkers(), and edm::DataMixingModule::pileWorker().

{ return moduleDescription_; }

virtual void edm::one::EDProducerBase::postForkReacquireResources ( unsigned  int, unsigned  int  )

inlineprivatevirtual

Definition at line 102 of file EDProducerBase.h.

Referenced by doPostForkReacquireResources().

{}

virtual void edm::one::EDProducerBase::preForkReleaseResources ( )

inlineprivatevirtual

Definition at line 101 of file EDProducerBase.h.

Referenced by doPreForkReleaseResources().

{}

void EDProducerBase::prevalidate ( ConfigurationDescriptions &  descriptions )

static

Definition at line 168 of file EDProducerBase.cc.

References edm::edmodule_mightGet_config().

                                                                  {
      edmodule_mightGet_config(iConfig);
    }

virtual void edm::one::EDProducerBase::produce ( Event &  , EventSetup const &    )

privatepure virtual

Implemented in LumiProducer, LaserAlignment, GlobalHitsProdHist, ExpressLumiProducer, ExternalLHEProducer, TkLasBeamFitter, MEtoEDMConverter, L1GtTriggerMenuLiteProducer, TauSpinnerCMS, HLTPrescaleRecorder, L1MuGlobalMuonTrigger, ConditionDumperInEdm, NjettinessAdder, GenFilterEfficiencyProducer, edm::BeamHaloProducer, CSCTriggerPrimitivesProducer, edm::BMixingModule, EventCountProducer, MillePedeFileConverter, AlcaBeamSpotProducer, DTTrackFinder, AlcaBeamSpotFromDB, edm::CosMuoGenProducer, OscarProducer, edm::ExpoRandomPtGunProducer, edm::MultiParticleInConeGunProducer, edm::FlatRandomEGunProducer, edm::FlatRandomPtGunProducer, edm::FlatRandomOneOverPtGunProducer, edm::FileRandomKEThetaGunProducer, edm::FlatRandomEThetaGunProducer, and edm::FlatRandomPtThetaGunProducer.

Referenced by doEvent(), JSONExport.JsonExport::export(), HTMLExport.HTMLExport::export(), and HTMLExport.HTMLExportStatic::export().

void edm::one::EDProducerBase::registerProductsAndCallbacks ( EDProducerBase *  module, ProductRegistry *  reg  )

inlineprivate

Definition at line 92 of file EDProducerBase.h.

References moduleDescription_, and edm::ProducerBase::registerProducts().

                                                                                      {
        registerProducts(module, reg, moduleDescription_);
      }

void edm::one::EDProducerBase::setModuleDescription ( ModuleDescription const &  md )

inlineprivate

Definition at line 116 of file EDProducerBase.h.

References popcon2dropbox_job_conf::md, and moduleDescription_.

                                                             {
        moduleDescription_ = md;
      }

std::string edm::one::EDProducerBase::workerType ( ) const

inlineprivate

Definition at line 95 of file EDProducerBase.h.

{return "WorkerT<EDProducer>";}

Friends And Related Function Documentation

template<typename T >

friend class edm::maker::ModuleHolderT

friend

Definition at line 51 of file EDProducerBase.h.

template<typename T >

friend class edm::WorkerT

friend

Definition at line 52 of file EDProducerBase.h.

Member Data Documentation

ModuleDescription edm::one::EDProducerBase::moduleDescription_

private

Definition at line 119 of file EDProducerBase.h.

Referenced by doBeginLuminosityBlock(), doBeginRun(), doEndLuminosityBlock(), doEndRun(), doEvent(), moduleDescription(), registerProductsAndCallbacks(), and setModuleDescription().

std::mutex edm::one::EDProducerBase::mutex_

private

Definition at line 124 of file EDProducerBase.h.

Referenced by doEvent().

std::vector<BranchID> edm::one::EDProducerBase::previousParentage_

private

Definition at line 120 of file EDProducerBase.h.

Referenced by doEvent().

ParentageID edm::one::EDProducerBase::previousParentageId_

private

Definition at line 121 of file EDProducerBase.h.

Referenced by doEvent().

SharedResourcesAcquirer edm::one::EDProducerBase::resourcesAcquirer_

private

Definition at line 123 of file EDProducerBase.h.

Referenced by doBeginJob(), and doEvent().