#include <OutputModule.h>

Inheritance diagram for edm::OutputModule:

Public Types
typedef OutputModule	ModuleType

Public Member Functions
BranchChildren const &	branchChildren () const

BranchIDLists const *	branchIDLists () const

std::array< bool, NumBranchTypes > const &	hasNewlyDroppedBranch () const

SelectedProductsForBranchType const &	keptProducts () const

int	maxEvents () const

OutputModule &	operator= (OutputModule const &)=delete

	OutputModule (ParameterSet const &pset)

	OutputModule (OutputModule const &)=delete

std::string const &	processName () const

int	remainingEvents () const

bool	selected (BranchDescription const &desc) const

void	selectProducts (ProductRegistry const &preg)

bool	wantAllEvents () const

virtual	~OutputModule ()

Public Member Functions inherited from edm::EDConsumerBase
	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 (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) 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 const std::string &	baseType ()

static void	fillDescription (ParameterSetDescription &desc)

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions
void	configure (OutputModuleDescription const &desc)

ModuleDescription const &	description () const

void	doBeginJob ()

bool	doBeginLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetup const &c, ModuleCallingContext const *mcc)

bool	doBeginRun (RunPrincipal const &rp, EventSetup const &c, ModuleCallingContext const *mcc)

void	doEndJob ()

bool	doEndLuminosityBlock (LuminosityBlockPrincipal const &lbp, EventSetup const &c, ModuleCallingContext const *mcc)

bool	doEndRun (RunPrincipal const &rp, EventSetup const &c, ModuleCallingContext const *mcc)

bool	doEvent (EventPrincipal const &ep, EventSetup const &c, ActivityRegistry act, ModuleCallingContext const mcc)

void	doPreallocate (PreallocationConfiguration const &)

std::map< BranchID::value_type, BranchID::value_type > const &	droppedBranchIDToKeptBranchID ()

Trig	getTriggerResults (EventPrincipal const &ep, ModuleCallingContext const *) const

ModuleDescription const &	moduleDescription () const

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)

Private Types
typedef std::map< BranchID, std::set< ParentageID > >	BranchParents

Private Member Functions
virtual void	beginJob ()

virtual void	beginLuminosityBlock (LuminosityBlockPrincipal const &, ModuleCallingContext const *)

virtual void	beginRun (RunPrincipal const &, ModuleCallingContext const *)

void	doCloseFile ()
	Tell the OutputModule that is must end the current file. More...

void	doOpenFile (FileBlock const &fb)

void	doPostForkReacquireResources (unsigned int iChildIndex, unsigned int iNumberOfChildren)

void	doPreForkReleaseResources ()

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doWriteLuminosityBlock (LuminosityBlockPrincipal const &lbp, ModuleCallingContext const *mcc)

void	doWriteRun (RunPrincipal const &rp, ModuleCallingContext const *mcc)

virtual void	endJob ()

virtual void	endLuminosityBlock (LuminosityBlockPrincipal const &, ModuleCallingContext const *)

virtual void	endRun (RunPrincipal const &, ModuleCallingContext const *)

void	fillDependencyGraph ()

virtual bool	isFileOpen () const

bool	limitReached () const

void	maybeOpenFile ()

virtual void	openFile (FileBlock const &)

virtual void	postForkReacquireResources (unsigned int, unsigned int)

virtual void	preForkReleaseResources ()

virtual void	reallyCloseFile ()

virtual void	reallyOpenFile ()

void	registerProductsAndCallbacks (OutputModule const , ProductRegistry const )

virtual void	respondToCloseInputFile (FileBlock const &)

virtual void	respondToOpenInputFile (FileBlock const &)

void	setModuleDescription (ModuleDescription const &md)

virtual bool	shouldWeCloseFile () const
	Ask the OutputModule if we should end the current file. More...

void	updateBranchParents (EventPrincipal const &ep)

std::string	workerType () const

virtual void	write (EventPrincipal const &e, ModuleCallingContext const *)=0

virtual void	writeLuminosityBlock (LuminosityBlockPrincipal const &, ModuleCallingContext const *)=0

virtual void	writeRun (RunPrincipal const &, ModuleCallingContext const *)=0

Private Attributes
BranchChildren	branchChildren_

std::unique_ptr< BranchIDLists >	branchIDLists_

BranchParents	branchParents_

std::map< BranchID::value_type, BranchID::value_type >	droppedBranchIDToKeptBranchID_

std::array< bool, NumBranchTypes >	hasNewlyDroppedBranch_

SelectedProductsForBranchType	keptProducts_

int	maxEvents_

ModuleDescription	moduleDescription_

std::mutex	mutex_

BranchIDLists const *	origBranchIDLists_

std::string	process_name_

ProductSelector	productSelector_

ProductSelectorRules	productSelectorRules_

std::atomic< int >	remainingEvents_

SharedResourcesAcquirer	resourceAcquirer_

ParameterSetID	selector_config_id_

detail::TriggerResultsBasedEventSelector	selectors_

bool	wantAllEvents_

Friends
template<typename T >
class	maker::ModuleHolderT

template<typename T >
class	OutputModuleCommunicatorT

template<typename T >
class	WorkerT

Detailed Description

Definition at line 47 of file OutputModule.h.

Member Typedef Documentation

typedef std::map<BranchID, std::set<ParentageID> > edm::OutputModule::BranchParents

private

Definition at line 165 of file OutputModule.h.

typedef OutputModule edm::OutputModule::ModuleType

Definition at line 52 of file OutputModule.h.

Constructor & Destructor Documentation

edm::OutputModule::OutputModule ( ParameterSet const & pset )

explicit

Definition at line 31 of file OutputModule.cc.

References edm::detail::configureEventSelector(), edm::getAllTriggerNames(), edm::ParameterSet::getUntrackedParameterSet(), hasNewlyDroppedBranch_, edm::ParameterSet::id(), edm::SharedResourcesRegistry::instance(), edm::SharedResourcesRegistry::kLegacyModuleResourceName, process_name_, edm::ParameterSet::registerIt(), edm::SharedResourcesRegistry::registerSharedResource(), selector_config_id_, selectors_, and wantAllEvents_.

                                                      :
     maxEvents_(-1),
     remainingEvents_(maxEvents_),
     keptProducts_(),
     hasNewlyDroppedBranch_(),
     process_name_(),
     productSelectorRules_(pset, "outputCommands", "OutputModule"),
     productSelector_(),
     moduleDescription_(),
     wantAllEvents_(false),
     selectors_(),
     selector_config_id_(),
     droppedBranchIDToKeptBranchID_(),
     branchIDLists_(new BranchIDLists),
     origBranchIDLists_(nullptr),
     branchParents_(),
     branchChildren_() {
 
     hasNewlyDroppedBranch_.fill(false);
 
     Service<service::TriggerNamesService> tns;
     process_name_ = tns->getProcessName();
 
     ParameterSet selectevents =
       pset.getUntrackedParameterSet("SelectEvents", ParameterSet());
 
     selectevents.registerIt(); // Just in case this PSet is not registered
 
     selector_config_id_ = selectevents.id();
     wantAllEvents_ = detail::configureEventSelector(selectevents,
                                                     process_name_,
                                                     getAllTriggerNames(),
                                                     selectors_);
     SharedResourcesRegistry::instance()->registerSharedResource(
                                                                 SharedResourcesRegistry::kLegacyModuleResourceName);
 
   }

edm::OutputModule::~OutputModule ( )

virtual

Definition at line 161 of file OutputModule.cc.

161 { }

edm::OutputModule::OutputModule ( OutputModule const & )

delete

Member Function Documentation

const std::string & edm::OutputModule::baseType ( )

static

Definition at line 364 of file OutputModule.cc.

References edm::kBaseType().

                          {
     return kBaseType;
   }

virtual void edm::OutputModule::beginJob ( void )

inlineprivatevirtual

Reimplemented in edm::StreamerOutputModuleBase.

Definition at line 204 of file OutputModule.h.

Referenced by doBeginJob().

204 {}

virtual void edm::OutputModule::beginLuminosityBlock	(	LuminosityBlockPrincipal const &	,
		ModuleCallingContext const *
	)

inlineprivatevirtual

Reimplemented in RawEventOutputModuleForBU< Consumer >, and evf::RecoEventOutputModuleForFU< Consumer >.

Definition at line 209 of file OutputModule.h.

Referenced by doBeginLuminosityBlock().

209 {}

virtual void edm::OutputModule::beginRun	(	RunPrincipal const &	,
		ModuleCallingContext const *
	)

inlineprivatevirtual

Reimplemented in RawEventOutputModuleForBU< Consumer >, FRDEventOutputModule< Consumer >, and edm::StreamerOutputModuleBase.

Definition at line 206 of file OutputModule.h.

Referenced by doBeginRun().

206 {}

BranchChildren const& edm::OutputModule::branchChildren ( ) const

inline

Definition at line 80 of file OutputModule.h.

References branchChildren_.

80 {return branchChildren_;}

edm::OutputModule::branchChildren_

BranchChildren branchChildren_

Definition: OutputModule.h:168

BranchIDLists const * edm::OutputModule::branchIDLists ( ) const

Definition at line 315 of file OutputModule.cc.

References branchIDLists_, droppedBranchIDToKeptBranchID_, getDQMSummary::iter, and origBranchIDLists_.

Referenced by edm::StreamerOutputModuleBase::serializeRegistry().

                                     {
     if(!droppedBranchIDToKeptBranchID_.empty()) {
       // Make a private copy of the BranchIDLists.
       *branchIDLists_ = *origBranchIDLists_;
       // Check for branches dropped while an EDAlias was kept.
       for(BranchIDList& branchIDList : *branchIDLists_) {
         for(BranchID::value_type& branchID : branchIDList) {
           // Replace BranchID of each dropped branch with that of the kept alias, so the alias branch will have the product ID of the original branch.
           std::map<BranchID::value_type, BranchID::value_type>::const_iterator iter = droppedBranchIDToKeptBranchID_.find(branchID);
           if(iter != droppedBranchIDToKeptBranchID_.end()) {
             branchID = iter->second;
           }
         }
       }
       return branchIDLists_.get();
     }
     return origBranchIDLists_;
   }

void edm::OutputModule::configure ( OutputModuleDescription const & desc )

protected

Definition at line 69 of file OutputModule.cc.

References edm::OutputModuleDescription::branchIDLists_, edm::OutputModuleDescription::maxEvents_, maxEvents_, origBranchIDLists_, and remainingEvents_.

                                                                   {
     remainingEvents_ = maxEvents_ = desc.maxEvents_;
     origBranchIDLists_ = desc.branchIDLists_;
   }

ModuleDescription const & edm::OutputModule::description ( ) const

protected

Definition at line 335 of file OutputModule.cc.

References moduleDescription_.

Referenced by edm::StreamerOutputModuleBase::serializeRegistry(), and setEventSelectionInfo().

                                   {
     return moduleDescription_;
   }

void edm::OutputModule::doBeginJob ( )

protected

Definition at line 163 of file OutputModule.cc.

References beginJob(), edm::SharedResourcesRegistry::createAcquirer(), edm::SharedResourcesRegistry::instance(), edm::SharedResourcesRegistry::kLegacyModuleResourceName, and resourceAcquirer_.

                                 {
     std::vector<std::string> res = {SharedResourcesRegistry::kLegacyModuleResourceName};
     resourceAcquirer_ = SharedResourcesRegistry::instance()->createAcquirer(res);
 
     this->beginJob();
   }

bool edm::OutputModule::doBeginLuminosityBlock	(	LuminosityBlockPrincipal const &	lbp,
		EventSetup const &	c,
		ModuleCallingContext const *	mcc
	)

protected

Definition at line 253 of file OutputModule.cc.

References beginLuminosityBlock(), and FDEBUG.

                                                                         {
     FDEBUG(2) << "beginLuminosityBlock called\n";
     beginLuminosityBlock(lbp, mcc);
     return true;
   }

bool edm::OutputModule::doBeginRun	(	RunPrincipal const &	rp,
		EventSetup const &	c,
		ModuleCallingContext const *	mcc
	)

protected

Definition at line 228 of file OutputModule.cc.

References beginRun(), and FDEBUG.

                                                             {
     FDEBUG(2) << "beginRun called\n";
     beginRun(rp, mcc);
     return true;
   }

void edm::OutputModule::doCloseFile ( )

private

Tell the OutputModule that is must end the current file.

Definition at line 302 of file OutputModule.cc.

References branchChildren_, branchParents_, edm::BranchChildren::clear(), fillDependencyGraph(), isFileOpen(), and reallyCloseFile().

                                  {
     if(isFileOpen()) {
       fillDependencyGraph();
       reallyCloseFile();
       branchParents_.clear();
       branchChildren_.clear();
     }
   }

void edm::OutputModule::doEndJob ( )

protected

Definition at line 170 of file OutputModule.cc.

References endJob().

                               {
     endJob();
   }

bool edm::OutputModule::doEndLuminosityBlock	(	LuminosityBlockPrincipal const &	lbp,
		EventSetup const &	c,
		ModuleCallingContext const *	mcc
	)

protected

Definition at line 262 of file OutputModule.cc.

References endLuminosityBlock(), and FDEBUG.

                                                                       {
     FDEBUG(2) << "endLuminosityBlock called\n";
     endLuminosityBlock(lbp, mcc);
     return true;
   }

bool edm::OutputModule::doEndRun	(	RunPrincipal const &	rp,
		EventSetup const &	c,
		ModuleCallingContext const *	mcc
	)

protected

Definition at line 237 of file OutputModule.cc.

References endRun(), and FDEBUG.

                                                           {
     FDEBUG(2) << "endRun called\n";
     endRun(rp, mcc);
     return true;
   }

bool edm::OutputModule::doEvent	(	EventPrincipal const &	ep,
		EventSetup const &	c,
		ActivityRegistry *	act,
		ModuleCallingContext const *	mcc
	)

protected

Definition at line 182 of file OutputModule.cc.

References FDEBUG, mutex_, remainingEvents_, resourceAcquirer_, selectors_, updateBranchParents(), wantAllEvents_, edm::detail::TriggerResultsBasedEventSelector::wantEvent(), and write().

                                                          {
 
     FDEBUG(2) << "writeEvent called\n";
 
     {
       std::lock_guard<std::mutex> guard(mutex_);
       detail::TRBESSentry products_sentry(selectors_);
       if(!wantAllEvents_) {
         if(!selectors_.wantEvent(ep, mcc)) {
           return true;
         }
       }
       
       {
         std::lock_guard<SharedResourcesAcquirer> guardAcq(resourceAcquirer_);
         EventSignalsSentry signals(act,mcc);
         write(ep, mcc);
       }
       updateBranchParents(ep);
     }
     if(remainingEvents_ > 0) {
       --remainingEvents_;
     }
     return true;
   }

void edm::OutputModule::doOpenFile ( FileBlock const & fb )

private

Definition at line 276 of file OutputModule.cc.

References openFile().

                                                    {
     openFile(fb);
   }

void edm::OutputModule::doPostForkReacquireResources	(	unsigned int	iChildIndex,
		unsigned int	iNumberOfChildren
	)

private

Definition at line 294 of file OutputModule.cc.

References postForkReacquireResources().

                                                                                                      {
     postForkReacquireResources(iChildIndex, iNumberOfChildren);
   }

void edm::OutputModule::doPreallocate ( PreallocationConfiguration const & )

inlineprotected

Definition at line 100 of file OutputModule.h.

100 {}

void edm::OutputModule::doPreForkReleaseResources ( )

private

Definition at line 289 of file OutputModule.cc.

References preForkReleaseResources().

                                           {
     preForkReleaseResources();
   }

void edm::OutputModule::doRespondToCloseInputFile ( FileBlock const & fb )

private

Definition at line 284 of file OutputModule.cc.

References respondToCloseInputFile().

                                                                   {
     respondToCloseInputFile(fb);
   }

void edm::OutputModule::doRespondToOpenInputFile ( FileBlock const & fb )

private

Definition at line 280 of file OutputModule.cc.

References respondToOpenInputFile().

                                                                  {
     respondToOpenInputFile(fb);
   }

void edm::OutputModule::doWriteLuminosityBlock	(	LuminosityBlockPrincipal const &	lbp,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 270 of file OutputModule.cc.

References FDEBUG, and writeLuminosityBlock().

                                                                              {
     FDEBUG(2) << "writeLuminosityBlock called\n";
     writeLuminosityBlock(lbp, mcc);
   }

void edm::OutputModule::doWriteRun	(	RunPrincipal const &	rp,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 246 of file OutputModule.cc.

References FDEBUG, and writeRun().

                                                             {
     FDEBUG(2) << "writeRun called\n";
     writeRun(rp, mcc);
   }

std::map<BranchID::value_type, BranchID::value_type> const& edm::OutputModule::droppedBranchIDToKeptBranchID ( )

inlineprotected

Definition at line 121 of file OutputModule.h.

References droppedBranchIDToKeptBranchID_.

                                                                                           {
       return droppedBranchIDToKeptBranchID_;
     }

virtual void edm::OutputModule::endJob ( void )

inlineprivatevirtual

Reimplemented in edm::StreamerOutputModuleBase.

Definition at line 205 of file OutputModule.h.

Referenced by doEndJob().

205 {}

virtual void edm::OutputModule::endLuminosityBlock	(	LuminosityBlockPrincipal const &	,
		ModuleCallingContext const *
	)

inlineprivatevirtual

Reimplemented in RawEventOutputModuleForBU< Consumer >, and evf::RecoEventOutputModuleForFU< Consumer >.

Definition at line 210 of file OutputModule.h.

Referenced by doEndLuminosityBlock().

210 {}

virtual void edm::OutputModule::endRun	(	RunPrincipal const &	,
		ModuleCallingContext const *
	)

inlineprivatevirtual

Reimplemented in RawEventOutputModuleForBU< Consumer >, FRDEventOutputModule< Consumer >, and edm::StreamerOutputModuleBase.

Definition at line 207 of file OutputModule.h.

Referenced by doEndRun().

207 {}

void edm::OutputModule::fillDependencyGraph ( )

private

Definition at line 393 of file OutputModule.cc.

References branchChildren_, branchParents_, edm::ParentageRegistry::getMapped(), i, edm::BranchChildren::insertChild(), edm::ParentageRegistry::instance(), j, parents, and edm::Parentage::parents().

Referenced by doCloseFile().

                                     {
     for(BranchParents::const_iterator i = branchParents_.begin(), iEnd = branchParents_.end();
         i != iEnd; ++i) {
       BranchID const& child = i->first;
       std::set<ParentageID> const& eIds = i->second;
       for(std::set<ParentageID>::const_iterator it = eIds.begin(), itEnd = eIds.end();
           it != itEnd; ++it) {
         Parentage entryDesc;
         ParentageRegistry::instance()->getMapped(*it, entryDesc);
         std::vector<BranchID> const& parents = entryDesc.parents();
         for(std::vector<BranchID>::const_iterator j = parents.begin(), jEnd = parents.end();
           j != jEnd; ++j) {
           branchChildren_.insertChild(*j, child);
         }
       }
     }
   }

void edm::OutputModule::fillDescription ( ParameterSetDescription & desc )

static

Definition at line 352 of file OutputModule.cc.

References edm::ProductSelectorRules::fillDescription(), and edm::EventSelector::fillDescription().

Referenced by edm::StreamerOutputModuleBase::fillDescription(), edm::AsciiOutputModule::fillDescriptions(), edm::ProvenanceCheckerOutputModule::fillDescriptions(), edm::GetProductCheckerOutputModule::fillDescriptions(), and edm::PoolOutputModule::fillDescriptions().

                                                              {
     ProductSelectorRules::fillDescription(desc, "outputCommands");
     EventSelector::fillDescription(desc);
   }

void edm::OutputModule::fillDescriptions ( ConfigurationDescriptions & descriptions )

static

Definition at line 345 of file OutputModule.cc.

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

                                                                         {
     ParameterSetDescription desc;
     desc.setUnknown();
     descriptions.addDefault(desc);
   }

Trig edm::OutputModule::getTriggerResults	(	EventPrincipal const &	ep,
		ModuleCallingContext const *	mcc
	)		const

protected

Definition at line 175 of file OutputModule.cc.

References edm::detail::TriggerResultsBasedEventSelector::getOneTriggerResults(), and selectors_.

Referenced by edm::StreamerOutputModuleBase::setHltMask().

175 {

176 return selectors_.getOneTriggerResults(ep, mcc); }

edm::OutputModule::selectors_

detail::TriggerResultsBasedEventSelector selectors_

Definition: OutputModule.h:154

edm::detail::TriggerResultsBasedEventSelector::getOneTriggerResults

handle_t getOneTriggerResults(EventPrincipal const &e, ModuleCallingContext const *)

Definition: TriggerResultsBasedEventSelector.cc:193

std::array<bool, NumBranchTypes> const& edm::OutputModule::hasNewlyDroppedBranch ( ) const

inline

Definition at line 73 of file OutputModule.h.

References hasNewlyDroppedBranch_.

73 {return hasNewlyDroppedBranch_;}

edm::OutputModule::hasNewlyDroppedBranch_

std::array< bool, NumBranchTypes > hasNewlyDroppedBranch_

Definition: OutputModule.h:146

virtual bool edm::OutputModule::isFileOpen ( ) const

inlineprivatevirtual

Definition at line 218 of file OutputModule.h.

Referenced by doCloseFile(), and maybeOpenFile().

218 { return true; }

SelectedProductsForBranchType const& edm::OutputModule::keptProducts ( ) const

inline

Definition at line 72 of file OutputModule.h.

References keptProducts_.

72 {return keptProducts_;}

edm::OutputModule::keptProducts_

SelectedProductsForBranchType keptProducts_

Definition: OutputModule.h:145

bool edm::OutputModule::limitReached ( ) const

inlineprivate

Definition at line 229 of file OutputModule.h.

References remainingEvents_.

229 {return remainingEvents_ == 0;}

edm::OutputModule::remainingEvents_

std::atomic< int > remainingEvents_

Definition: OutputModule.h:128

int edm::OutputModule::maxEvents ( ) const

inline

Accessor for maximum number of events to be written. -1 is used for unlimited.

Definition at line 62 of file OutputModule.h.

References maxEvents_.

62 {return maxEvents_;}

edm::OutputModule::maxEvents_

int maxEvents_

Definition: OutputModule.h:127

void edm::OutputModule::maybeOpenFile ( )

private

Tell the OutputModule to open an output file, if one is not already open.

Definition at line 298 of file OutputModule.cc.

References isFileOpen(), and reallyOpenFile().

                                    {
     if(!isFileOpen()) reallyOpenFile();
   }

ModuleDescription const& edm::OutputModule::moduleDescription ( ) const

inlineprotected

Definition at line 95 of file OutputModule.h.

References moduleDescription_.

95 { return moduleDescription_;

96 }

edm::OutputModule::moduleDescription_

ModuleDescription moduleDescription_

Definition: OutputModule.h:151

virtual void edm::OutputModule::openFile ( FileBlock const & )

inlineprivatevirtual

Definition at line 212 of file OutputModule.h.

Referenced by Vispa.Main.Application.Application::_readCommandLineAttributes(), doOpenFile(), Vispa.Main.Application.Application::doubleClickOnFile(), Vispa.Main.Application.Application::openFileDialog(), and Vispa.Main.Application.Application::openRecentFileSlot().

212 {}

OutputModule& edm::OutputModule::operator= ( OutputModule const & )

delete

virtual void edm::OutputModule::postForkReacquireResources	(	unsigned	int,
		unsigned	int
	)

inlineprivatevirtual

Definition at line 216 of file OutputModule.h.

Referenced by doPostForkReacquireResources().

216 {}

virtual void edm::OutputModule::preForkReleaseResources ( )

inlineprivatevirtual

Definition at line 215 of file OutputModule.h.

Referenced by doPreForkReleaseResources().

215 {}

void edm::OutputModule::prevalidate ( ConfigurationDescriptions & )

static

Definition at line 358 of file OutputModule.cc.

358 {

359 }

std::string const& edm::OutputModule::processName ( ) const

inline

Definition at line 71 of file OutputModule.h.

References process_name_.

Referenced by edm::StreamerOutputModuleBase::serializeRegistry().

71 {return process_name_;}

edm::OutputModule::process_name_

std::string process_name_

Definition: OutputModule.h:148

void edm::OutputModule::reallyCloseFile ( )

privatevirtual

Definition at line 311 of file OutputModule.cc.

Referenced by doCloseFile().

311 {

312 }

virtual void edm::OutputModule::reallyOpenFile ( )

inlineprivatevirtual

Definition at line 220 of file OutputModule.h.

Referenced by maybeOpenFile().

220 {}

void edm::OutputModule::registerProductsAndCallbacks	(	OutputModule const *	,
		ProductRegistry const *
	)

inlineprivate

Definition at line 198 of file OutputModule.h.

198 {}

int edm::OutputModule::remainingEvents ( ) const

inline

Accessor for remaining number of events to be written. -1 is used for unlimited.

Definition at line 66 of file OutputModule.h.

References remainingEvents_.

66 {return remainingEvents_;}

edm::OutputModule::remainingEvents_

std::atomic< int > remainingEvents_

Definition: OutputModule.h:128

virtual void edm::OutputModule::respondToCloseInputFile ( FileBlock const & )

inlineprivatevirtual

Definition at line 214 of file OutputModule.h.

Referenced by doRespondToCloseInputFile().

214 {}

virtual void edm::OutputModule::respondToOpenInputFile ( FileBlock const & )

inlineprivatevirtual

Definition at line 213 of file OutputModule.h.

Referenced by doRespondToOpenInputFile().

213 {}

bool edm::OutputModule::selected ( BranchDescription const & desc ) const

Definition at line 340 of file OutputModule.cc.

References productSelector_, and edm::ProductSelector::selected().

Referenced by selectProducts(), and edm::AsciiOutputModule::write().

                                                             {
     return productSelector_.selected(desc);
   }

ParameterSetID edm::OutputModule::selectorConfig ( ) const

inlineprotected

Definition at line 98 of file OutputModule.h.

References selector_config_id_.

Referenced by edm::StreamerOutputModuleBase::serializeEvent().

98 { return selector_config_id_; }

edm::OutputModule::selector_config_id_

ParameterSetID selector_config_id_

Definition: OutputModule.h:157

void edm::OutputModule::selectProducts ( ProductRegistry const & preg )

Definition at line 74 of file OutputModule.cc.

                                                                {
     if(productSelector_.initialized()) return;
     productSelector_.initialize(productSelectorRules_, preg.allBranchDescriptions());
 
     // TODO: See if we can collapse keptProducts_ and productSelector_ into a
     // single object. See the notes in the header for ProductSelector
     // for more information.
 
     std::map<BranchID, BranchDescription const*> trueBranchIDToKeptBranchDesc;
 
     for(auto const& it : preg.productList()) {
       BranchDescription const& desc = it.second;
       if(desc.transient()) {
         // if the class of the branch is marked transient, output nothing
       } else if(!desc.present() && !desc.produced()) {
         // else if the branch containing the product has been previously dropped,
         // output nothing
       } else if(selected(desc)) {
         // else if the branch has been selected, put it in the list of selected branches.
         if(desc.produced()) {
           // First we check if an equivalent branch has already been selected due to an EDAlias.
           // We only need the check for products produced in this process.
           BranchID const& trueBranchID = desc.originalBranchID();
           std::map<BranchID, BranchDescription const*>::const_iterator iter = trueBranchIDToKeptBranchDesc.find(trueBranchID);
           if(iter != trueBranchIDToKeptBranchDesc.end()) {
              throw edm::Exception(errors::Configuration, "Duplicate Output Selection")
                << "Two (or more) equivalent branches have been selected for output.\n"
                << "#1: " << BranchKey(desc) << "\n" 
                << "#2: " << BranchKey(*iter->second) << "\n" 
                << "Please drop at least one of them.\n";
           }
           trueBranchIDToKeptBranchDesc.insert(std::make_pair(trueBranchID, &desc));
         }
         switch (desc.branchType()) {
           case InEvent:
           {
             consumes(TypeToGet{desc.unwrappedTypeID(),PRODUCT_TYPE},
                      InputTag{desc.moduleLabel(),
                               desc.productInstanceName(),
                        desc.processName()});
             break;
           }
           case InLumi:
           {
             consumes<InLumi>(TypeToGet{desc.unwrappedTypeID(),PRODUCT_TYPE},
                              InputTag(desc.moduleLabel(),
                                       desc.productInstanceName(),
                                       desc.processName()));
             break;
           }
           case InRun:
           {
             consumes<InRun>(TypeToGet{desc.unwrappedTypeID(),PRODUCT_TYPE},
                             InputTag(desc.moduleLabel(),
                                      desc.productInstanceName(),
                                      desc.processName()));
             break;
           }
           default:
             assert(false);
             break;
         }
         // Now put it in the list of selected branches.
         keptProducts_[desc.branchType()].push_back(&desc);
       } else {
         // otherwise, output nothing,
         // and mark the fact that there is a newly dropped branch of this type.
         hasNewlyDroppedBranch_[desc.branchType()] = true;
       }
     }
     // Now fill in a mapping needed in the case that a branch was dropped while its EDAlias was kept.
     for(auto const& it : preg.productList()) {
       BranchDescription const& desc = it.second;
       if(!desc.produced() || desc.isAlias()) continue;
       BranchID const& branchID = desc.branchID();
       std::map<BranchID, BranchDescription const*>::const_iterator iter = trueBranchIDToKeptBranchDesc.find(branchID);
       if(iter != trueBranchIDToKeptBranchDesc.end()) {
         // This branch, produced in this process, or an alias of it, was persisted.
         BranchID const& keptBranchID = iter->second->branchID();
         if(keptBranchID != branchID) {
           // An EDAlias branch was persisted.
           droppedBranchIDToKeptBranchID_.insert(std::make_pair(branchID.id(), keptBranchID.id()));
         }
       }
     }
   }

void edm::OutputModule::setEventSelectionInfo	(	std::map< std::string, std::vector< std::pair< std::string, int > > > const &	outputModulePathPositions,
		bool	anyProductProduced
	)

protected

Definition at line 369 of file OutputModule.cc.

References description(), edm::getParameterSet(), edm::detail::registerProperSelectionInfo(), and selector_config_id_.

                                                                {
     selector_config_id_ = detail::registerProperSelectionInfo(getParameterSet(selector_config_id_),
                                       description().moduleLabel(),
                                                       outputModulePathPositions,
                                                       anyProductProduced);
   }

void edm::OutputModule::setModuleDescription ( ModuleDescription const & md )

inlineprivate

Definition at line 222 of file OutputModule.h.

References moduleDescription_.

                                                            {
       moduleDescription_ = md;
     }

virtual bool edm::OutputModule::shouldWeCloseFile ( ) const

inlineprivatevirtual

Ask the OutputModule if we should end the current file.

Definition at line 201 of file OutputModule.h.

201 {return false;}

void edm::OutputModule::updateBranchParents ( EventPrincipal const & ep )

private

Definition at line 378 of file OutputModule.cc.

References edm::Principal::begin(), branchChildren_, branchParents_, edm::Principal::end(), i, and edm::BranchChildren::insertEmpty().

Referenced by doEvent().

                                                             {
     for(EventPrincipal::const_iterator i = ep.begin(), iEnd = ep.end(); i != iEnd; ++i) {
       if((*i) && (*i)->productProvenancePtr() != 0) {
         BranchID const& bid = (*i)->branchDescription().branchID();
         BranchParents::iterator it = branchParents_.find(bid);
         if(it == branchParents_.end()) {
           it = branchParents_.insert(std::make_pair(bid, std::set<ParentageID>())).first;
         }
         it->second.insert((*i)->productProvenancePtr()->parentageID());
         branchChildren_.insertEmpty(bid);
       }
     }
   }