CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
edm::StreamerOutputModule< Consumer > Class Template Reference

#include <StreamerOutputModule.h>

Inheritance diagram for edm::StreamerOutputModule< Consumer >:
edm::StreamerOutputModuleBase edm::one::OutputModule< one::WatchRuns, one::WatchLuminosityBlocks > edm::StreamerOutputModuleCommon edm::one::OutputModuleBase edm::core::OutputModuleCore edm::EDConsumerBase

Public Member Functions

 StreamerOutputModule (ParameterSet const &ps)
 
 ~StreamerOutputModule () override
 
- Public Member Functions inherited from edm::StreamerOutputModuleBase
 StreamerOutputModuleBase (ParameterSet const &ps)
 
 ~StreamerOutputModuleBase () override
 
- Public Member Functions inherited from edm::one::OutputModule< one::WatchRuns, one::WatchLuminosityBlocks >
SerialTaskQueueglobalLuminosityBlocksQueue () final
 
SerialTaskQueueglobalRunsQueue () final
 
const OutputModuleoperator= (const OutputModule &)=delete
 
 OutputModule (edm::ParameterSet const &iPSet)
 
 OutputModule (const OutputModule &)=delete
 
bool wantsGlobalLuminosityBlocks () const final
 
bool wantsGlobalRuns () const final
 
bool wantsInputProcessBlocks () const final
 
bool wantsProcessBlocks () const final
 
- Public Member Functions inherited from edm::one::OutputModuleBase
OutputModuleBaseoperator= (OutputModuleBase const &)=delete
 
 OutputModuleBase (ParameterSet const &pset)
 
 OutputModuleBase (OutputModuleBase const &)=delete
 
SharedResourcesAcquirersharedResourcesAcquirer ()
 
SubProcessParentageHelper const * subProcessParentageHelper () const
 
bool wantsStreamLuminosityBlocks () const
 
bool wantsStreamRuns () const
 
- Public Member Functions inherited from edm::core::OutputModuleCore
BranchIDLists const * branchIDLists () const
 
std::array< bool, NumBranchTypes > const & hasNewlyDroppedBranch () const
 
SelectedProductsForBranchType const & keptProducts () const
 
int maxEvents () const
 
const ModuleDescriptionmoduleDescription () const
 
OutputModuleCoreoperator= (OutputModuleCore const &)=delete
 
 OutputModuleCore (ParameterSet const &pset)
 
 OutputModuleCore (OutputModuleCore const &)=delete
 
OutputProcessBlockHelper const & outputProcessBlockHelper () const
 
std::string const & processName () const
 
int remainingEvents () const
 
bool selected (BranchDescription const &desc) const
 
void selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &, ProcessBlockHelperBase const &)
 
ThinnedAssociationsHelper const * thinnedAssociationsHelper () const
 
bool wantAllEvents () const
 
 ~OutputModuleCore () 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)
 

Static Public Member Functions

static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
- Static Public Member Functions inherited from edm::StreamerOutputModuleBase
static void fillDescription (ParameterSetDescription &desc)
 
- Static Public Member Functions inherited from edm::core::OutputModuleCore
static const std::string & baseType ()
 
static void fillDescription (ParameterSetDescription &desc, std::vector< std::string > const &iDefaultOutputCommands=ProductSelectorRules::defaultSelectionStrings())
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &)
 

Private Member Functions

void beginLuminosityBlock (edm::LuminosityBlockForOutput const &) override
 
void doOutputEvent (EventMsgBuilder const &msg) override
 
void doOutputHeader (InitMsgBuilder const &init_message) override
 
void endLuminosityBlock (edm::LuminosityBlockForOutput const &) override
 
void start () override
 
void stop () override
 

Private Attributes

edm::propagate_const< std::unique_ptr< Consumer > > c_
 

Additional Inherited Members

- Public Types inherited from edm::one::OutputModuleBase
typedef OutputModuleBase ModuleType
 
- Public Types inherited from edm::core::OutputModuleCore
typedef OutputModuleCore ModuleType
 
- Public Types inherited from edm::EDConsumerBase
typedef ProductLabels Labels
 
- Protected Member Functions inherited from edm::one::OutputModuleBase
void configure (OutputModuleDescription const &desc)
 
void doBeginJob ()
 
bool doEvent (EventTransitionInfo const &, ActivityRegistry *, ModuleCallingContext const *)
 
void doPreallocate (PreallocationConfiguration const &)
 
- Protected Member Functions inherited from edm::core::OutputModuleCore
void configure (OutputModuleDescription const &desc)
 
ModuleDescription const & description () const
 
void doAccessInputProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)
 
void doBeginJob_ ()
 
bool doBeginLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)
 
void doBeginProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)
 
bool doBeginRun (RunTransitionInfo const &, ModuleCallingContext const *)
 
void doEndJob ()
 
bool doEndLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)
 
void doEndProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)
 
bool doEndRun (RunTransitionInfo const &, ModuleCallingContext const *)
 
bool doEvent_ (EventTransitionInfo const &, ActivityRegistry *, ModuleCallingContext const *)
 
void doPreallocate_ (PreallocationConfiguration const &)
 
std::map< BranchID::value_type, BranchID::value_type > const & droppedBranchIDToKeptBranchID ()
 
virtual void preallocLumis (unsigned int)
 
ParameterSetID selectorConfig () const
 
void setEventSelectionInfo (std::map< std::string, std::vector< std::pair< std::string, int >>> const &outputModulePathPositions, bool anyProductProduced)
 
- 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)
 
- Protected Attributes inherited from edm::core::OutputModuleCore
std::atomic< int > remainingEvents_
 

Detailed Description

template<typename Consumer>
class edm::StreamerOutputModule< Consumer >

Definition at line 10 of file StreamerOutputModule.h.

Constructor & Destructor Documentation

◆ StreamerOutputModule()

template<typename Consumer >
edm::StreamerOutputModule< Consumer >::StreamerOutputModule ( ParameterSet const &  ps)
explicit

Consumers are suppose to provide void doOutputHeader(InitMsgBuilder const& init_message) void doOutputEvent(EventMsgBuilder const& msg) void start() void stop() static void fillDescription(ParameterSetDescription&)

Definition at line 37 of file StreamerOutputModule.h.

OutputModuleBase(ParameterSet const &pset)
StreamerOutputModuleBase(ParameterSet const &ps)
edm::propagate_const< std::unique_ptr< Consumer > > c_

◆ ~StreamerOutputModule()

template<typename Consumer >
edm::StreamerOutputModule< Consumer >::~StreamerOutputModule ( )
override

Definition at line 41 of file StreamerOutputModule.h.

41 {}

Member Function Documentation

◆ beginLuminosityBlock()

template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::beginLuminosityBlock ( edm::LuminosityBlockForOutput const &  )
overrideprivate

Definition at line 65 of file StreamerOutputModule.h.

65 {}

◆ doOutputEvent()

template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::doOutputEvent ( EventMsgBuilder const &  msg)
overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 60 of file StreamerOutputModule.h.

References mps_check::msg.

60  {
61  c_->doOutputEvent(msg); // You can't use msg in StreamerOutputModule after this point
62  }
tuple msg
Definition: mps_check.py:285
edm::propagate_const< std::unique_ptr< Consumer > > c_

◆ doOutputHeader()

template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::doOutputHeader ( InitMsgBuilder const &  init_message)
overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 54 of file StreamerOutputModule.h.

54  {
55  c_->doOutputHeader(init_message);
56  }
edm::propagate_const< std::unique_ptr< Consumer > > c_

◆ endLuminosityBlock()

template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::endLuminosityBlock ( edm::LuminosityBlockForOutput const &  )
overrideprivate

Definition at line 68 of file StreamerOutputModule.h.

68 {}

◆ fillDescriptions()

template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::fillDescriptions ( ConfigurationDescriptions descriptions)
static

Definition at line 71 of file StreamerOutputModule.h.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, and edm::StreamerOutputModuleBase::fillDescription().

71  {
74  Consumer::fillDescription(desc);
75  descriptions.add("streamerOutput", desc);
76  }
static void fillDescription(ParameterSetDescription &desc)

◆ start()

template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::start ( )
overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 44 of file StreamerOutputModule.h.

Referenced by progressbar.ProgressBar::__next__().

44  {
45  c_->start();
46  }
edm::propagate_const< std::unique_ptr< Consumer > > c_

◆ stop()

template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::stop ( )
overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 49 of file StreamerOutputModule.h.

49  {
50  c_->stop();
51  }
edm::propagate_const< std::unique_ptr< Consumer > > c_

Member Data Documentation

◆ c_

template<typename Consumer >
edm::propagate_const<std::unique_ptr<Consumer> > edm::StreamerOutputModule< Consumer >::c_
private

Definition at line 33 of file StreamerOutputModule.h.