CMS 3D CMS Logo

List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends
edm::stream::EDFilterBase Class Referenceabstract

#include "FWCore/Framework/interface/stream/EDFilterBase.h"

Inheritance diagram for edm::stream::EDFilterBase:
edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper edm::stream::EDFilter< edm::GlobalCache< AlCaGammaJet::Counters > > edm::stream::EDFilter< edm::GlobalCache< AlCaHBHEMuons::Counters > > edm::stream::EDFilter< edm::GlobalCache< AlCaHEMuons::Counters > > edm::stream::EDFilter< edm::GlobalCache< AlCaIsolatedBunch::Counters > > edm::stream::EDFilter< edm::GlobalCache< AlCaIsoTracks::Counters > > edm::stream::EDFilter< edm::GlobalCache< AlCaIsoTracksProdFilter::Counters > > edm::stream::EDFilter< edm::GlobalCache< AlCaLowPUHBHEMuons::Counters > > edm::stream::EDFilter< edm::GlobalCache< prescale::Efficiency > > edm::stream::EDFilter< edm::GlobalCache< PythiaFilterIsoTracks::Counters > > edm::stream::EDFilter< edm::GlobalCache< trigger::Efficiency > > edm::stream::EDFilter<> edm::stream::EDFilter< T >

Public Types

typedef EDFilterAdaptorBase 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
 

Public Member Functions

 EDFilterBase ()
 
ModuleDescription const & moduleDescription () const
 
 ~EDFilterBase () 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< ConsumesInfoconsumesInfo () 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
 
ESProxyIndex const * esGetTokenIndices (edm::Transition iTrans) const
 
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
 
EDConsumerBaseoperator= (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)
 
void updateLookup (eventsetup::ESRecordsToProxyIndices const &)
 
virtual ~EDConsumerBase () noexcept(false)
 

Static Public Member Functions

static const std::string & baseType ()
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &descriptions)
 

Private Member Functions

virtual void beginLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &)
 
virtual void beginRun (edm::Run const &, edm::EventSetup const &)
 
virtual void beginStream (StreamID)
 
virtual void doAcquire_ (Event const &, EventSetup const &, WaitingTaskWithArenaHolder &)=0
 
 EDFilterBase (const EDFilterBase &)=delete
 
virtual void endLuminosityBlock (edm::LuminosityBlock const &, edm::EventSetup const &)
 
virtual void endRun (edm::Run const &, edm::EventSetup const &)
 
virtual void endStream ()
 
virtual bool filter (Event &, EventSetup const &)=0
 
const EDFilterBaseoperator= (const EDFilterBase &)=delete
 
virtual void registerThinnedAssociations (ProductRegistry const &, ThinnedAssociationsHelper &)
 
void setModuleDescriptionPtr (ModuleDescription const *iDesc)
 

Private Attributes

std::vector< BranchIDgotBranchIDsFromAcquire_
 
ModuleDescription const * moduleDescriptionPtr_
 
std::vector< BranchIDpreviousParentage_
 
ParentageID previousParentageId_
 

Friends

class EDFilterAdaptorBase
 
class ProducingModuleAdaptorBase< EDFilterBase >
 

Additional Inherited Members

- 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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes ()
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes (ESInputTag const &tag)
 
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

Description: [one line class summary]

Usage: <usage>

Definition at line 43 of file EDFilterBase.h.

Member Typedef Documentation

Definition at line 49 of file EDFilterBase.h.

Constructor & Destructor Documentation

EDFilterBase::EDFilterBase ( )

Definition at line 34 of file EDFilterBase.cc.

Referenced by moduleDescription().

34 : moduleDescriptionPtr_(nullptr) {}
ModuleDescription const * moduleDescriptionPtr_
Definition: EDFilterBase.h:84
EDFilterBase::~EDFilterBase ( )
override

Definition at line 41 of file EDFilterBase.cc.

41 {}
edm::stream::EDFilterBase::EDFilterBase ( const EDFilterBase )
privatedelete

Member Function Documentation

const std::string & EDFilterBase::baseType ( )
static

Definition at line 76 of file EDFilterBase.cc.

References edm::kBaseType().

76 { return kBaseType; }
static const std::string kBaseType("EDAnalyzer")
virtual void edm::stream::EDFilterBase::beginLuminosityBlock ( edm::LuminosityBlock const &  ,
edm::EventSetup const &   
)
inlineprivatevirtual

Reimplemented in AlCaGammaJetSelector, HLTPrescaler, HGCalTBCheckGunPostion, and LogErrorFilter.

Definition at line 68 of file EDFilterBase.h.

References filter().

68 {}
virtual void edm::stream::EDFilterBase::beginRun ( edm::Run const &  ,
edm::EventSetup const &   
)
inlineprivatevirtual
virtual void edm::stream::EDFilterBase::beginStream ( StreamID  )
inlineprivatevirtual
virtual void edm::stream::EDFilterBase::doAcquire_ ( Event const &  ,
EventSetup const &  ,
WaitingTaskWithArenaHolder  
)
privatepure virtual
virtual void edm::stream::EDFilterBase::endLuminosityBlock ( edm::LuminosityBlock const &  ,
edm::EventSetup const &   
)
inlineprivatevirtual

Reimplemented in AlCaGammaJetSelector, and HGCalTBCheckGunPostion.

Definition at line 70 of file EDFilterBase.h.

70 {}
virtual void edm::stream::EDFilterBase::endRun ( edm::Run const &  ,
edm::EventSetup const &   
)
inlineprivatevirtual
virtual void edm::stream::EDFilterBase::endStream ( )
inlineprivatevirtual
void EDFilterBase::fillDescriptions ( ConfigurationDescriptions descriptions)
static

Definition at line 66 of file EDFilterBase.cc.

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

66  {
68  desc.setUnknown();
69  descriptions.addDefault(desc);
70 }
virtual bool edm::stream::EDFilterBase::filter ( Event ,
EventSetup const &   
)
privatepure virtual
ModuleDescription const& edm::stream::EDFilterBase::moduleDescription ( ) const
inline

Definition at line 59 of file EDFilterBase.h.

References EDFilterBase(), moduleDescriptionPtr_, and operator=().

Referenced by HLTStreamFilter::moduleLabel(), and TriggerResultsFilterFromDB::pathsFromSetup().

59 { return *moduleDescriptionPtr_; }
ModuleDescription const * moduleDescriptionPtr_
Definition: EDFilterBase.h:84
const EDFilterBase& edm::stream::EDFilterBase::operator= ( const EDFilterBase )
privatedelete

Referenced by moduleDescription().

void EDFilterBase::prevalidate ( ConfigurationDescriptions descriptions)
static

Definition at line 72 of file EDFilterBase.cc.

References edm::edmodule_mightGet_config(), edm::kBaseType(), and AlCaHLTBitMon_QueryRunRegistry::string.

72 { edmodule_mightGet_config(iConfig); }
void edmodule_mightGet_config(ConfigurationDescriptions &iDesc)
virtual void edm::stream::EDFilterBase::registerThinnedAssociations ( ProductRegistry const &  ,
ThinnedAssociationsHelper  
)
inlineprivatevirtual

Definition at line 74 of file EDFilterBase.h.

References doAcquire_().

74 {}
void edm::stream::EDFilterBase::setModuleDescriptionPtr ( ModuleDescription const *  iDesc)
inlineprivate

Definition at line 78 of file EDFilterBase.h.

References moduleDescriptionPtr_.

78 { moduleDescriptionPtr_ = iDesc; }
ModuleDescription const * moduleDescriptionPtr_
Definition: EDFilterBase.h:84

Friends And Related Function Documentation

friend class EDFilterAdaptorBase
friend

Definition at line 45 of file EDFilterBase.h.

friend class ProducingModuleAdaptorBase< EDFilterBase >
friend

Definition at line 46 of file EDFilterBase.h.

Member Data Documentation

std::vector<BranchID> edm::stream::EDFilterBase::gotBranchIDsFromAcquire_
private

Definition at line 82 of file EDFilterBase.h.

ModuleDescription const* edm::stream::EDFilterBase::moduleDescriptionPtr_
private

Definition at line 84 of file EDFilterBase.h.

Referenced by moduleDescription(), and setModuleDescriptionPtr().

std::vector<BranchID> edm::stream::EDFilterBase::previousParentage_
private

Definition at line 81 of file EDFilterBase.h.

ParentageID edm::stream::EDFilterBase::previousParentageId_
private

Definition at line 83 of file EDFilterBase.h.