test
CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
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::one::OutputModuleBase edm::EDConsumerBase

Public Member Functions

 StreamerOutputModule (ParameterSet const &ps)
 
virtual ~StreamerOutputModule ()
 
- Public Member Functions inherited from edm::StreamerOutputModuleBase
 StreamerOutputModuleBase (ParameterSet const &ps)
 
virtual ~StreamerOutputModuleBase ()
 
- Public Member Functions inherited from edm::one::OutputModule< one::WatchRuns, one::WatchLuminosityBlocks >
 OutputModule (edm::ParameterSet const &iPSet)
 
- Public Member Functions inherited from edm::one::OutputModuleBase
BranchIDLists const * branchIDLists ()
 
std::array< bool,
NumBranchTypes > const & 
hasNewlyDroppedBranch () const
 
SelectedProductsForBranchType
const & 
keptProducts () const
 
int maxEvents () const
 
const ModuleDescriptionmoduleDescription () const
 
OutputModuleBaseoperator= (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 &)
 
ThinnedAssociationsHelper const * thinnedAssociationsHelper () const
 
bool wantAllEvents () const
 
virtual ~OutputModuleBase ()
 
- Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfoconsumesInfo () const
 
 EDConsumerBase ()
 
ProductHolderIndexAndSkipBit indexFrom (EDGetToken, BranchType, TypeID const &) const
 
void itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
 
void itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
 
std::vector
< ProductHolderIndexAndSkipBit >
const & 
itemsToGetFromEvent () const
 
void labelsForToken (EDGetToken iToken, Labels &oLabels) const
 
void modulesDependentUpon (std::string const &iProcessName, std::string const &iModuleLabel, bool iPrint, std::vector< char const * > &oModuleLabels) const
 
void modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
 
bool registeredToConsume (ProductHolderIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
void updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
 
virtual ~EDConsumerBase ()
 

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

virtual void beginLuminosityBlock (edm::LuminosityBlockPrincipal const &, edm::ModuleCallingContext const *) override
 
virtual void doOutputEvent (EventMsgBuilder const &msg) override
 
virtual void doOutputHeader (InitMsgBuilder const &init_message) override
 
virtual void endLuminosityBlock (edm::LuminosityBlockPrincipal const &, edm::ModuleCallingContext const *) override
 
virtual void start () override
 
virtual 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 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.

38  :
41  c_(new Consumer(ps))
42  {
43  }
OutputModuleBase(ParameterSet const &pset)
StreamerOutputModuleBase(ParameterSet const &ps)
edm::propagate_const< std::unique_ptr< Consumer > > c_
template<typename Consumer >
edm::StreamerOutputModule< Consumer >::~StreamerOutputModule ( )
virtual

Definition at line 46 of file StreamerOutputModule.h.

46 {}

Member Function Documentation

template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::beginLuminosityBlock ( edm::LuminosityBlockPrincipal const &  ,
edm::ModuleCallingContext const *   
)
overrideprivatevirtual

Definition at line 75 of file StreamerOutputModule.h.

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

Implements edm::StreamerOutputModuleBase.

Definition at line 69 of file StreamerOutputModule.h.

69  {
70  c_->doOutputEvent(msg); // You can't use msg in StreamerOutputModule after this point
71  }
edm::propagate_const< std::unique_ptr< Consumer > > c_
template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::doOutputHeader ( InitMsgBuilder const &  init_message)
overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 62 of file StreamerOutputModule.h.

62  {
63  c_->doOutputHeader(init_message);
64  }
edm::propagate_const< std::unique_ptr< Consumer > > c_
template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::endLuminosityBlock ( edm::LuminosityBlockPrincipal const &  ,
edm::ModuleCallingContext const *   
)
overrideprivatevirtual

Definition at line 79 of file StreamerOutputModule.h.

79 {}
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().

83  {
86  Consumer::fillDescription(desc);
87  descriptions.add("streamerOutput", desc);
88  }
static void fillDescription(ParameterSetDescription &desc)
template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::start ( void  )
overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 50 of file StreamerOutputModule.h.

Referenced by progressbar.ProgressBar::__next__().

50  {
51  c_->start();
52  }
edm::propagate_const< std::unique_ptr< Consumer > > c_
template<typename Consumer >
void edm::StreamerOutputModule< Consumer >::stop ( )
overrideprivatevirtual

Implements edm::StreamerOutputModuleBase.

Definition at line 56 of file StreamerOutputModule.h.

56  {
57  c_->stop();
58  }
edm::propagate_const< std::unique_ptr< Consumer > > c_

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.