#include <OutputModule.h>

Inheritance diagram for edm::OutputModule:

Public Types
typedef OutputModule	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
BranchIDLists const *	branchIDLists ()

SerialTaskQueue *	globalLuminosityBlocksQueue ()

SerialTaskQueue *	globalRunsQueue ()

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, ThinnedAssociationsHelper const &)

SharedResourcesAcquirer &	sharedResourcesAcquirer ()

ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const

bool	wantAllEvents () const

	~OutputModule () 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

ESProxyIndex const *	esGetTokenIndices (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::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)

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
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 &)

static bool	wantsGlobalLuminosityBlocks ()

static bool	wantsGlobalRuns ()

static bool	wantsStreamLuminosityBlocks ()

static bool	wantsStreamRuns ()

Protected Member Functions
void	configure (OutputModuleDescription const &desc)

ModuleDescription const &	description () const

void	doBeginJob ()

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

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

void	doEndJob ()

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

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

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

void	doPreallocate (PreallocationConfiguration const &)

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

Trig	getTriggerResults (EDGetTokenT< TriggerResults > const &token, EventForOutput const &e) const

ModuleDescription const &	moduleDescription () const

void	preActionBeforeRunEventAsync (WaitingTask *iTask, ModuleCallingContext const &iModuleCallingContext, Principal const &iPrincipal) 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 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 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 Member Functions
virtual void	beginJob ()

virtual void	beginLuminosityBlock (LuminosityBlockForOutput const &)

virtual void	beginRun (RunForOutput const &)

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

void	doOpenFile (FileBlock const &fb)

void	doRegisterThinnedAssociations (ProductRegistry const &, ThinnedAssociationsHelper &)

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, MergeableRunProductMetadata const )

virtual void	endJob ()

virtual void	endLuminosityBlock (LuminosityBlockForOutput const &)

virtual void	endRun (RunForOutput const &)

bool	hasAccumulator () const

bool	hasAcquire () const

virtual bool	isFileOpen () const

void	keepThisBranch (BranchDescription const &desc, std::map< BranchID, BranchDescription const * > &trueBranchIDToKeptBranchDesc, std::set< BranchID > &keptProductsInEvent)

bool	limitReached () const

bool	needToRunSelection () const

virtual void	openFile (FileBlock const &)

bool	prePrefetchSelection (StreamID id, EventPrincipal const &, ModuleCallingContext const *)

std::vector< ProductResolverIndexAndSkipBit >	productsUsedBySelection () const

virtual void	reallyCloseFile ()

void	registerProductsAndCallbacks (OutputModule const , ProductRegistry const )

virtual void	respondToCloseInputFile (FileBlock const &)

virtual void	respondToOpenInputFile (FileBlock const &)

void	setModuleDescription (ModuleDescription const &md)

virtual void	setProcessesWithSelectedMergeableRunProducts (std::set< std::string > const &)

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

std::string	workerType () const

virtual void	write (EventForOutput const &)=0

virtual void	writeLuminosityBlock (LuminosityBlockForOutput const &)=0

virtual void	writeRun (RunForOutput const &)=0

Private Attributes
edm::propagate_const< std::unique_ptr< BranchIDLists > >	branchIDLists_

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

std::array< bool, NumBranchTypes >	hasNewlyDroppedBranch_

std::map< BranchID, bool >	keepAssociation_

SelectedProductsForBranchType	keptProducts_

SerialTaskQueue	luminosityBlockQueue_

int	maxEvents_

ModuleDescription	moduleDescription_

BranchIDLists const *	origBranchIDLists_

std::string	process_name_

ProductSelector	productSelector_

ProductSelectorRules	productSelectorRules_

std::atomic< int >	remainingEvents_

SharedResourcesAcquirer	resourceAcquirer_

SerialTaskQueue	runQueue_

ParameterSet	selectEvents_

ParameterSetID	selector_config_id_

std::vector< detail::TriggerResultsBasedEventSelector >	selectors_

edm::propagate_const< std::unique_ptr< ThinnedAssociationsHelper > >	thinnedAssociationsHelper_

bool	wantAllEvents_

Friends
template<typename T >
class	maker::ModuleHolderT

template<typename T >
class	OutputModuleCommunicatorT

template<typename T >
class	WorkerT

Detailed Description

Definition at line 54 of file OutputModule.h.

Member Typedef Documentation

typedef OutputModule edm::OutputModule::ModuleType

Definition at line 62 of file OutputModule.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 40 of file OutputModule.cc.

References edm::detail::configureEventSelector(), edm::EDConsumerBase::consumesCollector(), edm::getAllTriggerNames(), edm::ParameterSet::getUntrackedParameterSet(), hasNewlyDroppedBranch_, edm::ParameterSet::id(), edm::SharedResourcesRegistry::instance(), edm::SharedResourcesRegistry::kLegacyModuleResourceName, process_name_, edm::ParameterSet::registerIt(), edm::SharedResourcesRegistry::registerSharedResource(), selectEvents_, 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),
         thinnedAssociationsHelper_(new ThinnedAssociationsHelper) {
     hasNewlyDroppedBranch_.fill(false);
 
     Service<service::TriggerNamesService> tns;
     process_name_ = tns->getProcessName();
 
     selectEvents_ = pset.getUntrackedParameterSet("SelectEvents", ParameterSet());
 
     selectEvents_.registerIt();  // Just in case this PSet is not registered
 
     selector_config_id_ = selectEvents_.id();
     selectors_.resize(1);
     //need to set wantAllEvents_ in constructor
     // we will make the remaining selectors once we know how many streams
     wantAllEvents_ = detail::configureEventSelector(
         selectEvents_, process_name_, getAllTriggerNames(), selectors_[0], consumesCollector());
 
     SharedResourcesRegistry::instance()->registerSharedResource(SharedResourcesRegistry::kLegacyModuleResourceName);
   }

edm::OutputModule::~OutputModule ( )

override

Definition at line 175 of file OutputModule.cc.

175 {}

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

delete

Member Function Documentation

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

static

Definition at line 372 of file OutputModule.cc.

References edm::kBaseType().

372 { return kBaseType; }

edm::kBaseType

static const std::string kBaseType("EDAnalyzer")

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

inlineprivatevirtual

Definition at line 227 of file OutputModule.h.

Referenced by doBeginJob().

227 {}

virtual void edm::OutputModule::beginLuminosityBlock ( LuminosityBlockForOutput const & )

inlineprivatevirtual

Definition at line 232 of file OutputModule.h.

Referenced by doBeginLuminosityBlock().

232 {}

virtual void edm::OutputModule::beginRun ( RunForOutput const & )

inlineprivatevirtual

Definition at line 229 of file OutputModule.h.

Referenced by doBeginRun().

229 {}

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

Definition at line 329 of file OutputModule.cc.

References branchIDLists_, droppedBranchIDToKeptBranchID_, and origBranchIDLists_.

                                                    {
     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 75 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 353 of file OutputModule.cc.

References moduleDescription_.

Referenced by setEventSelectionInfo().

353 { return moduleDescription_; }

edm::OutputModule::moduleDescription_

ModuleDescription moduleDescription_

Definition: OutputModule.h:176

void edm::OutputModule::doBeginJob ( )

protected

Definition at line 190 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,
		EventSetupImpl const &	c,
		ModuleCallingContext const *	mcc
	)

protected

Definition at line 288 of file OutputModule.cc.

References beginLuminosityBlock(), FDEBUG, moduleDescription_, and edm::OccurrenceForOutput::setConsumer().

                                                                              {
     FDEBUG(2) << "beginLuminosityBlock called\n";
     LuminosityBlockForOutput lb(lbp, moduleDescription_, mcc, false);
     lb.setConsumer(this);
     beginLuminosityBlock(lb);
     return true;
   }

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

protected

Definition at line 263 of file OutputModule.cc.

References beginRun(), FDEBUG, moduleDescription_, alignCSCRings::r, and edm::OccurrenceForOutput::setConsumer().

                                                                                                               {
     FDEBUG(2) << "beginRun called\n";
     RunForOutput r(rp, moduleDescription_, mcc, false);
     r.setConsumer(this);
     beginRun(r);
     return true;
   }

void edm::OutputModule::doCloseFile ( )

private

Tell the OutputModule that is must end the current file.

Definition at line 321 of file OutputModule.cc.

References isFileOpen(), and reallyCloseFile().

                                  {
     if (isFileOpen()) {
       reallyCloseFile();
     }
   }

void edm::OutputModule::doEndJob ( )

protected

Definition at line 197 of file OutputModule.cc.

References endJob().

197 { endJob(); }

edm::OutputModule::endJob

virtual void endJob()

Definition: OutputModule.h:228

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

protected

Definition at line 298 of file OutputModule.cc.

References endLuminosityBlock(), FDEBUG, moduleDescription_, and edm::OccurrenceForOutput::setConsumer().

                                                                            {
     FDEBUG(2) << "endLuminosityBlock called\n";
     LuminosityBlockForOutput lb(lbp, moduleDescription_, mcc, true);
     lb.setConsumer(this);
     endLuminosityBlock(lb);
     return true;
   }

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

protected

Definition at line 271 of file OutputModule.cc.

References endRun(), FDEBUG, moduleDescription_, alignCSCRings::r, and edm::OccurrenceForOutput::setConsumer().

                                                                                                             {
     FDEBUG(2) << "endRun called\n";
     RunForOutput r(rp, moduleDescription_, mcc, true);
     r.setConsumer(this);
     endRun(r);
     return true;
   }

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

protected

Definition at line 229 of file OutputModule.cc.

References MillePedeFileConverter_cfg::e, FDEBUG, moduleDescription_, remainingEvents_, edm::OccurrenceForOutput::setConsumer(), and write().

                                                               {
     FDEBUG(2) << "writeEvent called\n";
 
     {
       EventForOutput e(ep, moduleDescription_, mcc);
       e.setConsumer(this);
       EventSignalsSentry sentry(act, mcc);
       write(e);
     }
     if (remainingEvents_ > 0) {
       --remainingEvents_;
     }
     return true;
   }

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

private

Definition at line 315 of file OutputModule.cc.

References openFile().

315 { openFile(fb); }

benchmark_cfg.fb

fb

Definition: benchmark_cfg.py:14

edm::OutputModule::openFile

virtual void openFile(FileBlock const &)

Definition: OutputModule.h:235

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

protected

Definition at line 177 of file OutputModule.cc.

References edm::detail::configureEventSelector(), edm::EDConsumerBase::consumesCollector(), edm::getAllTriggerNames(), edm::PreallocationConfiguration::numberOfStreams(), process_name_, alignCSCRings::s, selectEvents_, and selectors_.

                                                                         {
     auto nstreams = iPC.numberOfStreams();
     selectors_.resize(nstreams);
 
     bool seenFirst = false;
     for (auto& s : selectors_) {
       if (seenFirst) {
         detail::configureEventSelector(selectEvents_, process_name_, getAllTriggerNames(), s, consumesCollector());
       }
       seenFirst = true;
     }
   }

void edm::OutputModule::doRegisterThinnedAssociations	(	ProductRegistry const &	,
		ThinnedAssociationsHelper &
	)

inlineprivate

Definition at line 206 of file OutputModule.h.

206 {}

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

private

Definition at line 319 of file OutputModule.cc.

References respondToCloseInputFile().

319 { respondToCloseInputFile(fb); }

benchmark_cfg.fb

fb

Definition: benchmark_cfg.py:14

edm::OutputModule::respondToCloseInputFile

virtual void respondToCloseInputFile(FileBlock const &)

Definition: OutputModule.h:237

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

private

Definition at line 317 of file OutputModule.cc.

References respondToOpenInputFile().

317 { respondToOpenInputFile(fb); }

benchmark_cfg.fb

fb

Definition: benchmark_cfg.py:14

edm::OutputModule::respondToOpenInputFile

virtual void respondToOpenInputFile(FileBlock const &)

Definition: OutputModule.h:236

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

private

Definition at line 308 of file OutputModule.cc.

References FDEBUG, moduleDescription_, edm::OccurrenceForOutput::setConsumer(), and writeLuminosityBlock().

                                                                                                                 {
     FDEBUG(2) << "writeLuminosityBlock called\n";
     LuminosityBlockForOutput lb(lbp, moduleDescription_, mcc, true);
     lb.setConsumer(this);
     writeLuminosityBlock(lb);
   }

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

private

Definition at line 279 of file OutputModule.cc.

References FDEBUG, moduleDescription_, alignCSCRings::r, edm::OccurrenceForOutput::setConsumer(), and writeRun().

                                                                          {
     FDEBUG(2) << "writeRun called\n";
     RunForOutput r(rp, moduleDescription_, mcc, true, mrpm);
     r.setConsumer(this);
     writeRun(r);
   }

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

inlineprotected

Definition at line 147 of file OutputModule.h.

                                                                                           {
       return droppedBranchIDToKeptBranchID_;
     }

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

inlineprivatevirtual

Definition at line 228 of file OutputModule.h.

Referenced by doEndJob().

228 {}

virtual void edm::OutputModule::endLuminosityBlock ( LuminosityBlockForOutput const & )

inlineprivatevirtual

Definition at line 233 of file OutputModule.h.

Referenced by doEndLuminosityBlock().

233 {}

virtual void edm::OutputModule::endRun ( RunForOutput const & )

inlineprivatevirtual

Definition at line 230 of file OutputModule.h.

Referenced by doEndRun().

230 {}

void edm::OutputModule::fillDescription	(	ParameterSetDescription &	desc,
		std::vector< std::string > const &	iDefaultOutputCommands = `ProductSelectorRules::defaultSelectionStrings()`
	)

static

Definition at line 363 of file OutputModule.cc.

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

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

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

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

static

Definition at line 357 of file OutputModule.cc.

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

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

Trig edm::OutputModule::getTriggerResults	(	EDGetTokenT< TriggerResults > const &	token,
		EventForOutput const &	e
	)		const

protected

Definition at line 199 of file OutputModule.cc.

References edm::OccurrenceForOutput::getByToken(), and mps_fire::result.

                                                                                                               {
     //This cast is safe since we only call const functions of the EventForOutputafter this point
     Trig result;
     e.getByToken<TriggerResults>(token, result);
     return result;
   }

SerialTaskQueue* edm::OutputModule::globalLuminosityBlocksQueue ( )

inline

Definition at line 98 of file OutputModule.h.

98 { return &luminosityBlockQueue_; }

edm::OutputModule::luminosityBlockQueue_

SerialTaskQueue luminosityBlockQueue_

Definition: OutputModule.h:196

SerialTaskQueue* edm::OutputModule::globalRunsQueue ( )

inline

Definition at line 97 of file OutputModule.h.

97 { return &runQueue_; }

edm::OutputModule::runQueue_

SerialTaskQueue runQueue_

Definition: OutputModule.h:195

bool edm::OutputModule::hasAccumulator ( ) const

inlineprivate

Definition at line 242 of file OutputModule.h.

242 { return false; }

bool edm::OutputModule::hasAcquire ( ) const

inlineprivate

Definition at line 241 of file OutputModule.h.

241 { return false; }

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

inline

Definition at line 83 of file OutputModule.h.

References edm::ProductSelectorRules::defaultSelectionStrings(), fillDescriptions(), and AlCaHLTBitMon_QueryRunRegistry::string.

83 { return hasNewlyDroppedBranch_; }

edm::OutputModule::hasNewlyDroppedBranch_

std::array< bool, NumBranchTypes > hasNewlyDroppedBranch_

Definition: OutputModule.h:171

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

inlineprivatevirtual

Definition at line 244 of file OutputModule.h.

Referenced by doCloseFile().

244 { return true; }

void edm::OutputModule::keepThisBranch	(	BranchDescription const &	desc,
		std::map< BranchID, BranchDescription const * > &	trueBranchIDToKeptBranchDesc,
		std::set< BranchID > &	keptProductsInEvent
	)

private

Definition at line 133 of file OutputModule.cc.

Referenced by selectProducts().

                                                                            {
     ProductSelector::checkForDuplicateKeptBranch(desc, trueBranchIDToKeptBranchDesc);
 
     EDGetToken token;
 
     std::vector<std::string> missingDictionaries;
     if (!checkDictionary(missingDictionaries, desc.className(), desc.unwrappedType())) {
       std::string context("Calling OutputModule::keepThisBranch, checking dictionaries for kept types");
       throwMissingDictionariesException(missingDictionaries, context);
     }
 
     switch (desc.branchType()) {
       case InEvent: {
         if (desc.produced()) {
           keptProductsInEvent.insert(desc.originalBranchID());
         } else {
           keptProductsInEvent.insert(desc.branchID());
         }
         token = consumes(TypeToGet{desc.unwrappedTypeID(), PRODUCT_TYPE},
                          InputTag{desc.moduleLabel(), desc.productInstanceName(), desc.processName()});
         break;
       }
       case InLumi: {
         token = consumes<InLumi>(TypeToGet{desc.unwrappedTypeID(), PRODUCT_TYPE},
                                  InputTag(desc.moduleLabel(), desc.productInstanceName(), desc.processName()));
         break;
       }
       case InRun: {
         token = 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(std::make_pair(&desc, token));
   }

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

inline

Definition at line 82 of file OutputModule.h.

Referenced by edm::GetProductCheckerOutputModule::write(), edm::ProvenanceCheckerOutputModule::write(), edm::GetProductCheckerOutputModule::writeLuminosityBlock(), and edm::GetProductCheckerOutputModule::writeRun().

82 { return keptProducts_; }

edm::OutputModule::keptProducts_

SelectedProductsForBranchType keptProducts_

Definition: OutputModule.h:170

bool edm::OutputModule::limitReached ( ) const

inlineprivate

Definition at line 252 of file OutputModule.h.

252 { return remainingEvents_ == 0; }

edm::OutputModule::remainingEvents_

std::atomic< int > remainingEvents_

Definition: OutputModule.h:153

int edm::OutputModule::maxEvents ( ) const

inline

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

Definition at line 72 of file OutputModule.h.

72 { return maxEvents_; }

edm::OutputModule::maxEvents_

int maxEvents_

Definition: OutputModule.h:152

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

inlineprotected

Definition at line 115 of file OutputModule.h.

115 { return moduleDescription_; }

edm::OutputModule::moduleDescription_

ModuleDescription moduleDescription_

Definition: OutputModule.h:176

bool edm::OutputModule::needToRunSelection ( ) const

private

Definition at line 206 of file OutputModule.cc.

References wantAllEvents_.

206 { return !wantAllEvents_; }

edm::OutputModule::wantAllEvents_

bool wantAllEvents_

Definition: OutputModule.h:178

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

inlineprivatevirtual

Definition at line 235 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().

235 {}

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

delete

void edm::OutputModule::preActionBeforeRunEventAsync	(	WaitingTask *	iTask,
		ModuleCallingContext const &	iModuleCallingContext,
		Principal const &	iPrincipal
	)		const

inlineprotected

Definition at line 128 of file OutputModule.h.

References genParticles_cff::map, and AlCaHLTBitMon_QueryRunRegistry::string.

130 {}

bool edm::OutputModule::prePrefetchSelection	(	StreamID	id,
		EventPrincipal const &	ep,
		ModuleCallingContext const *	mcc
	)

private

Definition at line 220 of file OutputModule.cc.

References MillePedeFileConverter_cfg::e, moduleDescription_, alignCSCRings::s, selectors_, edm::OccurrenceForOutput::setConsumer(), and wantAllEvents_.

                                                                                                                 {
     if (wantAllEvents_)
       return true;
     auto& s = selectors_[id.value()];
     EventForOutput e(ep, moduleDescription_, mcc);
     e.setConsumer(this);
     return s.wantEvent(e);
   }

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

static

Definition at line 369 of file OutputModule.cc.

References edm::kBaseType(), and AlCaHLTBitMon_QueryRunRegistry::string.

369 {}

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

inline

Definition at line 81 of file OutputModule.h.

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

81 { return process_name_; }

edm::OutputModule::process_name_

std::string process_name_

Definition: OutputModule.h:173

std::vector< ProductResolverIndexAndSkipBit > edm::OutputModule::productsUsedBySelection ( ) const

private

Definition at line 208 of file OutputModule.cc.

References mps_fire::i, gen::n, alignCSCRings::s, selectors_, and edm::EDConsumerBase::uncheckedIndexFrom().

                                                                                         {
     std::vector<ProductResolverIndexAndSkipBit> returnValue;
     auto const& s = selectors_[0];
     auto const n = s.numberOfTokens();
     returnValue.reserve(n);
 
     for (unsigned int i = 0; i < n; ++i) {
       returnValue.emplace_back(uncheckedIndexFrom(s.token(i)));
     }
     return returnValue;
   }

void edm::OutputModule::reallyCloseFile ( )

privatevirtual

Definition at line 327 of file OutputModule.cc.

Referenced by doCloseFile().

327 {}

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

inlineprivate

Definition at line 217 of file OutputModule.h.

217 {}

int edm::OutputModule::remainingEvents ( ) const

inline

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

Definition at line 76 of file OutputModule.h.

76 { return remainingEvents_; }

edm::OutputModule::remainingEvents_

std::atomic< int > remainingEvents_

Definition: OutputModule.h:153

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

inlineprivatevirtual

Definition at line 237 of file OutputModule.h.

Referenced by doRespondToCloseInputFile().

237 {}

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

inlineprivatevirtual

Definition at line 236 of file OutputModule.h.

Referenced by doRespondToOpenInputFile().

236 {}

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

Definition at line 355 of file OutputModule.cc.

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

Referenced by selectProducts().

355 { return productSelector_.selected(desc); }

edm::ProductSelector::selected

bool selected(BranchDescription const &desc) const

Definition: ProductSelector.cc:55

edm::OutputModule::productSelector_

ProductSelector productSelector_

Definition: OutputModule.h:175

ParameterSetID edm::OutputModule::selectorConfig ( ) const

inlineprotected

Definition at line 117 of file OutputModule.h.

References EnergyCorrector::c.

Referenced by edm::PoolOutputModule::whyNotFastClonable().

117 { return selector_config_id_; }

edm::OutputModule::selector_config_id_

ParameterSetID selector_config_id_

Definition: OutputModule.h:183

void edm::OutputModule::selectProducts	(	ProductRegistry const &	preg,
		ThinnedAssociationsHelper const &	thinnedAssociationsHelper
	)

Definition at line 80 of file OutputModule.cc.

References edm::ProductRegistry::allBranchDescriptions(), TrackValidation_cff::association, edm::BranchDescription::branchType(), droppedBranchIDToKeptBranchID_, edm::ProductSelector::fillDroppedToKept(), hasNewlyDroppedBranch_, edm::ProductSelector::initialize(), edm::ProductSelector::initialized(), edm::insertSelectedProcesses(), keepAssociation_, keepThisBranch(), edm::BranchDescription::present(), edm::BranchDescription::produced(), edm::ProductRegistry::productList(), productSelector_, productSelectorRules_, edm::ThinnedAssociationsHelper::selectAssociationProducts(), selected(), setProcessesWithSelectedMergeableRunProducts(), thinnedAssociationsHelper_, edm::BranchDescription::transient(), and edm::BranchDescription::unwrappedType().

                                                                                                 {
     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;
     std::vector<BranchDescription const*> associationDescriptions;
     std::set<BranchID> keptProductsInEvent;
     std::set<std::string> processesWithSelectedMergeableRunProducts;
 
     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 (desc.unwrappedType() == typeid(ThinnedAssociation)) {
         associationDescriptions.push_back(&desc);
       } else if (selected(desc)) {
         keepThisBranch(desc, trueBranchIDToKeptBranchDesc, keptProductsInEvent);
         insertSelectedProcesses(desc, processesWithSelectedMergeableRunProducts);
       } else {
         // otherwise, output nothing,
         // and mark the fact that there is a newly dropped branch of this type.
         hasNewlyDroppedBranch_[desc.branchType()] = true;
       }
     }
 
     setProcessesWithSelectedMergeableRunProducts(processesWithSelectedMergeableRunProducts);
 
     thinnedAssociationsHelper.selectAssociationProducts(associationDescriptions, keptProductsInEvent, keepAssociation_);
 
     for (auto association : associationDescriptions) {
       if (keepAssociation_[association->branchID()]) {
         keepThisBranch(*association, trueBranchIDToKeptBranchDesc, keptProductsInEvent);
       } else {
         hasNewlyDroppedBranch_[association->branchType()] = true;
       }
     }
 
     // Now fill in a mapping needed in the case that a branch was dropped while its EDAlias was kept.
     ProductSelector::fillDroppedToKept(preg, trueBranchIDToKeptBranchDesc, droppedBranchIDToKeptBranchID_);
 
     thinnedAssociationsHelper_->updateFromParentProcess(
         thinnedAssociationsHelper, keepAssociation_, droppedBranchIDToKeptBranchID_);
   }

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

protected

Definition at line 374 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 250 of file OutputModule.h.

250 { moduleDescription_ = md; }

edm::OutputModule::moduleDescription_

ModuleDescription moduleDescription_

Definition: OutputModule.h:176

virtual void edm::OutputModule::setProcessesWithSelectedMergeableRunProducts ( std::set< std::string > const & )

inlineprivatevirtual

Definition at line 239 of file OutputModule.h.

Referenced by selectProducts().

239 {}

SharedResourcesAcquirer& edm::OutputModule::sharedResourcesAcquirer ( )

inline

Definition at line 99 of file OutputModule.h.

99 { return resourceAcquirer_; }

edm::OutputModule::resourceAcquirer_

SharedResourcesAcquirer resourceAcquirer_

Definition: OutputModule.h:194

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

inlineprivatevirtual

Ask the OutputModule if we should end the current file.

Definition at line 224 of file OutputModule.h.

References TriggerAnalyzer::write().

224 { return false; }

ThinnedAssociationsHelper const * edm::OutputModule::thinnedAssociationsHelper ( ) const

Definition at line 349 of file OutputModule.cc.

References thinnedAssociationsHelper_.

                                                                                  {
     return thinnedAssociationsHelper_.get();
   }

bool edm::OutputModule::wantAllEvents ( ) const

inline

Definition at line 101 of file OutputModule.h.

References heppy_report::description, MillePedeFileConverter_cfg::e, and dqmoffline::l1t::getTriggerResults().

101 { return wantAllEvents_; }

edm::OutputModule::wantAllEvents_

bool wantAllEvents_

Definition: OutputModule.h:178

static bool edm::OutputModule::wantsGlobalLuminosityBlocks ( )

inlinestatic

Definition at line 93 of file OutputModule.h.

93 { return true; }

static bool edm::OutputModule::wantsGlobalRuns ( )

inlinestatic

Definition at line 92 of file OutputModule.h.

92 { return true; }

static bool edm::OutputModule::wantsStreamLuminosityBlocks ( )

inlinestatic

Definition at line 95 of file OutputModule.h.

95 { return false; };

static bool edm::OutputModule::wantsStreamRuns ( )

inlinestatic

Definition at line 94 of file OutputModule.h.

94 { return false; }

std::string edm::OutputModule::workerType ( ) const

inlineprivate

Definition at line 208 of file OutputModule.h.

208 { return "WorkerT<OutputModule>"; }

virtual void edm::OutputModule::write ( EventForOutput const & )

privatepure virtual

Implemented in edm::GetProductCheckerOutputModule, and edm::ProvenanceCheckerOutputModule.

Referenced by doEvent(), and pkg.AbstractPkg::generate().

virtual void edm::OutputModule::writeLuminosityBlock ( LuminosityBlockForOutput const & )

privatepure virtual

Implemented in edm::GetProductCheckerOutputModule, and edm::ProvenanceCheckerOutputModule.

Referenced by doWriteLuminosityBlock().

virtual void edm::OutputModule::writeRun ( RunForOutput const & )

privatepure virtual

Implemented in edm::GetProductCheckerOutputModule, and edm::ProvenanceCheckerOutputModule.

Referenced by doWriteRun().

Friends And Related Function Documentation

template<typename T >

friend class maker::ModuleHolderT

friend

Definition at line 57 of file OutputModule.h.

template<typename T >

friend class OutputModuleCommunicatorT

friend

Definition at line 61 of file OutputModule.h.

template<typename T >

friend class WorkerT

friend

Definition at line 59 of file OutputModule.h.

Member Data Documentation

edm::propagate_const<std::unique_ptr<BranchIDLists> > edm::OutputModule::branchIDLists_

private

Definition at line 188 of file OutputModule.h.

Referenced by branchIDLists().

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

private

Definition at line 187 of file OutputModule.h.

Referenced by branchIDLists(), and selectProducts().

std::array<bool, NumBranchTypes> edm::OutputModule::hasNewlyDroppedBranch_

private

Definition at line 171 of file OutputModule.h.

Referenced by OutputModule(), and selectProducts().

std::map<BranchID, bool> edm::OutputModule::keepAssociation_

private

Definition at line 192 of file OutputModule.h.

Referenced by selectProducts().

SelectedProductsForBranchType edm::OutputModule::keptProducts_

private

Definition at line 170 of file OutputModule.h.

Referenced by keepThisBranch().

SerialTaskQueue edm::OutputModule::luminosityBlockQueue_

private

Definition at line 196 of file OutputModule.h.

int edm::OutputModule::maxEvents_

private

Definition at line 152 of file OutputModule.h.

Referenced by configure().

ModuleDescription edm::OutputModule::moduleDescription_

private

Definition at line 176 of file OutputModule.h.

Referenced by description(), doBeginLuminosityBlock(), doBeginRun(), doEndLuminosityBlock(), doEndRun(), doEvent(), doWriteLuminosityBlock(), doWriteRun(), and prePrefetchSelection().

BranchIDLists const* edm::OutputModule::origBranchIDLists_

private

Definition at line 189 of file OutputModule.h.

Referenced by branchIDLists(), and configure().

std::string edm::OutputModule::process_name_

private

Definition at line 173 of file OutputModule.h.

Referenced by doPreallocate(), and OutputModule().

ProductSelector edm::OutputModule::productSelector_

private

Definition at line 175 of file OutputModule.h.

Referenced by selected(), and selectProducts().

ProductSelectorRules edm::OutputModule::productSelectorRules_

private

Definition at line 174 of file OutputModule.h.

Referenced by selectProducts().

std::atomic<int> edm::OutputModule::remainingEvents_

private

Definition at line 153 of file OutputModule.h.

Referenced by configure(), and doEvent().

SharedResourcesAcquirer edm::OutputModule::resourceAcquirer_

private

Definition at line 194 of file OutputModule.h.

Referenced by doBeginJob().

SerialTaskQueue edm::OutputModule::runQueue_

private

Definition at line 195 of file OutputModule.h.

ParameterSet edm::OutputModule::selectEvents_

private

Definition at line 182 of file OutputModule.h.

Referenced by doPreallocate(), and OutputModule().

ParameterSetID edm::OutputModule::selector_config_id_

private

Definition at line 183 of file OutputModule.h.

Referenced by OutputModule(), and setEventSelectionInfo().

std::vector<detail::TriggerResultsBasedEventSelector> edm::OutputModule::selectors_

private

Definition at line 179 of file OutputModule.h.

Referenced by doPreallocate(), OutputModule(), prePrefetchSelection(), and productsUsedBySelection().

edm::propagate_const<std::unique_ptr<ThinnedAssociationsHelper> > edm::OutputModule::thinnedAssociationsHelper_

private

Definition at line 191 of file OutputModule.h.

Referenced by selectProducts(), and thinnedAssociationsHelper().

bool edm::OutputModule::wantAllEvents_

private

Definition at line 178 of file OutputModule.h.

Referenced by needToRunSelection(), OutputModule(), and prePrefetchSelection().

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation