edm::global::EDProducerBase Class Reference

#include <EDProducerBase.h>

Inheritance diagram for edm::global::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
	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
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 ()
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)
virtual void	doBeginLuminosityBlockSummary_ (LuminosityBlock const &rp, 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)
virtual void	doBeginRunSummary_ (Run const &rp, EventSetup const &c)
void	doBeginStream (StreamID id)
virtual void	doBeginStream_ (StreamID id)
void	doEndJob ()
void	doEndLuminosityBlock (LuminosityBlockPrincipal &lbp, EventSetup const &c, ModuleCallingContext const *)
virtual void	doEndLuminosityBlock_ (LuminosityBlock const &lb, EventSetup const &c)
virtual void	doEndLuminosityBlockProduce_ (LuminosityBlock &lbp, EventSetup const &c)
virtual void	doEndLuminosityBlockSummary_ (LuminosityBlock const &lb, 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)
virtual void	doEndRunSummary_ (Run const &rp, EventSetup const &c)
void	doEndStream (StreamID id)
virtual void	doEndStream_ (StreamID id)
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	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenInputFile (FileBlock const &fb)
void	doStreamBeginLuminosityBlock (StreamID id, LuminosityBlockPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
virtual void	doStreamBeginLuminosityBlock_ (StreamID id, LuminosityBlock const &lbp, EventSetup const &c)
void	doStreamBeginRun (StreamID id, RunPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
virtual void	doStreamBeginRun_ (StreamID id, Run const &rp, EventSetup const &c)
void	doStreamEndLuminosityBlock (StreamID id, LuminosityBlockPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
virtual void	doStreamEndLuminosityBlock_ (StreamID id, LuminosityBlock const &lbp, EventSetup const &c)
virtual void	doStreamEndLuminosityBlockSummary_ (StreamID id, LuminosityBlock const &lbp, EventSetup const &c)
void	doStreamEndRun (StreamID id, RunPrincipal &ep, EventSetup const &c, ModuleCallingContext const *)
virtual void	doStreamEndRun_ (StreamID id, Run const &rp, EventSetup const &c)
virtual void	doStreamEndRunSummary_ (StreamID id, Run const &rp, EventSetup const &c)
virtual void	endJob ()
virtual void	preallocStreams (unsigned int)
virtual void	produce (StreamID, Event &, EventSetup const &) const =0
void	registerProductsAndCallbacks (EDProducerBase *module, ProductRegistry *reg)
void	setModuleDescription (ModuleDescription const &md)
std::string	workerType () const

Private Attributes
ModuleDescription	moduleDescription_
std::unique_ptr< ParentageID[]>	previousParentageIds_
std::unique_ptr< std::vector < BranchID >[]>	previousParentages_

Friends
class	edm::GlobalSchedule
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 46 of file EDProducerBase.h.

Member Typedef Documentation

typedef EDProducerBase edm::global::EDProducerBase::ModuleType

Definition at line 52 of file EDProducerBase.h.

Constructor & Destructor Documentation

EDProducerBase::EDProducerBase

(

)

Definition at line 40 of file EDProducerBase.cc.

                                  :
    ProducerBase(),
    moduleDescription_(),
    previousParentages_(),
    previousParentageIds_() { }

EDProducerBase::~EDProducerBase ( )

virtual

Definition at line 46 of file EDProducerBase.cc.

    {
    }

Member Function Documentation

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

static

Definition at line 241 of file EDProducerBase.cc.

References edm::global::kBaseType().

                             {
      return kBaseType;
    }

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

inlineprivatevirtual

Definition at line 116 of file EDProducerBase.h.

Referenced by doBeginJob().

{}

void EDProducerBase::doBeginJob ( )

private

Definition at line 72 of file EDProducerBase.cc.

References beginJob().

                               {
      this->beginJob();
    }

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

private

Definition at line 106 of file EDProducerBase.cc.

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

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

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

privatevirtual

Definition at line 216 of file EDProducerBase.cc.

Referenced by doBeginLuminosityBlock().

{}

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

privatevirtual

Definition at line 223 of file EDProducerBase.cc.

Referenced by doBeginLuminosityBlock().

{}

void EDProducerBase::doBeginLuminosityBlockSummary_ ( LuminosityBlock const &  rp, EventSetup const &  c  )

privatevirtual

Definition at line 218 of file EDProducerBase.cc.

Referenced by doBeginLuminosityBlock().

{}

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

private

Definition at line 82 of file EDProducerBase.cc.

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

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

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

privatevirtual

Definition at line 211 of file EDProducerBase.cc.

Referenced by doBeginRun().

{}

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

privatevirtual

Definition at line 221 of file EDProducerBase.cc.

Referenced by doBeginRun().

{}

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

privatevirtual

Definition at line 213 of file EDProducerBase.cc.

Referenced by doBeginRun().

{}

void EDProducerBase::doBeginStream ( StreamID  id )

private

Definition at line 130 of file EDProducerBase.cc.

References doBeginStream_().

                                             {
      doBeginStream_(id);
    }

void EDProducerBase::doBeginStream_ ( StreamID  id )

privatevirtual

Definition at line 201 of file EDProducerBase.cc.

Referenced by doBeginStream().

{}

void EDProducerBase::doEndJob ( )

private

Definition at line 77 of file EDProducerBase.cc.

References endJob().

                             {
      this->endJob();
    }

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

private

Definition at line 118 of file EDProducerBase.cc.

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

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

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

privatevirtual

Definition at line 217 of file EDProducerBase.cc.

Referenced by doEndLuminosityBlock().

{}

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

privatevirtual

Definition at line 224 of file EDProducerBase.cc.

Referenced by doEndLuminosityBlock().

{}

void EDProducerBase::doEndLuminosityBlockSummary_ ( LuminosityBlock const &  lb, EventSetup const &  c  )

privatevirtual

Definition at line 219 of file EDProducerBase.cc.

Referenced by doEndLuminosityBlock().

{}

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

private

Definition at line 94 of file EDProducerBase.cc.

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

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

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

privatevirtual

Definition at line 212 of file EDProducerBase.cc.

Referenced by doEndRun().

{}

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

privatevirtual

Definition at line 222 of file EDProducerBase.cc.

Referenced by doEndRun().

{}

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

privatevirtual

Definition at line 214 of file EDProducerBase.cc.

Referenced by doEndRun().

{}

void EDProducerBase::doEndStream ( StreamID  id )

private

Definition at line 134 of file EDProducerBase.cc.

References doEndStream_().

                                           {
      doEndStream_(id);
    }

void EDProducerBase::doEndStream_ ( StreamID  id )

privatevirtual

Definition at line 202 of file EDProducerBase.cc.

Referenced by doEndStream().

{}

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

private

Definition at line 51 of file EDProducerBase.cc.

References trackerHits::c, edm::ProducerBase::commit_(), alignCSCRings::e, moduleDescription_, previousParentageIds_, previousParentages_, produce(), edm::Event::setConsumer(), edm::Event::streamID(), and edm::StreamID::value().

                                                             {
      Event e(ep, moduleDescription_, mcc);
      e.setConsumer(this);
      EventSignalsSentry sentry(act,mcc);
      this->produce(e.streamID(), e, c);
      const auto streamIndex = e.streamID().value();
      commit_(e,&previousParentages_[streamIndex], &previousParentageIds_[streamIndex]);
      return true;
    }

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

private

Definition at line 196 of file EDProducerBase.cc.

                                                                                                         {
      //postForkReacquireResources(iChildIndex, iNumberOfChildren);
    }

void EDProducerBase::doPreallocate ( PreallocationConfiguration const &  iPrealloc )

private

Definition at line 64 of file EDProducerBase.cc.

References edm::PreallocationConfiguration::numberOfStreams(), preallocStreams(), previousParentageIds_, and previousParentages_.

                                                                             {
      auto const nStreams = iPrealloc.numberOfStreams();
      previousParentages_.reset(new std::vector<BranchID>[nStreams]);
      previousParentageIds_.reset( new ParentageID[nStreams]);
      preallocStreams(nStreams);
    }

void EDProducerBase::doPreForkReleaseResources ( )

private

Definition at line 191 of file EDProducerBase.cc.

                                              {
      //preForkReleaseResources();
    }

void EDProducerBase::doRespondToCloseInputFile ( FileBlock const &  fb )

private

Definition at line 186 of file EDProducerBase.cc.

                                                                 {
      //respondToCloseInputFile(fb);
    }

void EDProducerBase::doRespondToOpenInputFile ( FileBlock const &  fb )

private

Definition at line 181 of file EDProducerBase.cc.

                                                                {
      //respondToOpenInputFile(fb);
    }

void EDProducerBase::doStreamBeginLuminosityBlock ( StreamID  id, LuminosityBlockPrincipal &  ep, EventSetup const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 158 of file EDProducerBase.cc.

References doStreamBeginLuminosityBlock_(), moduleDescription_, and edm::LuminosityBlock::setConsumer().

                                                                                  {
      LuminosityBlock lb(lbp, moduleDescription_, mcc);
      lb.setConsumer(this);
      this->doStreamBeginLuminosityBlock_(id,lb, c);
    }

void EDProducerBase::doStreamBeginLuminosityBlock_ ( StreamID  id, LuminosityBlock const &  lbp, EventSetup const &  c  )

privatevirtual

Definition at line 206 of file EDProducerBase.cc.

Referenced by doStreamBeginLuminosityBlock().

{}

void EDProducerBase::doStreamBeginRun ( StreamID  id, RunPrincipal &  ep, EventSetup const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 138 of file EDProducerBase.cc.

References doStreamBeginRun_(), moduleDescription_, alignCSCRings::r, and edm::Run::setConsumer().

    {
      Run r(rp, moduleDescription_, mcc);
      r.setConsumer(this);
      this->doStreamBeginRun_(id, r, c);
    }

void EDProducerBase::doStreamBeginRun_ ( StreamID  id, Run const &  rp, EventSetup const &  c  )

privatevirtual

Definition at line 203 of file EDProducerBase.cc.

Referenced by doStreamBeginRun().

{}

void EDProducerBase::doStreamEndLuminosityBlock ( StreamID  id, LuminosityBlockPrincipal &  ep, EventSetup const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 168 of file EDProducerBase.cc.

References doStreamEndLuminosityBlock_(), doStreamEndLuminosityBlockSummary_(), moduleDescription_, and edm::LuminosityBlock::setConsumer().

                                                                                {
      LuminosityBlock lb(lbp, moduleDescription_, mcc);
      lb.setConsumer(this);
      this->doStreamEndLuminosityBlock_(id,lb, c);
      this->doStreamEndLuminosityBlockSummary_(id,lb, c);
    }

void EDProducerBase::doStreamEndLuminosityBlock_ ( StreamID  id, LuminosityBlock const &  lbp, EventSetup const &  c  )

privatevirtual

Definition at line 207 of file EDProducerBase.cc.

Referenced by doStreamEndLuminosityBlock().

{}

void EDProducerBase::doStreamEndLuminosityBlockSummary_ ( StreamID  id, LuminosityBlock const &  lbp, EventSetup const &  c  )

privatevirtual

Definition at line 208 of file EDProducerBase.cc.

Referenced by doStreamEndLuminosityBlock().

{}

void EDProducerBase::doStreamEndRun ( StreamID  id, RunPrincipal &  ep, EventSetup const &  c, ModuleCallingContext const *  mcc  )

private

Definition at line 148 of file EDProducerBase.cc.

References doStreamEndRun_(), doStreamEndRunSummary_(), moduleDescription_, alignCSCRings::r, and edm::Run::setConsumer().

                                                                    {
      Run r(rp, moduleDescription_, mcc);
      r.setConsumer(this);
      this->doStreamEndRun_(id, r, c);
      this->doStreamEndRunSummary_(id, r, c);
    }

void EDProducerBase::doStreamEndRun_ ( StreamID  id, Run const &  rp, EventSetup const &  c  )

privatevirtual

Definition at line 204 of file EDProducerBase.cc.

Referenced by doStreamEndRun().

{}

void EDProducerBase::doStreamEndRunSummary_ ( StreamID  id, Run const &  rp, EventSetup const &  c  )

privatevirtual

Definition at line 205 of file EDProducerBase.cc.

Referenced by doStreamEndRun().

{}

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

inlineprivatevirtual

Definition at line 117 of file EDProducerBase.h.

Referenced by doEndJob().

{}

void EDProducerBase::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 227 of file EDProducerBase.cc.

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

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

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

inline

Definition at line 64 of file EDProducerBase.h.

References moduleDescription_.

Referenced by edm::GlobalSchedule::GlobalSchedule().

{ return moduleDescription_; }

void EDProducerBase::preallocStreams ( unsigned  int )

privatevirtual

Definition at line 200 of file EDProducerBase.cc.

Referenced by doPreallocate().

{}

void EDProducerBase::prevalidate ( ConfigurationDescriptions &  descriptions )

static

Definition at line 234 of file EDProducerBase.cc.

References edm::edmodule_mightGet_config().

                                                                  {
      edmodule_mightGet_config(iConfig);
    }

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

privatepure virtual

Implemented in edm::TriggerResultInserter, and RandomEngineStateProducer.

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

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

inlineprivate

Definition at line 110 of file EDProducerBase.h.

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

                                                                                      {
        registerProducts(module, reg, moduleDescription_);
      }

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

inlineprivate

Definition at line 144 of file EDProducerBase.h.

References moduleDescription_.

                                                             {
        moduleDescription_ = md;
      }

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

inlineprivate

Definition at line 113 of file EDProducerBase.h.

{return "WorkerT<EDProducer>";}

Friends And Related Function Documentation

friend class edm::GlobalSchedule

friend

Definition at line 54 of file EDProducerBase.h.

template<typename T >

friend class edm::maker::ModuleHolderT

friend

Definition at line 50 of file EDProducerBase.h.

template<typename T >

friend class edm::WorkerT

friend

Definition at line 51 of file EDProducerBase.h.

Member Data Documentation

ModuleDescription edm::global::EDProducerBase::moduleDescription_

private

Definition at line 147 of file EDProducerBase.h.

Referenced by doBeginLuminosityBlock(), doBeginRun(), doEndLuminosityBlock(), doEndRun(), doEvent(), doStreamBeginLuminosityBlock(), doStreamBeginRun(), doStreamEndLuminosityBlock(), doStreamEndRun(), moduleDescription(), registerProductsAndCallbacks(), and setModuleDescription().

std::unique_ptr<ParentageID[]> edm::global::EDProducerBase::previousParentageIds_

private

Definition at line 149 of file EDProducerBase.h.

Referenced by doEvent(), and doPreallocate().

std::unique_ptr<std::vector<BranchID>[]> edm::global::EDProducerBase::previousParentages_

private

Definition at line 148 of file EDProducerBase.h.

Referenced by doEvent(), and doPreallocate().