edm::LogErrorHarvester Class Reference

Inheritance diagram for edm::LogErrorHarvester:

Public Member Functions
	LogErrorHarvester (ParameterSet const &)
Public Member Functions inherited from edm::global::EDProducer<>
	EDProducer ()=default
bool	hasAbilityToProduceInLumis () const final
bool	hasAbilityToProduceInRuns () const final
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsStreamLuminosityBlocks () const final
bool	wantsStreamRuns () const final
Public Member Functions inherited from edm::global::EDProducerBase
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
	~EDProducerBase () override
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
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)
	~ProducerBase () noexcept(false) 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
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::vector< ModuleDescription const * > &modules, 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
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
Static Public Member Functions inherited from edm::global::EDProducerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	beginJob () override
void	endJob () override
void	produce (StreamID, Event &, EventSetup const &) const override

Private Attributes
EDPutTokenT< std::vector< ErrorSummaryEntry > >	token_

Additional Inherited Members
Public Types inherited from edm::global::EDProducerBase
typedef EDProducerBase	ModuleType
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
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)
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 41 of file LogErrorHarvester.cc.

Constructor & Destructor Documentation

LogErrorHarvester::LogErrorHarvester ( ParameterSet const &  iPSet )

explicit

Definition at line 53 of file LogErrorHarvester.cc.

References edm::BranchDescription::branchType(), edm::ProducerBase::callWhenNewProductsRegistered(), edm::EDConsumerBase::consumes(), SequenceTypes::ignore(), edm::InEvent, edm::global::EDProducerBase::moduleDescription(), edm::BranchDescription::moduleLabel(), or, edm::ModuleDescription::processName(), edm::BranchDescription::processName(), edm::PRODUCT_TYPE, edm::BranchDescription::productInstanceName(), and edm::BranchDescription::unwrappedTypeID().

                                                               :
  token_{produces<std::vector<ErrorSummaryEntry>>()}
  {
    

    const edm::TypeID endPathStatusType{typeid(edm::EndPathStatus)};
    const edm::TypeID pathStatusType{typeid(edm::PathStatus)};
    const edm::TypeID triggerResultsType{typeid(edm::TriggerResults)};

    auto const& ignore = iPSet.getUntrackedParameter<std::vector<std::string>>("excludeModules");
    const std::unordered_set<std::string> excludedModules(ignore.begin(),ignore.end());

    auto const& includeM = iPSet.getUntrackedParameter<std::vector<std::string>>("includeModules");
    const std::unordered_set<std::string> includeModules(includeM.begin(),includeM.end());

    //Need to be sure to run only after all other EDProducers have run
    callWhenNewProductsRegistered([this,
                                   endPathStatusType,pathStatusType,triggerResultsType,
                                   excludedModules, includeModules](edm::BranchDescription const& iBD) 
    {
      if((iBD.branchType() == edm::InEvent and moduleDescription().processName() == iBD.processName()) and 
         ( (includeModules.empty() or
            includeModules.end() != includeModules.find(iBD.moduleLabel())) and
           (iBD.unwrappedTypeID() != endPathStatusType and
            iBD.unwrappedTypeID() != pathStatusType and
            iBD.unwrappedTypeID() != triggerResultsType))) {
        if(excludedModules.end() == excludedModules.find(iBD.moduleLabel())) {
          consumes(edm::TypeToGet{iBD.unwrappedTypeID(),edm::PRODUCT_TYPE},
                   edm::InputTag{iBD.moduleLabel(),
                                 iBD.productInstanceName(),
                                 iBD.processName()});
        }
      }
    });
  }

Member Function Documentation

void LogErrorHarvester::beginJob ( void  )

overrideprivatevirtual

Reimplemented from edm::global::EDProducerBase.

Definition at line 102 of file LogErrorHarvester.cc.

References edm::EnableLoggedErrorsSummary().

                              {
    EnableLoggedErrorsSummary();
  }

void LogErrorHarvester::endJob ( void  )

overrideprivatevirtual

Reimplemented from edm::global::EDProducerBase.

Definition at line 108 of file LogErrorHarvester.cc.

References edm::DisableLoggedErrorsSummary().

                            {
    DisableLoggedErrorsSummary();
  }

void LogErrorHarvester::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 115 of file LogErrorHarvester.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), and DEFINE_FWK_MODULE.

                                                                             {
    ParameterSetDescription desc;
    desc.addUntracked<std::vector<std::string>>("excludeModules",std::vector<std::string>{})->setComment("List of module labels to exclude from consumes.");
    desc.addUntracked<std::vector<std::string>>("includeModules",std::vector<std::string>{})->setComment("List of the only module labels to include in consumes. The empty list will include all.");
    descriptions.add("logErrorHarvester", desc);
  }

void LogErrorHarvester::produce ( StreamID  sid, Event &  iEvent, EventSetup const &    ) const

overrideprivatevirtual

Implements edm::global::EDProducerBase.

Definition at line 90 of file LogErrorHarvester.cc.

References edm::Event::emplace(), edm::FreshErrorsExist(), edm::LoggedErrorsSummary(), token_, and edm::StreamID::value().

                                                                                       {
    const auto index = sid.value();
    if(!FreshErrorsExist(index)) {
      //puts a default constructed product in the event
      iEvent.emplace(token_);
    } else {
      iEvent.emplace(token_,LoggedErrorsSummary(index));
    }
  }

Member Data Documentation

EDPutTokenT<std::vector<ErrorSummaryEntry> > edm::LogErrorHarvester::token_

private

Definition at line 50 of file LogErrorHarvester.cc.

Referenced by produce().