#include <OutputModuleBase.h>

Inheritance diagram for edm::one::OutputModuleBase:

Public Types
typedef OutputModuleBase	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

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

virtual bool	wantsGlobalLuminosityBlocks () const =0

virtual bool	wantsGlobalRuns () const =0

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 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 *)

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)

Private Member Functions
virtual void	beginJob ()

virtual SharedResourcesAcquirer	createAcquirer ()

virtual void	doBeginLuminosityBlock_ (LuminosityBlockForOutput const &)

virtual void	doBeginRun_ (RunForOutput const &)

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

virtual void	doEndLuminosityBlock_ (LuminosityBlockForOutput const &)

virtual void	doEndRun_ (RunForOutput const &)

void	doOpenFile (FileBlock const &fb)

void	doRegisterThinnedAssociations (ProductRegistry const &, ThinnedAssociationsHelper &)

void	doRespondToCloseInputFile (FileBlock const &fb)

virtual void	doRespondToCloseInputFile_ (FileBlock const &)

void	doRespondToOpenInputFile (FileBlock const &fb)

virtual void	doRespondToOpenInputFile_ (FileBlock const &)

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

void	doWriteRun (RunPrincipal const &rp, ModuleCallingContext const , MergeableRunProductMetadata const )

virtual void	endJob ()

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 &)

virtual void	preActionBeforeRunEventAsync (WaitingTask *iTask, ModuleCallingContext const &iModuleCallingContext, Principal const &iPrincipal) const

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

std::vector< ProductResolverIndexAndSkipBit >	productsUsedBySelection () const

virtual void	reallyCloseFile ()

void	registerProductsAndCallbacks (OutputModuleBase const , ProductRegistry 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	resourcesAcquirer_

SerialTaskQueue	runQueue_

ParameterSet	selectEvents_

ParameterSetID	selector_config_id_

std::vector< detail::TriggerResultsBasedEventSelector >	selectors_

SubProcessParentageHelper const *	subProcessParentageHelper_

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

bool	wantAllEvents_

Friends
template<typename T >
class	::edm::OutputModuleCommunicatorT

template<typename T >
class	::edm::WorkerT

template<typename U >
class	edm::maker::ModuleHolderT

Detailed Description

Definition at line 66 of file OutputModuleBase.h.

Member Typedef Documentation

typedef OutputModuleBase edm::one::OutputModuleBase::ModuleType

Definition at line 71 of file OutputModuleBase.h.

Constructor & Destructor Documentation

OutputModuleBase::OutputModuleBase ( ParameterSet const & pset )

explicit

Definition at line 45 of file OutputModuleBase.cc.

References edm::detail::configureEventSelector(), edm::EDConsumerBase::consumesCollector(), edm::getAllTriggerNames(), edm::ParameterSet::getUntrackedParameterSet(), hasNewlyDroppedBranch_, edm::ParameterSet::id(), process_name_, edm::ParameterSet::registerIt(), 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();
       
       //need to set wantAllEvents_ in constructor
       // we will make the remaining selectors once we know how many streams
       selectors_.resize(1);
       wantAllEvents_ = detail::configureEventSelector(selectEvents_,
                                                       process_name_,
                                                       getAllTriggerNames(),
                                                       selectors_[0],
                                                       consumesCollector());
 
     }

OutputModuleBase::~OutputModuleBase ( )

override

Definition at line 198 of file OutputModuleBase.cc.

198 { }

edm::one::OutputModuleBase::OutputModuleBase ( OutputModuleBase const & )

delete

Member Function Documentation

const std::string & OutputModuleBase::baseType ( )

static

Definition at line 408 of file OutputModuleBase.cc.

References edm::one::kBaseType().

                                {
       return kBaseType;
     }

virtual void edm::one::OutputModuleBase::beginJob ( void )

inlineprivatevirtual

Reimplemented in DQMRootOutputModule, edm::PoolOutputModule, evf::RecoEventOutputModuleForFU< Consumer >, and edm::StreamerOutputModuleBase.

Definition at line 241 of file OutputModuleBase.h.

Referenced by doBeginJob().

241 {}

BranchIDLists const * OutputModuleBase::branchIDLists ( )

Definition at line 354 of file OutputModuleBase.cc.

References branchIDLists_, droppedBranchIDToKeptBranchID_, 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 OutputModuleBase::configure ( OutputModuleDescription const & desc )

protected

Definition at line 85 of file OutputModuleBase.cc.

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

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

SharedResourcesAcquirer OutputModuleBase::createAcquirer ( )

privatevirtual

Definition at line 200 of file OutputModuleBase.cc.

Referenced by doBeginJob().

                                                              {
       return SharedResourcesAcquirer{
         std::vector<std::shared_ptr<SerialTaskQueue>>(1, std::make_shared<SerialTaskQueue>())};
     }

ModuleDescription const & OutputModuleBase::description ( ) const

protected

Definition at line 379 of file OutputModuleBase.cc.

References moduleDescription_.

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

                                         {
       return moduleDescription_;
     }

void OutputModuleBase::doBeginJob ( )

protected

Definition at line 223 of file OutputModuleBase.cc.

References beginJob(), createAcquirer(), and resourcesAcquirer_.

                                       {
       resourcesAcquirer_ = createAcquirer();
       this->beginJob();
     }

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

protected

Definition at line 305 of file OutputModuleBase.cc.

References doBeginLuminosityBlock_(), moduleDescription_, and edm::OccurrenceForOutput::setConsumer().

                                                                               {
       LuminosityBlockForOutput lb(lbp, moduleDescription_, mcc, false);
       lb.setConsumer(this);
       doBeginLuminosityBlock_(lb);
       return true;
     }

virtual void edm::one::OutputModuleBase::doBeginLuminosityBlock_ ( LuminosityBlockForOutput const & )

inlineprivatevirtual

Reimplemented in edm::one::outputmodule::LuminosityBlockWatcher.

Definition at line 250 of file OutputModuleBase.h.

Referenced by doBeginLuminosityBlock(), and edm::one::outputmodule::LuminosityBlockWatcher::~LuminosityBlockWatcher().

250 {}

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

protected

Definition at line 276 of file OutputModuleBase.cc.

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

                                                                   {
       RunForOutput r(rp, moduleDescription_, mcc, false);
       r.setConsumer(this);
       doBeginRun_(r);
       return true;
     }

virtual void edm::one::OutputModuleBase::doBeginRun_ ( RunForOutput const & )

inlineprivatevirtual

Reimplemented in edm::one::outputmodule::RunWatcher.

Definition at line 248 of file OutputModuleBase.h.

Referenced by doBeginRun().

248 {}

void OutputModuleBase::doCloseFile ( )

private

Tell the OutputModule that is must end the current file.

Definition at line 344 of file OutputModuleBase.cc.

References isFileOpen(), and reallyCloseFile().

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

void OutputModuleBase::doEndJob ( )

protected

Definition at line 228 of file OutputModuleBase.cc.

References endJob().

                                     {
       endJob();
     }

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

protected

Definition at line 315 of file OutputModuleBase.cc.

References doEndLuminosityBlock_(), moduleDescription_, and edm::OccurrenceForOutput::setConsumer().

                                                                             {
       LuminosityBlockForOutput lb(lbp, moduleDescription_, mcc, true);
       lb.setConsumer(this);
       doEndLuminosityBlock_(lb);
 
       return true;
     }

virtual void edm::one::OutputModuleBase::doEndLuminosityBlock_ ( LuminosityBlockForOutput const & )

inlineprivatevirtual

Reimplemented in edm::one::outputmodule::LuminosityBlockWatcher.

Definition at line 251 of file OutputModuleBase.h.

Referenced by doEndLuminosityBlock(), and edm::one::outputmodule::LuminosityBlockWatcher::~LuminosityBlockWatcher().

251 {}

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

protected

Definition at line 286 of file OutputModuleBase.cc.

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

                                                                 {
       RunForOutput r(rp, moduleDescription_, mcc, true);
       r.setConsumer(this);
       doEndRun_(r);
       return true;
     }

virtual void edm::one::OutputModuleBase::doEndRun_ ( RunForOutput const & )

inlineprivatevirtual

Reimplemented in edm::one::outputmodule::RunWatcher.

Definition at line 249 of file OutputModuleBase.h.

Referenced by doEndRun().

249 {}

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

protected

Definition at line 258 of file OutputModuleBase.cc.

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

                                                                {
       
       {
         EventForOutput e(ep, moduleDescription_, mcc);
         e.setConsumer(this);
         EventSignalsSentry sentry(act,mcc);
         write(e);
       }
       if(remainingEvents_ > 0) {
         --remainingEvents_;
       }
       return true;
     }

void OutputModuleBase::doOpenFile ( FileBlock const & fb )

private

Definition at line 332 of file OutputModuleBase.cc.

References openFile().

                                                          {
       openFile(fb);
     }

void OutputModuleBase::doPreallocate ( PreallocationConfiguration const & iPC )

protected

Definition at line 205 of file OutputModuleBase.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());
         } else {
           seenFirst = true;
         }
       }
     }

void edm::one::OutputModuleBase::doRegisterThinnedAssociations	(	ProductRegistry const &	,
		ThinnedAssociationsHelper &
	)

inlineprivate

Definition at line 216 of file OutputModuleBase.h.

217 { }

void OutputModuleBase::doRespondToCloseInputFile ( FileBlock const & fb )

private

Definition at line 340 of file OutputModuleBase.cc.

References doRespondToCloseInputFile_().

                                                                         {
       doRespondToCloseInputFile_(fb);
     }

virtual void edm::one::OutputModuleBase::doRespondToCloseInputFile_ ( FileBlock const & )

inlineprivatevirtual

Reimplemented in edm::one::outputmodule::InputFileWatcher.

Definition at line 253 of file OutputModuleBase.h.

Referenced by doRespondToCloseInputFile(), and edm::one::outputmodule::InputFileWatcher::~InputFileWatcher().

253 {}

void OutputModuleBase::doRespondToOpenInputFile ( FileBlock const & fb )

private

Definition at line 336 of file OutputModuleBase.cc.

References doRespondToOpenInputFile_().

                                                                        {
       doRespondToOpenInputFile_(fb);
     }

virtual void edm::one::OutputModuleBase::doRespondToOpenInputFile_ ( FileBlock const & )

inlineprivatevirtual

Reimplemented in edm::one::outputmodule::InputFileWatcher.

Definition at line 252 of file OutputModuleBase.h.

Referenced by doRespondToOpenInputFile(), and edm::one::outputmodule::InputFileWatcher::~InputFileWatcher().

252 {}

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

private

Definition at line 325 of file OutputModuleBase.cc.

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

                                                                                    {
       LuminosityBlockForOutput lb(lbp, moduleDescription_, mcc, true);
       lb.setConsumer(this);
       writeLuminosityBlock(lb);
     }

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

private

Definition at line 296 of file OutputModuleBase.cc.

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

                                                                           {
       RunForOutput r(rp, moduleDescription_, mcc, true, mrpm);
       r.setConsumer(this);
       writeRun(r);
     }

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

inlineprotected

Definition at line 151 of file OutputModuleBase.h.

                                                                                             {
         return droppedBranchIDToKeptBranchID_;
       }

virtual void edm::one::OutputModuleBase::endJob ( void )

inlineprivatevirtual

Reimplemented in edm::StreamerOutputModuleBase.

Definition at line 242 of file OutputModuleBase.h.

Referenced by doEndJob().

242 {}

void OutputModuleBase::fillDescription ( ParameterSetDescription & desc )

static

Definition at line 396 of file OutputModuleBase.cc.

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

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

void OutputModuleBase::fillDescriptions ( ConfigurationDescriptions & descriptions )

static

Definition at line 389 of file OutputModuleBase.cc.

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

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

SerialTaskQueue* edm::one::OutputModuleBase::globalLuminosityBlocksQueue ( )

inline

Definition at line 106 of file OutputModuleBase.h.

106 { return &luminosityBlockQueue_;}

edm::one::OutputModuleBase::luminosityBlockQueue_

SerialTaskQueue luminosityBlockQueue_

Definition: OutputModuleBase.h:203

SerialTaskQueue* edm::one::OutputModuleBase::globalRunsQueue ( )

inline

Definition at line 105 of file OutputModuleBase.h.

105 { return &runQueue_;}

edm::one::OutputModuleBase::runQueue_

SerialTaskQueue runQueue_

Definition: OutputModuleBase.h:202

bool edm::one::OutputModuleBase::hasAccumulator ( ) const

inlineprivate

Definition at line 258 of file OutputModuleBase.h.

258 { return false; }

bool edm::one::OutputModuleBase::hasAcquire ( ) const

inlineprivate

Definition at line 257 of file OutputModuleBase.h.

257 { return false; }

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

inline

Definition at line 92 of file OutputModuleBase.h.

References fillDescriptions(), and AlCaHLTBitMon_QueryRunRegistry::string.

92 {return hasNewlyDroppedBranch_;}

edm::one::OutputModuleBase::hasNewlyDroppedBranch_

std::array< bool, NumBranchTypes > hasNewlyDroppedBranch_

Definition: OutputModuleBase.h:176

virtual bool edm::one::OutputModuleBase::isFileOpen ( ) const

inlineprivatevirtual

Reimplemented in DQMRootOutputModule, edm::PoolOutputModule, and NanoAODOutputModule.

Definition at line 246 of file OutputModuleBase.h.

Referenced by doCloseFile().

246 { return true; }

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

private

Definition at line 145 of file OutputModuleBase.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 OutputModuleBase::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::one::OutputModuleBase::keptProducts ( ) const

inline

Definition at line 91 of file OutputModuleBase.h.

Referenced by edm::PoolOutputModule::fillSelectedItemList(), and NanoAODOutputModule::openFile().

91 {return keptProducts_;}

edm::one::OutputModuleBase::keptProducts_

SelectedProductsForBranchType keptProducts_

Definition: OutputModuleBase.h:175

bool edm::one::OutputModuleBase::limitReached ( ) const

inlineprivate

Definition at line 268 of file OutputModuleBase.h.

268 {return remainingEvents_ == 0;}

edm::one::OutputModuleBase::remainingEvents_

std::atomic< int > remainingEvents_

Definition: OutputModuleBase.h:158

int edm::one::OutputModuleBase::maxEvents ( ) const

inline

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

Definition at line 81 of file OutputModuleBase.h.

81 {return maxEvents_;}

edm::one::OutputModuleBase::maxEvents_

int maxEvents_

Definition: OutputModuleBase.h:157

const ModuleDescription& edm::one::OutputModuleBase::moduleDescription ( ) const

inline

Definition at line 121 of file OutputModuleBase.h.

References heppy_report::description.

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

                                                          {
         return moduleDescription_;
       }

bool OutputModuleBase::needToRunSelection ( ) const

private

Definition at line 232 of file OutputModuleBase.cc.

References wantAllEvents_.

                                                     {
       return !wantAllEvents_;
     }

virtual void edm::one::OutputModuleBase::openFile ( FileBlock const & )

inlineprivatevirtual

Reimplemented in DQMRootOutputModule, edm::PoolOutputModule, and NanoAODOutputModule.

Definition at line 245 of file OutputModuleBase.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().

245 {}

OutputModuleBase& edm::one::OutputModuleBase::operator= ( OutputModuleBase const & )

delete

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

inlineprivatevirtual

Reimplemented in edm::PoolOutputModule.

Definition at line 239 of file OutputModuleBase.h.

239 {}

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

private

Definition at line 249 of file OutputModuleBase.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 OutputModuleBase::prevalidate ( ConfigurationDescriptions & )

static

Definition at line 402 of file OutputModuleBase.cc.

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

402 {

403 }

std::string const& edm::one::OutputModuleBase::processName ( ) const

inline

Definition at line 90 of file OutputModuleBase.h.

Referenced by edm::StreamerOutputModuleBase::serializeRegistry(), and DQMRootOutputModule::startEndFile().

90 {return process_name_;}

edm::one::OutputModuleBase::process_name_

std::string process_name_

Definition: OutputModuleBase.h:178

std::vector< ProductResolverIndexAndSkipBit > OutputModuleBase::productsUsedBySelection ( ) const

private

Definition at line 237 of file OutputModuleBase.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 OutputModuleBase::reallyCloseFile ( )

privatevirtual

Reimplemented in DQMRootOutputModule, edm::PoolOutputModule, and NanoAODOutputModule.

Definition at line 350 of file OutputModuleBase.cc.

Referenced by doCloseFile().

350 {

351 }

void edm::one::OutputModuleBase::registerProductsAndCallbacks	(	OutputModuleBase const *	,
		ProductRegistry const *
	)

inlineprivate

Definition at line 224 of file OutputModuleBase.h.

224 {}

int edm::one::OutputModuleBase::remainingEvents ( ) const

inline

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

Definition at line 85 of file OutputModuleBase.h.

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

85 {return remainingEvents_;}

edm::one::OutputModuleBase::remainingEvents_

std::atomic< int > remainingEvents_

Definition: OutputModuleBase.h:158

bool OutputModuleBase::selected ( BranchDescription const & desc ) const

Definition at line 384 of file OutputModuleBase.cc.

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

Referenced by selectProducts().

                                                                   {
       return productSelector_.selected(desc);
     }

ParameterSetID edm::one::OutputModuleBase::selectorConfig ( ) const

inlineprotected

Definition at line 128 of file OutputModuleBase.h.

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

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

128 { return selector_config_id_; }

edm::one::OutputModuleBase::selector_config_id_

ParameterSetID selector_config_id_

Definition: OutputModuleBase.h:188

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

Definition at line 91 of file OutputModuleBase.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 OutputModuleBase::setEventSelectionInfo	(	std::map< std::string, std::vector< std::pair< std::string, int > > > const &	outputModulePathPositions,
		bool	anyProductProduced
	)

protected

Definition at line 413 of file OutputModuleBase.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::one::OutputModuleBase::setModuleDescription ( ModuleDescription const & md )

inlineprivate

Definition at line 264 of file OutputModuleBase.h.

                                                              {
         moduleDescription_ = md;
       }

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

inlineprivatevirtual

Reimplemented in edm::PoolOutputModule.

Definition at line 255 of file OutputModuleBase.h.

Referenced by selectProducts().

255 {}

SharedResourcesAcquirer& edm::one::OutputModuleBase::sharedResourcesAcquirer ( )

inline

Definition at line 107 of file OutputModuleBase.h.

                                                          {
         return resourcesAcquirer_;
       }

virtual bool edm::one::OutputModuleBase::shouldWeCloseFile ( ) const

inlineprivatevirtual

Ask the OutputModule if we should end the current file.

Reimplemented in edm::PoolOutputModule, and edm::TimeoutPoolOutputModule.

Definition at line 236 of file OutputModuleBase.h.

References TriggerAnalyzer::write().

236 {return false;}

SubProcessParentageHelper const* edm::one::OutputModuleBase::subProcessParentageHelper ( ) const

inline

Definition at line 117 of file OutputModuleBase.h.

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

                                                                          {
          return subProcessParentageHelper_;
       }

ThinnedAssociationsHelper const * OutputModuleBase::thinnedAssociationsHelper ( ) const

Definition at line 374 of file OutputModuleBase.cc.

References thinnedAssociationsHelper_.

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

                                                       {
       return thinnedAssociationsHelper_.get();
     }

bool edm::one::OutputModuleBase::wantAllEvents ( ) const

inline

Definition at line 111 of file OutputModuleBase.h.

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

111 {return wantAllEvents_;}

edm::one::OutputModuleBase::wantAllEvents_

bool wantAllEvents_

Definition: OutputModuleBase.h:183

virtual bool edm::one::OutputModuleBase::wantsGlobalLuminosityBlocks ( ) const

pure virtual

Implemented in edm::one::OutputModule< T >, edm::one::OutputModule<>, edm::one::OutputModule< edm::one::WatchRuns, edm::one::WatchLuminosityBlocks >, edm::one::OutputModule< WatchInputFiles >, and edm::one::OutputModule< one::WatchRuns, one::WatchLuminosityBlocks >.

virtual bool edm::one::OutputModuleBase::wantsGlobalRuns ( ) const

pure virtual

Implemented in edm::one::OutputModule< T >, edm::one::OutputModule<>, edm::one::OutputModule< edm::one::WatchRuns, edm::one::WatchLuminosityBlocks >, edm::one::OutputModule< WatchInputFiles >, and edm::one::OutputModule< one::WatchRuns, one::WatchLuminosityBlocks >.

bool edm::one::OutputModuleBase::wantsStreamLuminosityBlocks ( ) const

inline

Definition at line 103 of file OutputModuleBase.h.

103 {return false;};

bool edm::one::OutputModuleBase::wantsStreamRuns ( ) const

inline

Definition at line 102 of file OutputModuleBase.h.

102 {return false;}

std::string edm::one::OutputModuleBase::workerType ( ) const

inlineprivate

Definition at line 219 of file OutputModuleBase.h.

219 {return "WorkerT<edm::one::OutputModuleBase>";}

virtual void edm::one::OutputModuleBase::write ( EventForOutput const & )

privatepure virtual

Implemented in DQMRootOutputModule, edm::PoolOutputModule, NanoAODOutputModule, RawEventOutputModuleForBU< Consumer >, edm::TimeoutPoolOutputModule, and edm::StreamerOutputModuleBase.

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

virtual void edm::one::OutputModuleBase::writeLuminosityBlock ( LuminosityBlockForOutput const & )

privatepure virtual

Implemented in DQMRootOutputModule, edm::PoolOutputModule, NanoAODOutputModule, and edm::StreamerOutputModuleBase.

Referenced by doWriteLuminosityBlock().

virtual void edm::one::OutputModuleBase::writeRun ( RunForOutput const & )

privatepure virtual

Implemented in DQMRootOutputModule, edm::PoolOutputModule, NanoAODOutputModule, and edm::StreamerOutputModuleBase.

Referenced by doWriteRun().

Friends And Related Function Documentation

template<typename T >

friend class ::edm::OutputModuleCommunicatorT

friend

Definition at line 70 of file OutputModuleBase.h.

template<typename T >

friend class ::edm::WorkerT

friend

Definition at line 69 of file OutputModuleBase.h.

template<typename U >

friend class edm::maker::ModuleHolderT

friend

Definition at line 68 of file OutputModuleBase.h.

Member Data Documentation

edm::propagate_const<std::unique_ptr<BranchIDLists> > edm::one::OutputModuleBase::branchIDLists_

private

Definition at line 193 of file OutputModuleBase.h.

Referenced by branchIDLists().

std::map<BranchID::value_type, BranchID::value_type> edm::one::OutputModuleBase::droppedBranchIDToKeptBranchID_

private

Definition at line 192 of file OutputModuleBase.h.

Referenced by branchIDLists(), and selectProducts().

std::array<bool, NumBranchTypes> edm::one::OutputModuleBase::hasNewlyDroppedBranch_

private

Definition at line 176 of file OutputModuleBase.h.

Referenced by OutputModuleBase(), and selectProducts().

std::map<BranchID, bool> edm::one::OutputModuleBase::keepAssociation_

private

Definition at line 199 of file OutputModuleBase.h.

Referenced by selectProducts().

SelectedProductsForBranchType edm::one::OutputModuleBase::keptProducts_

private

Definition at line 175 of file OutputModuleBase.h.

Referenced by keepThisBranch().

SerialTaskQueue edm::one::OutputModuleBase::luminosityBlockQueue_

private

Definition at line 203 of file OutputModuleBase.h.

int edm::one::OutputModuleBase::maxEvents_

private

Definition at line 157 of file OutputModuleBase.h.

Referenced by configure().

ModuleDescription edm::one::OutputModuleBase::moduleDescription_

private

Definition at line 181 of file OutputModuleBase.h.

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

BranchIDLists const* edm::one::OutputModuleBase::origBranchIDLists_

private

Definition at line 194 of file OutputModuleBase.h.

Referenced by branchIDLists(), and configure().

std::string edm::one::OutputModuleBase::process_name_

private

Definition at line 178 of file OutputModuleBase.h.

Referenced by doPreallocate(), and OutputModuleBase().

ProductSelector edm::one::OutputModuleBase::productSelector_

private

Definition at line 180 of file OutputModuleBase.h.

Referenced by selected(), and selectProducts().

ProductSelectorRules edm::one::OutputModuleBase::productSelectorRules_

private

Definition at line 179 of file OutputModuleBase.h.

Referenced by selectProducts().

std::atomic<int> edm::one::OutputModuleBase::remainingEvents_

private

Definition at line 158 of file OutputModuleBase.h.

Referenced by configure(), and doEvent().

SharedResourcesAcquirer edm::one::OutputModuleBase::resourcesAcquirer_

private

Definition at line 201 of file OutputModuleBase.h.

Referenced by doBeginJob().

SerialTaskQueue edm::one::OutputModuleBase::runQueue_

private

Definition at line 202 of file OutputModuleBase.h.

ParameterSet edm::one::OutputModuleBase::selectEvents_

private

Definition at line 185 of file OutputModuleBase.h.

Referenced by doPreallocate(), and OutputModuleBase().

ParameterSetID edm::one::OutputModuleBase::selector_config_id_

private

Definition at line 188 of file OutputModuleBase.h.

Referenced by OutputModuleBase(), and setEventSelectionInfo().

std::vector<detail::TriggerResultsBasedEventSelector> edm::one::OutputModuleBase::selectors_

private

Definition at line 184 of file OutputModuleBase.h.

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

SubProcessParentageHelper const* edm::one::OutputModuleBase::subProcessParentageHelper_

private

Definition at line 196 of file OutputModuleBase.h.

Referenced by configure().

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

private

Definition at line 198 of file OutputModuleBase.h.

Referenced by selectProducts(), and thinnedAssociationsHelper().

bool edm::one::OutputModuleBase::wantAllEvents_

private

Definition at line 183 of file OutputModuleBase.h.

Referenced by needToRunSelection(), OutputModuleBase(), 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