CMS 3D CMS Logo

List of all members | Public Member Functions | Private Attributes
edm::one::EDProducer< T > Class Template Reference

#include "FWCore/Framework/interface/one/EDProducer.h"

Inheritance diagram for edm::one::EDProducer< T >:
edm::one::EDProducerBase edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper

Public Member Functions

 EDProducer ()=default
 
 EDProducer (const EDProducer &)=delete
 
SerialTaskQueueglobalLuminosityBlocksQueue () final
 
SerialTaskQueueglobalRunsQueue () final
 
bool hasAbilityToProduceInBeginLumis () const final
 
bool hasAbilityToProduceInBeginProcessBlocks () const final
 
bool hasAbilityToProduceInBeginRuns () const final
 
bool hasAbilityToProduceInEndLumis () const final
 
bool hasAbilityToProduceInEndProcessBlocks () const final
 
bool hasAbilityToProduceInEndRuns () const final
 
const EDProduceroperator= (const EDProducer &)=delete
 
bool wantsGlobalLuminosityBlocks () const final
 
bool wantsGlobalRuns () const final
 
bool wantsInputProcessBlocks () const final
 
bool wantsProcessBlocks () const final
 
- Public Member Functions inherited from edm::one::EDProducerBase
 EDProducerBase ()
 
ModuleDescription const & moduleDescription () const
 
bool wantsStreamLuminosityBlocks () const
 
bool wantsStreamRuns () 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
 
std::vector< bool > const & recordProvenanceList () 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)
 
TypeLabelList const & typeLabelList () const
 used by the fwk to register the list of products of this module More...
 
 ~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
 
std::vector< ESProxyIndex > const & esGetTokenIndicesVector (edm::Transition iTrans) const
 
std::vector< ESRecordIndex > const & esGetTokenRecordIndicesVector (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::array< std::vector< ModuleDescription const *> *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, 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
 
void selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)
 
ProductResolverIndexAndSkipBit uncheckedIndexFrom (EDGetToken) const
 
void updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
 
void updateLookup (eventsetup::ESRecordsToProxyIndices const &)
 
virtual ~EDConsumerBase () noexcept(false)
 

Private Attributes

impl::OptionalSerialTaskQueueHolder< WantsSerialGlobalLuminosityBlockTransitions< T... >::value > globalLuminosityBlocksQueue_
 
impl::OptionalSerialTaskQueueHolder< WantsSerialGlobalRunTransitions< T... >::value > globalRunsQueue_
 

Additional Inherited Members

- Public Types inherited from edm::one::EDProducerBase
typedef EDProducerBase ModuleType
 
- Public Types inherited from edm::ProducerBase
template<typename T >
using BranchAliasSetterT = ProductRegistryHelper::BranchAliasSetterT< T >
 
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
 
- Static Public Member Functions inherited from edm::one::EDProducerBase
static const std::string & baseType ()
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &descriptions)
 
- Protected Member Functions inherited from edm::ProducerBase
template<Transition Tr = Transition::Event>
auto produces (std::string instanceName) noexcept
 declare what type of product will make and with which optional label More...
 
template<Transition B>
BranchAliasSetter produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
 
template<BranchType B>
BranchAliasSetter produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
 
BranchAliasSetter produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
 
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<class ProductType >
BranchAliasSetterT< ProductType > produces ()
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces ()
 
template<class ProductType >
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType > produces ()
 
template<Transition Tr = Transition::Event>
auto produces () noexcept
 
ProducesCollector producesCollector ()
 
- Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< Bconsumes (edm::InputTag tag) noexcept
 
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<Transition Tr = Transition::Event>
constexpr auto esConsumes ()
 
template<Transition Tr = Transition::Event>
auto esConsumes (ESInputTag tag)
 
template<Transition Tr = Transition::Event>
ESGetTokenGeneric esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
 Used with EventSetupRecord::doGet. More...
 
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)
 
void resetItemsToGetFrom (BranchType iType)
 

Detailed Description

template<typename... T>
class edm::one::EDProducer< T >

Description: [one line class summary]

Usage: <usage>

Definition at line 30 of file EDProducer.h.

Constructor & Destructor Documentation

◆ EDProducer() [1/2]

template<typename... T>
edm::one::EDProducer< T >::EDProducer ( )
default

◆ EDProducer() [2/2]

template<typename... T>
edm::one::EDProducer< T >::EDProducer ( const EDProducer< T > &  )
delete

Member Function Documentation

◆ globalLuminosityBlocksQueue()

template<typename... T>
SerialTaskQueue* edm::one::EDProducer< T >::globalLuminosityBlocksQueue ( )
inlinefinalvirtual

Reimplemented from edm::one::EDProducerBase.

Definition at line 68 of file EDProducer.h.

68 { return globalLuminosityBlocksQueue_.queue(); }
impl::OptionalSerialTaskQueueHolder< WantsSerialGlobalLuminosityBlockTransitions< T... >::value > globalLuminosityBlocksQueue_
Definition: EDProducer.h:78

◆ globalRunsQueue()

template<typename... T>
SerialTaskQueue* edm::one::EDProducer< T >::globalRunsQueue ( )
inlinefinalvirtual

Reimplemented from edm::one::EDProducerBase.

Definition at line 67 of file EDProducer.h.

67 { return globalRunsQueue_.queue(); }
impl::OptionalSerialTaskQueueHolder< WantsSerialGlobalRunTransitions< T... >::value > globalRunsQueue_
Definition: EDProducer.h:76

◆ hasAbilityToProduceInBeginLumis()

template<typename... T>
bool edm::one::EDProducer< T >::hasAbilityToProduceInBeginLumis ( ) const
inlinefinalvirtual

Reimplemented from edm::ProductRegistryHelper.

Definition at line 64 of file EDProducer.h.

64 { return HasAbilityToProduceInBeginLumis<T...>::value; }
long double T

◆ hasAbilityToProduceInBeginProcessBlocks()

template<typename... T>
bool edm::one::EDProducer< T >::hasAbilityToProduceInBeginProcessBlocks ( ) const
inlinefinalvirtual

Reimplemented from edm::ProductRegistryHelper.

Definition at line 54 of file EDProducer.h.

54  {
55  return HasAbilityToProduceInBeginProcessBlocks<T...>::value;
56  }
long double T

◆ hasAbilityToProduceInBeginRuns()

template<typename... T>
bool edm::one::EDProducer< T >::hasAbilityToProduceInBeginRuns ( ) const
inlinefinalvirtual

Reimplemented from edm::ProductRegistryHelper.

Definition at line 61 of file EDProducer.h.

61 { return HasAbilityToProduceInBeginRuns<T...>::value; }
long double T

◆ hasAbilityToProduceInEndLumis()

template<typename... T>
bool edm::one::EDProducer< T >::hasAbilityToProduceInEndLumis ( ) const
inlinefinalvirtual

Reimplemented from edm::ProductRegistryHelper.

Definition at line 65 of file EDProducer.h.

65 { return HasAbilityToProduceInEndLumis<T...>::value; }
long double T

◆ hasAbilityToProduceInEndProcessBlocks()

template<typename... T>
bool edm::one::EDProducer< T >::hasAbilityToProduceInEndProcessBlocks ( ) const
inlinefinalvirtual

Reimplemented from edm::ProductRegistryHelper.

Definition at line 57 of file EDProducer.h.

57  {
58  return HasAbilityToProduceInEndProcessBlocks<T...>::value;
59  }
long double T

◆ hasAbilityToProduceInEndRuns()

template<typename... T>
bool edm::one::EDProducer< T >::hasAbilityToProduceInEndRuns ( ) const
inlinefinalvirtual

Reimplemented from edm::ProductRegistryHelper.

Definition at line 62 of file EDProducer.h.

62 { return HasAbilityToProduceInEndRuns<T...>::value; }
long double T

◆ operator=()

template<typename... T>
const EDProducer& edm::one::EDProducer< T >::operator= ( const EDProducer< T > &  )
delete

◆ wantsGlobalLuminosityBlocks()

template<typename... T>
bool edm::one::EDProducer< T >::wantsGlobalLuminosityBlocks ( ) const
inlinefinalvirtual

Implements edm::one::EDProducerBase.

Definition at line 52 of file EDProducer.h.

52 { return WantsGlobalLuminosityBlockTransitions<T...>::value; }
long double T

◆ wantsGlobalRuns()

template<typename... T>
bool edm::one::EDProducer< T >::wantsGlobalRuns ( ) const
inlinefinalvirtual

Implements edm::one::EDProducerBase.

Definition at line 51 of file EDProducer.h.

51 { return WantsGlobalRunTransitions<T...>::value; }
long double T

◆ wantsInputProcessBlocks()

template<typename... T>
bool edm::one::EDProducer< T >::wantsInputProcessBlocks ( ) const
inlinefinalvirtual

Implements edm::one::EDProducerBase.

Definition at line 50 of file EDProducer.h.

50 { return WantsInputProcessBlockTransitions<T...>::value; }
long double T

◆ wantsProcessBlocks()

template<typename... T>
bool edm::one::EDProducer< T >::wantsProcessBlocks ( ) const
inlinefinalvirtual

Implements edm::one::EDProducerBase.

Definition at line 49 of file EDProducer.h.

49 { return WantsProcessBlockTransitions<T...>::value; }
long double T

Member Data Documentation

◆ globalLuminosityBlocksQueue_

template<typename... T>
impl::OptionalSerialTaskQueueHolder<WantsSerialGlobalLuminosityBlockTransitions<T...>::value> edm::one::EDProducer< T >::globalLuminosityBlocksQueue_
private

◆ globalRunsQueue_

template<typename... T>
impl::OptionalSerialTaskQueueHolder<WantsSerialGlobalRunTransitions<T...>::value> edm::one::EDProducer< T >::globalRunsQueue_
private