#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 ()

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

ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const

bool	wantAllEvents () const

virtual	~OutputModuleBase ()

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

	EDConsumerBase ()

ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesDependentUpon (std::string const &iProcessName, std::string const &iModuleLabel, bool iPrint, std::vector< char const * > &oModuleLabels) const

void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)

virtual	~EDConsumerBase ()

Static Public Member Functions
static 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_ (LuminosityBlockPrincipal const &, ModuleCallingContext const *)

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

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

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

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

void	doOpenFile (FileBlock const &fb)

void	doPostForkReacquireResources (unsigned int iChildIndex, unsigned int iNumberOfChildren)

void	doPreForkReleaseResources ()

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

virtual void	endJob ()

virtual bool	isFileOpen () const

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

bool	limitReached () const

void	maybeOpenFile ()

virtual void	openFile (FileBlock const &)

virtual void	postForkReacquireResources (unsigned int, unsigned int)

virtual void	preForkReleaseResources ()

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

virtual void	reallyCloseFile ()

virtual void	reallyOpenFile ()

void	registerProductsAndCallbacks (OutputModuleBase const , ProductRegistry const )

void	setModuleDescription (ModuleDescription const &md)

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

std::string	workerType () const

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

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

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

Private Attributes
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_

int	maxEvents_

ModuleDescription	moduleDescription_

std::mutex	mutex_

BranchIDLists const *	origBranchIDLists_

std::string	process_name_

ProductSelector	productSelector_

ProductSelectorRules	productSelectorRules_

std::atomic< int >	remainingEvents_

SharedResourcesAcquirer	resourcesAcquirer_

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	::edm::OutputModuleCommunicatorT

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

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

Detailed Description

Definition at line 63 of file OutputModuleBase.h.

Member Typedef Documentation

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

Definition at line 68 of file OutputModuleBase.h.

Constructor & Destructor Documentation

OutputModuleBase::OutputModuleBase ( ParameterSet const & pset )

explicit

Definition at line 42 of file OutputModuleBase.cc.

References edm::detail::configureEventSelector(), 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]);
 
     }

OutputModuleBase::~OutputModuleBase ( )

virtual

Definition at line 180 of file OutputModuleBase.cc.

180 { }

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

delete

Member Function Documentation

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

static

Definition at line 378 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 222 of file OutputModuleBase.h.

Referenced by doBeginJob().

222 {}

BranchIDLists const * OutputModuleBase::branchIDLists ( )

Definition at line 324 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 81 of file OutputModuleBase.cc.

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

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

SharedResourcesAcquirer OutputModuleBase::createAcquirer ( )

privatevirtual

Definition at line 182 of file OutputModuleBase.cc.

Referenced by doBeginJob().

                                                              {
       return SharedResourcesAcquirer{};
     }

ModuleDescription const & OutputModuleBase::description ( ) const

protected

Definition at line 349 of file OutputModuleBase.cc.

References moduleDescription_.

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

                                         {
       return moduleDescription_;
     }

void OutputModuleBase::doBeginJob ( )

protected

Definition at line 203 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 261 of file OutputModuleBase.cc.

References doBeginLuminosityBlock_().

                                                                               {
       doBeginLuminosityBlock_(lbp, mcc);
       return true;
     }

virtual void edm::one::OutputModuleBase::doBeginLuminosityBlock_	(	LuminosityBlockPrincipal const &	,
		ModuleCallingContext const *
	)

inlineprivatevirtual

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

Definition at line 235 of file OutputModuleBase.h.

Referenced by doBeginLuminosityBlock().

235 {}

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

protected

Definition at line 239 of file OutputModuleBase.cc.

References doBeginRun_().

                                                                   {
       doBeginRun_(rp, mcc);
       return true;
     }

virtual void edm::one::OutputModuleBase::doBeginRun_	(	RunPrincipal const &	,
		ModuleCallingContext const *
	)

inlineprivatevirtual

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

Definition at line 233 of file OutputModuleBase.h.

Referenced by doBeginRun().

233 {}

void OutputModuleBase::doCloseFile ( )

private

Tell the OutputModule that is must end the current file.

Definition at line 314 of file OutputModuleBase.cc.

References isFileOpen(), and reallyCloseFile().

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

void OutputModuleBase::doEndJob ( )

protected

Definition at line 208 of file OutputModuleBase.cc.

References endJob().

                                     {
       endJob();
     }

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

protected

Definition at line 269 of file OutputModuleBase.cc.

References doEndLuminosityBlock_().

                                                                             {
       doEndLuminosityBlock_(lbp, mcc);
       return true;
     }

virtual void edm::one::OutputModuleBase::doEndLuminosityBlock_	(	LuminosityBlockPrincipal const &	,
		ModuleCallingContext const *
	)

inlineprivatevirtual

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

Definition at line 236 of file OutputModuleBase.h.

Referenced by doEndLuminosityBlock().

236 {}

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

protected

Definition at line 247 of file OutputModuleBase.cc.

References doEndRun_().

                                                                 {
       doEndRun_(rp, mcc);
       return true;
     }

virtual void edm::one::OutputModuleBase::doEndRun_	(	RunPrincipal const &	,
		ModuleCallingContext const *
	)

inlineprivatevirtual

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

Definition at line 234 of file OutputModuleBase.h.

Referenced by doEndRun().

234 {}

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

protected

Definition at line 219 of file OutputModuleBase.cc.

References mutex_, remainingEvents_, resourcesAcquirer_, and write().

                                                                {
       
       {
         std::lock_guard<std::mutex> guard(mutex_);
         {
           std::lock_guard<SharedResourcesAcquirer> guard(resourcesAcquirer_);
           EventSignalsSentry sentry(act,mcc);
           write(ep, mcc);
         }
       }
       if(remainingEvents_ > 0) {
         --remainingEvents_;
       }
       return true;
     }

void OutputModuleBase::doOpenFile ( FileBlock const & fb )

private

Definition at line 281 of file OutputModuleBase.cc.

References openFile().

                                                          {
       openFile(fb);
     }

void OutputModuleBase::doPostForkReacquireResources	(	unsigned int	iChildIndex,
		unsigned int	iNumberOfChildren
	)

private

Definition at line 299 of file OutputModuleBase.cc.

References postForkReacquireResources().

                                                                                                            {
       postForkReacquireResources(iChildIndex, iNumberOfChildren);
     }

void OutputModuleBase::doPreallocate ( PreallocationConfiguration const & iPC )

protected

Definition at line 186 of file OutputModuleBase.cc.

References edm::detail::configureEventSelector(), 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);
         } else {
           seenFirst = true;
         }
       }
     }

void OutputModuleBase::doPreForkReleaseResources ( )

private

Definition at line 294 of file OutputModuleBase.cc.

References preForkReleaseResources().

                                                 {
       preForkReleaseResources();
     }

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

inlineprivate

Definition at line 197 of file OutputModuleBase.h.

198 { }

void OutputModuleBase::doRespondToCloseInputFile ( FileBlock const & fb )

private

Definition at line 289 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 238 of file OutputModuleBase.h.

Referenced by doRespondToCloseInputFile().

238 {}

void OutputModuleBase::doRespondToOpenInputFile ( FileBlock const & fb )

private

Definition at line 285 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 237 of file OutputModuleBase.h.

Referenced by doRespondToOpenInputFile().

237 {}

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

private

Definition at line 276 of file OutputModuleBase.cc.

References writeLuminosityBlock().

                                                                                    {
       writeLuminosityBlock(lbp, mcc);
     }

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

private

Definition at line 255 of file OutputModuleBase.cc.

References writeRun().

                                                                   {
       writeRun(rp, mcc);
     }

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

inlineprotected

Definition at line 132 of file OutputModuleBase.h.

References droppedBranchIDToKeptBranchID_.

                                                                                             {
         return droppedBranchIDToKeptBranchID_;
       }

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

inlineprivatevirtual

Reimplemented in edm::StreamerOutputModuleBase.

Definition at line 223 of file OutputModuleBase.h.

Referenced by doEndJob().

223 {}

void OutputModuleBase::fillDescription ( ParameterSetDescription & desc )

static

Definition at line 366 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 359 of file OutputModuleBase.cc.

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

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

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

inline

Definition at line 89 of file OutputModuleBase.h.

References hasNewlyDroppedBranch_.

89 {return hasNewlyDroppedBranch_;}

edm::one::OutputModuleBase::hasNewlyDroppedBranch_

std::array< bool, NumBranchTypes > hasNewlyDroppedBranch_

Definition: OutputModuleBase.h:157

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

inlineprivatevirtual

Reimplemented in DQMRootOutputModule, and edm::PoolOutputModule.

Definition at line 227 of file OutputModuleBase.h.

Referenced by doCloseFile(), and maybeOpenFile().

227 { return true; }

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

private

Definition at line 135 of file OutputModuleBase.cc.

Referenced by selectProducts().

                                                                {
 
       ProductSelector::checkForDuplicateKeptBranch(desc,
                                                    trueBranchIDToKeptBranchDesc);
 
       switch (desc.branchType()) {
       case InEvent:
         {
           if(desc.produced()) {
             keptProductsInEvent.insert(desc.originalBranchID());
           } else {
             keptProductsInEvent.insert(desc.branchID());
           }
           consumes(TypeToGet{desc.unwrappedTypeID(),PRODUCT_TYPE},
                    InputTag{desc.moduleLabel(),
                        desc.productInstanceName(),
                        desc.processName()});
           break;
         }
       case InLumi:
         {
           consumes<InLumi>(TypeToGet{desc.unwrappedTypeID(),PRODUCT_TYPE},
                            InputTag(desc.moduleLabel(),
                                     desc.productInstanceName(),
                                     desc.processName()));
           break;
         }
       case InRun:
         {
           consumes<InRun>(TypeToGet{desc.unwrappedTypeID(),PRODUCT_TYPE},
                           InputTag(desc.moduleLabel(),
                                    desc.productInstanceName(),
                                    desc.processName()));
           break;
         }
       default:
         assert(false);
         break;
       }
       // Now put it in the list of selected branches.
       keptProducts_[desc.branchType()].push_back(&desc);
     }

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

inline

Definition at line 88 of file OutputModuleBase.h.

References keptProducts_.

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

88 {return keptProducts_;}

edm::one::OutputModuleBase::keptProducts_

SelectedProductsForBranchType keptProducts_

Definition: OutputModuleBase.h:156

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

inlineprivate

Definition at line 248 of file OutputModuleBase.h.

References remainingEvents_.

248 {return remainingEvents_ == 0;}

edm::one::OutputModuleBase::remainingEvents_

std::atomic< int > remainingEvents_

Definition: OutputModuleBase.h:139

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

inline

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

Definition at line 78 of file OutputModuleBase.h.

References maxEvents_.

78 {return maxEvents_;}

edm::one::OutputModuleBase::maxEvents_

int maxEvents_

Definition: OutputModuleBase.h:138

void OutputModuleBase::maybeOpenFile ( )

private

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

Definition at line 310 of file OutputModuleBase.cc.

References isFileOpen(), and reallyOpenFile().

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

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

inline

Definition at line 102 of file OutputModuleBase.h.

References moduleDescription_.

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

                                                          {
         return moduleDescription_;
       }

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

inlineprivatevirtual

Reimplemented in DQMRootOutputModule, and edm::PoolOutputModule.

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

226 {}

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

delete

void OutputModuleBase::postForkReacquireResources	(	unsigned int	,
		unsigned int
	)

privatevirtual

Reimplemented in DQMRootOutputModule, and edm::PoolOutputModule.

Definition at line 307 of file OutputModuleBase.cc.

Referenced by doPostForkReacquireResources().

307 {}

void OutputModuleBase::preForkReleaseResources ( )

privatevirtual

Definition at line 304 of file OutputModuleBase.cc.

Referenced by doPreForkReleaseResources().

304 {}

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

private

Definition at line 212 of file OutputModuleBase.cc.

References or, alignCSCRings::s, selectors_, and wantAllEvents_.

                                                                                                                       {
       
       auto& s = selectors_[id.value()];
       return wantAllEvents_ or s.wantEvent(ep,mcc);
     }

void OutputModuleBase::prevalidate ( ConfigurationDescriptions & )

static

Definition at line 372 of file OutputModuleBase.cc.

372 {

373 }

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

inline

Definition at line 87 of file OutputModuleBase.h.

References process_name_.

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

87 {return process_name_;}

edm::one::OutputModuleBase::process_name_

std::string process_name_

Definition: OutputModuleBase.h:159

void OutputModuleBase::reallyCloseFile ( )

privatevirtual

Reimplemented in DQMRootOutputModule, and edm::PoolOutputModule.

Definition at line 320 of file OutputModuleBase.cc.

Referenced by doCloseFile().

320 {

321 }

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

inlineprivatevirtual

Reimplemented in edm::PoolOutputModule.

Definition at line 228 of file OutputModuleBase.h.

Referenced by maybeOpenFile().

228 {}

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

inlineprivate

Definition at line 209 of file OutputModuleBase.h.

209 {}

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

inline

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

Definition at line 82 of file OutputModuleBase.h.

References remainingEvents_.

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

82 {return remainingEvents_;}

edm::one::OutputModuleBase::remainingEvents_

std::atomic< int > remainingEvents_

Definition: OutputModuleBase.h:139

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

Definition at line 354 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 109 of file OutputModuleBase.h.

References selector_config_id_.

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

109 { return selector_config_id_; }

edm::one::OutputModuleBase::selector_config_id_

ParameterSetID selector_config_id_

Definition: OutputModuleBase.h:169

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

Definition at line 86 of file OutputModuleBase.cc.

References edm::ProductRegistry::allBranchDescriptions(), edm::BranchDescription::branchType(), droppedBranchIDToKeptBranchID_, edm::ProductSelector::fillDroppedToKept(), hasNewlyDroppedBranch_, edm::ProductSelector::initialize(), edm::ProductSelector::initialized(), keepAssociation_, keepThisBranch(), edm::BranchDescription::present(), edm::BranchDescription::produced(), edm::ProductRegistry::productList(), productSelector_, productSelectorRules_, edm::ThinnedAssociationsHelper::selectAssociationProducts(), selected(), 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;
 
       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);
         } else {
           // otherwise, output nothing,
           // and mark the fact that there is a newly dropped branch of this type.
           hasNewlyDroppedBranch_[desc.branchType()] = true;
         }
       }
 
       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 383 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 244 of file OutputModuleBase.h.

References popcon2dropbox_job_conf::md, and moduleDescription_.

                                                              {
         moduleDescription_ = md;
       }

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 219 of file OutputModuleBase.h.

219 {return false;}

ThinnedAssociationsHelper const * OutputModuleBase::thinnedAssociationsHelper ( ) const

Definition at line 344 of file OutputModuleBase.cc.

References thinnedAssociationsHelper_.

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

                                                       {
       return thinnedAssociationsHelper_.get();
     }

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

inline

Definition at line 96 of file OutputModuleBase.h.

References wantAllEvents_.

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

96 {return wantAllEvents_;}

edm::one::OutputModuleBase::wantAllEvents_

bool wantAllEvents_

Definition: OutputModuleBase.h:164

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

inlineprivate

Definition at line 200 of file OutputModuleBase.h.

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

virtual void edm::one::OutputModuleBase::write	(	EventPrincipal const &	e,
		ModuleCallingContext const *
	)

privatepure virtual

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

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

virtual void edm::one::OutputModuleBase::writeLuminosityBlock	(	LuminosityBlockPrincipal const &	,
		ModuleCallingContext const *
	)

privatepure virtual

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

Referenced by doWriteLuminosityBlock().

virtual void edm::one::OutputModuleBase::writeRun	(	RunPrincipal const &	,
		ModuleCallingContext const *
	)

privatepure virtual

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

Referenced by doWriteRun().

Friends And Related Function Documentation

template<typename T >

friend class ::edm::OutputModuleCommunicatorT

friend

Definition at line 67 of file OutputModuleBase.h.

template<typename T >

friend class ::edm::WorkerT

friend

Definition at line 66 of file OutputModuleBase.h.

template<typename U >

friend class edm::maker::ModuleHolderT

friend

Definition at line 65 of file OutputModuleBase.h.

Member Data Documentation

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

private

Definition at line 174 of file OutputModuleBase.h.

Referenced by branchIDLists().

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

private

Definition at line 173 of file OutputModuleBase.h.

Referenced by branchIDLists(), droppedBranchIDToKeptBranchID(), and selectProducts().

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

private

Definition at line 157 of file OutputModuleBase.h.

Referenced by hasNewlyDroppedBranch(), OutputModuleBase(), and selectProducts().

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

private

Definition at line 179 of file OutputModuleBase.h.

Referenced by selectProducts().

SelectedProductsForBranchType edm::one::OutputModuleBase::keptProducts_

private

Definition at line 156 of file OutputModuleBase.h.

Referenced by keepThisBranch(), and keptProducts().

int edm::one::OutputModuleBase::maxEvents_

private

Definition at line 138 of file OutputModuleBase.h.

Referenced by configure(), and maxEvents().

ModuleDescription edm::one::OutputModuleBase::moduleDescription_

private

Definition at line 162 of file OutputModuleBase.h.

Referenced by description(), moduleDescription(), and setModuleDescription().

std::mutex edm::one::OutputModuleBase::mutex_

private

Definition at line 182 of file OutputModuleBase.h.

Referenced by doEvent().

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

private

Definition at line 175 of file OutputModuleBase.h.

Referenced by branchIDLists(), and configure().

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

private

Definition at line 159 of file OutputModuleBase.h.

Referenced by doPreallocate(), OutputModuleBase(), and processName().

ProductSelector edm::one::OutputModuleBase::productSelector_

private

Definition at line 161 of file OutputModuleBase.h.

Referenced by selected(), and selectProducts().

ProductSelectorRules edm::one::OutputModuleBase::productSelectorRules_

private

Definition at line 160 of file OutputModuleBase.h.

Referenced by selectProducts().

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

private

Definition at line 139 of file OutputModuleBase.h.

Referenced by configure(), doEvent(), limitReached(), and remainingEvents().

SharedResourcesAcquirer edm::one::OutputModuleBase::resourcesAcquirer_

private

Definition at line 181 of file OutputModuleBase.h.

Referenced by doBeginJob(), and doEvent().

ParameterSet edm::one::OutputModuleBase::selectEvents_

private

Definition at line 166 of file OutputModuleBase.h.

Referenced by doPreallocate(), and OutputModuleBase().

ParameterSetID edm::one::OutputModuleBase::selector_config_id_

private

Definition at line 169 of file OutputModuleBase.h.

Referenced by OutputModuleBase(), selectorConfig(), and setEventSelectionInfo().

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

private

Definition at line 165 of file OutputModuleBase.h.

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

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

private

Definition at line 178 of file OutputModuleBase.h.

Referenced by selectProducts(), and thinnedAssociationsHelper().

bool edm::one::OutputModuleBase::wantAllEvents_

private

Definition at line 164 of file OutputModuleBase.h.

Referenced by OutputModuleBase(), prePrefetchSelection(), and wantAllEvents().

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