edm::StreamerOutputModule< Consumer > Class Template Reference

#include <StreamerOutputModule.h>

Inheritance diagram for edm::StreamerOutputModule< Consumer >:

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 >
	OutputModule (edm::ParameterSet const &iPSet)
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
Public Member Functions inherited from edm::one::OutputModuleBase
BranchIDLists const *	branchIDLists ()
SerialTaskQueue *	globalLuminosityBlocksQueue ()
SerialTaskQueue *	globalRunsQueue ()
std::array< bool, NumBranchTypes > const &	hasNewlyDroppedBranch () const
SelectedProductsForBranchType const &	keptProducts () const
int	maxEvents () const
const ModuleDescription &	moduleDescription () const
OutputModuleBase &	operator= (OutputModuleBase const &)=delete
	OutputModuleBase (ParameterSet const &pset)
	OutputModuleBase (OutputModuleBase const &)=delete
std::string const &	processName () const
int	remainingEvents () const
bool	selected (BranchDescription const &desc) const
void	selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &)
SharedResourcesAcquirer &	sharedResourcesAcquirer ()
SubProcessParentageHelper const *	subProcessParentageHelper () const
ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const
bool	wantAllEvents () const
bool	wantsStreamLuminosityBlocks () const
bool	wantsStreamRuns () const
	~OutputModuleBase () 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::StreamerOutputModuleBase
static void	fillDescription (ParameterSetDescription &desc)
Static Public Member Functions inherited from edm::one::OutputModuleBase
static const std::string &	baseType ()
static void	fillDescription (ParameterSetDescription &desc)
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::EDConsumerBase
typedef ProductLabels	Labels
Protected Member Functions inherited from edm::one::OutputModuleBase
void	configure (OutputModuleDescription const &desc)
ModuleDescription const &	description () const
void	doBeginJob ()
bool	doBeginLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetup const &c, ModuleCallingContext const *)
bool	doBeginRun (RunPrincipal const &rp, EventSetup const &c, ModuleCallingContext const *)
void	doEndJob ()
bool	doEndLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetup const &c, ModuleCallingContext const *)
bool	doEndRun (RunPrincipal const &rp, EventSetup const &c, ModuleCallingContext const *)
bool	doEvent (EventPrincipal const &ep, EventSetup const &c, ActivityRegistry *, ModuleCallingContext const *)
void	doPreallocate (PreallocationConfiguration const &)
std::map< BranchID::value_type, BranchID::value_type > const &	droppedBranchIDToKeptBranchID ()
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)
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 ESProduct , Transition Tr = Transition::Event>
auto	esConsumes (eventsetup::EventSetupRecordKey const &, 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

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

Definition at line 10 of file StreamerOutputModule.h.

Constructor & Destructor Documentation

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 38 of file StreamerOutputModule.h.

                                                                             :
    edm::one::OutputModuleBase::OutputModuleBase(ps),
    StreamerOutputModuleBase(ps),
    c_(new Consumer(ps))
    {
  }

template<typename Consumer >

edm::StreamerOutputModule< Consumer >::~StreamerOutputModule ( )

override

Definition at line 46 of file StreamerOutputModule.h.

{}

Member Function Documentation

template<typename Consumer >

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

overrideprivate

Definition at line 75 of file StreamerOutputModule.h.

{}

template<typename Consumer >

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

overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 69 of file StreamerOutputModule.h.

References edm::StreamerOutputModule< Consumer >::c_.

                                                                          {
    c_->doOutputEvent(msg); // You can't use msg in StreamerOutputModule after this point
  }

template<typename Consumer >

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

overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 62 of file StreamerOutputModule.h.

References edm::StreamerOutputModule< Consumer >::c_.

                                                                                   {
    c_->doOutputHeader(init_message);
  }

template<typename Consumer >

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

overrideprivate

Definition at line 79 of file StreamerOutputModule.h.

{}

template<typename Consumer >

void edm::StreamerOutputModule< Consumer >::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 83 of file StreamerOutputModule.h.

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

                                                                                          {
    ParameterSetDescription desc;
    StreamerOutputModuleBase::fillDescription(desc);
    Consumer::fillDescription(desc);
    descriptions.add("streamerOutput", desc);
  }

template<typename Consumer >

void edm::StreamerOutputModule< Consumer >::start ( )

overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 50 of file StreamerOutputModule.h.

References edm::StreamerOutputModule< Consumer >::c_.

Referenced by progressbar.ProgressBar::__next__().

                                        {
    c_->start();
  }

template<typename Consumer >

void edm::StreamerOutputModule< Consumer >::stop ( )

overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 56 of file StreamerOutputModule.h.

References edm::StreamerOutputModule< Consumer >::c_.

                                       {
    c_->stop();
  }

Member Data Documentation

template<typename Consumer >

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

private

Definition at line 34 of file StreamerOutputModule.h.

Referenced by edm::StreamerOutputModule< Consumer >::doOutputEvent(), edm::StreamerOutputModule< Consumer >::doOutputHeader(), edm::StreamerOutputModule< Consumer >::start(), and edm::StreamerOutputModule< Consumer >::stop().