edm::one::EDAnalyzerBase Class Reference

#include <EDAnalyzerBase.h>

Inheritance diagram for edm::one::EDAnalyzerBase:

Public Types
typedef EDAnalyzerBase	ModuleType

Public Member Functions
	EDAnalyzerBase ()
ModuleDescription const &	moduleDescription () const
virtual	~EDAnalyzerBase ()
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)

Protected Member Functions
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)

Private Member Functions
virtual void	analyze (Event const &, EventSetup const &)=0
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)
void	doBeginRun (RunPrincipal &rp, EventSetup const &c, ModuleCallingContext const *)
virtual void	doBeginRun_ (Run const &rp, EventSetup const &c)
void	doEndJob ()
void	doEndLuminosityBlock (LuminosityBlockPrincipal &lbp, EventSetup const &c, ModuleCallingContext const *)
virtual void	doEndLuminosityBlock_ (LuminosityBlock const &lbp, EventSetup const &c)
void	doEndRun (RunPrincipal &rp, EventSetup const &c, ModuleCallingContext const *)
virtual void	doEndRun_ (Run const &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	doRespondToCloseInputFile (FileBlock const &fb)
void	doRespondToOpenInputFile (FileBlock const &fb)
virtual void	endJob ()
void	registerProductsAndCallbacks (EDAnalyzerBase const *module, ProductRegistry *reg)
void	setModuleDescription (ModuleDescription const &md)
std::string	workerType () const

Private Attributes
std::function< void(BranchDescription const &)>	callWhenNewProductsRegistered_
ModuleDescription	moduleDescription_
std::mutex	mutex_
SharedResourcesAcquirer	resourcesAcquirer_

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

Detailed Description

Definition at line 44 of file EDAnalyzerBase.h.

Member Typedef Documentation

typedef EDAnalyzerBase edm::one::EDAnalyzerBase::ModuleType

Definition at line 51 of file EDAnalyzerBase.h.

Constructor & Destructor Documentation

EDAnalyzerBase::EDAnalyzerBase

(

)

Definition at line 42 of file EDAnalyzerBase.cc.

                                  :
    moduleDescription_() { }

EDAnalyzerBase::~EDAnalyzerBase ( )

virtual

Definition at line 45 of file EDAnalyzerBase.cc.

    {
    }

Member Function Documentation

virtual void edm::one::EDAnalyzerBase::analyze ( Event const &  , EventSetup const &    )

privatepure virtual

Implemented in CocoaAnalyzer, and DQMEDHarvester.

Referenced by doEvent().

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

static

Definition at line 156 of file EDAnalyzerBase.cc.

References edm::one::kBaseType().

                             {
      return kBaseType;
    }

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

inlineprivatevirtual

Reimplemented in HLTMuonCertSummary, CocoaAnalyzer, and DQMExample_Step2.

Definition at line 96 of file EDAnalyzerBase.h.

Referenced by doBeginJob().

{}

void edm::one::EDAnalyzerBase::callWhenNewProductsRegistered ( std::function< void(BranchDescription const &)> const &  func )

protected

SharedResourcesAcquirer EDAnalyzerBase::createAcquirer ( )

privatevirtual

Definition at line 64 of file EDAnalyzerBase.cc.

Referenced by doBeginJob().

                                                           {
      return SharedResourcesAcquirer{};
    }

void EDAnalyzerBase::doBeginJob ( )

private

Definition at line 69 of file EDAnalyzerBase.cc.

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

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

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

private

Definition at line 99 of file EDAnalyzerBase.cc.

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

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

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

privatevirtual

Definition at line 138 of file EDAnalyzerBase.cc.

Referenced by doBeginLuminosityBlock().

{}

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

private

Definition at line 81 of file EDAnalyzerBase.cc.

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

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

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

privatevirtual

Definition at line 136 of file EDAnalyzerBase.cc.

Referenced by doBeginRun().

{}

void EDAnalyzerBase::doEndJob ( )

private

Definition at line 76 of file EDAnalyzerBase.cc.

References endJob().

                             {
      this->endJob();
    }

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

private

Definition at line 108 of file EDAnalyzerBase.cc.

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

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

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

privatevirtual

Definition at line 139 of file EDAnalyzerBase.cc.

Referenced by doEndLuminosityBlock().

{}

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

private

Definition at line 90 of file EDAnalyzerBase.cc.

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

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

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

privatevirtual

Definition at line 137 of file EDAnalyzerBase.cc.

Referenced by doEndRun().

{}

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

private

Definition at line 50 of file EDAnalyzerBase.cc.

References analyze(), alignCSCRings::e, moduleDescription_, mutex_, resourcesAcquirer_, and edm::Event::setConsumer().

                                                             {
      Event e(ep, moduleDescription_, mcc);
      e.setConsumer(this);
      {
        std::lock_guard<std::mutex> guard(mutex_);
        std::lock_guard<SharedResourcesAcquirer> guardResources(resourcesAcquirer_);
        EventSignalsSentry sentry(act,mcc);
        this->analyze(e, c);
      }
      return true;
    }

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

private

Definition at line 132 of file EDAnalyzerBase.cc.

                                                                                                         {
      //postForkReacquireResources(iChildIndex, iNumberOfChildren);
    }

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

inlineprivate

Definition at line 72 of file EDAnalyzerBase.h.

{}

void EDAnalyzerBase::doPreForkReleaseResources ( )

private

Definition at line 127 of file EDAnalyzerBase.cc.

                                              {
      //preForkReleaseResources();
    }

void EDAnalyzerBase::doRespondToCloseInputFile ( FileBlock const &  fb )

private

Definition at line 122 of file EDAnalyzerBase.cc.

                                                                 {
      //respondToCloseInputFile(fb);
    }

void EDAnalyzerBase::doRespondToOpenInputFile ( FileBlock const &  fb )

private

Definition at line 117 of file EDAnalyzerBase.cc.

                                                                {
      //respondToOpenInputFile(fb);
    }

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

inlineprivatevirtual

Reimplemented in DQMEDHarvester.

Definition at line 97 of file EDAnalyzerBase.h.

Referenced by doEndJob().

{}

void EDAnalyzerBase::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 142 of file EDAnalyzerBase.cc.

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

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

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

inline

Definition at line 62 of file EDAnalyzerBase.h.

References moduleDescription_.

{ return moduleDescription_; }

void EDAnalyzerBase::prevalidate ( ConfigurationDescriptions &  descriptions )

static

Definition at line 149 of file EDAnalyzerBase.cc.

References edm::edmodule_mightGet_config().

                                                                  {
      edmodule_mightGet_config(iConfig);
    }

void EDAnalyzerBase::registerProductsAndCallbacks ( EDAnalyzerBase const *  module, ProductRegistry *  reg  )

private

Definition at line 161 of file EDAnalyzerBase.cc.

References edm::ProductRegistry::callForEachBranch(), and callWhenNewProductsRegistered_.

                                                                                            {
      
      if (callWhenNewProductsRegistered_) {
        
        reg->callForEachBranch(callWhenNewProductsRegistered_);
        
        Service<ConstProductRegistry> regService;
        regService->watchProductAdditions(callWhenNewProductsRegistered_);
      }
    }

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

inlineprivate

Definition at line 106 of file EDAnalyzerBase.h.

References moduleDescription_.

                                                             {
        moduleDescription_ = md;
      }

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

inlineprivate

Definition at line 93 of file EDAnalyzerBase.h.

{return "WorkerT<EDAnalyzer>";}

Friends And Related Function Documentation

template<typename T >

friend class edm::maker::ModuleHolderT

friend

Definition at line 49 of file EDAnalyzerBase.h.

template<typename T >

friend class edm::WorkerT

friend

Definition at line 48 of file EDAnalyzerBase.h.

Member Data Documentation

std::function<void(BranchDescription const&)> edm::one::EDAnalyzerBase::callWhenNewProductsRegistered_

private

Definition at line 110 of file EDAnalyzerBase.h.

Referenced by registerProductsAndCallbacks().

ModuleDescription edm::one::EDAnalyzerBase::moduleDescription_

private

Definition at line 109 of file EDAnalyzerBase.h.

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

std::mutex edm::one::EDAnalyzerBase::mutex_

private

Definition at line 113 of file EDAnalyzerBase.h.

Referenced by doEvent().

SharedResourcesAcquirer edm::one::EDAnalyzerBase::resourcesAcquirer_

private

Definition at line 112 of file EDAnalyzerBase.h.

Referenced by doBeginJob(), and doEvent().