#include <PoolOutputModule.h>

Inheritance diagram for edm::PoolOutputModule:

Classes
struct	AuxItem

struct	OutputItem

Public Types
typedef std::array< AuxItem, NumBranchTypes >	AuxItemArray

enum	DropMetaData { DropNone, DropDroppedPrior, DropPrior, DropAll }

typedef std::vector< OutputItem >	OutputItemList

typedef std::array < OutputItemList, NumBranchTypes >	OutputItemListArray

Public Types inherited from edm::one::OutputModuleBase
typedef OutputModuleBase	ModuleType

Public Member Functions
AuxItemArray const &	auxItems () const

std::string const &	basketOrder () const

int const &	basketSize () const

std::string const &	catalog () const

std::string const &	compressionAlgorithm () const

int const &	compressionLevel () const

std::string const &	currentFileName () const

DropMetaData const &	dropMetaData () const

int	eventAutoFlushSize () const

std::string const &	fileName () const

int const &	inputFileCount () const

std::string const &	logicalFileName () const

unsigned int const &	maxFileSize () const

std::string const &	moduleLabel () const

PoolOutputModule &	operator= (PoolOutputModule const &)=delete

bool const &	overrideInputFileSplitLevels () const

	PoolOutputModule (ParameterSet const &ps)

	PoolOutputModule (PoolOutputModule const &)=delete

OutputItemListArray const &	selectedOutputItemList () const

int const &	splitLevel () const

int const &	treeMaxVirtualSize () const

int const &	whyNotFastClonable () const

virtual	~PoolOutputModule ()

Public Member Functions inherited from edm::one::OutputModule< WatchInputFiles >
	OutputModule (edm::ParameterSet const &iPSet)

Public Member Functions inherited from edm::one::OutputModuleBase
BranchChildren const &	branchChildren () const

BranchIDLists const *	branchIDLists () const

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)

bool	wantAllEvents () const

virtual	~OutputModuleBase ()

Public Member Functions inherited from edm::EDConsumerBase
	EDConsumerBase ()

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

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

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

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

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

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

bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)

virtual	~EDConsumerBase ()

Static Public Member Functions
static void	fillDescription (ParameterSetDescription &desc)

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::one::OutputModuleBase
static const std::string &	baseType ()

static void	fillDescription (ParameterSetDescription &desc)

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions
virtual void	doExtrasAfterCloseFile ()

virtual std::pair< std::string, std::string >	physicalAndLogicalNameForNewFile ()

virtual bool	shouldWeCloseFile () const override
	allow inheriting classes to override but still be able to call this method in the overridden version More...

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

Protected Member Functions inherited from edm::one::OutputModuleBase
void	configure (OutputModuleDescription const &desc)

ModuleDescription const &	description () const

void	doBeginJob ()

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

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

void	doEndJob ()

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

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

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

void	doPreallocate (PreallocationConfiguration const &)

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

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

ParameterSetID	selectorConfig () const

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

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()

void	consumesMany (const TypeToGet &id)

template<BranchType B>
void	consumesMany (const TypeToGet &id)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Private Member Functions
void	beginInputFile (FileBlock const &fb)

virtual void	beginJob () override

void	fillSelectedItemList (BranchType branchtype, TTree *theInputTree)

void	finishEndFile ()

virtual bool	isFileOpen () const override

virtual void	openFile (FileBlock const &fb) override

virtual void	postForkReacquireResources (unsigned int iChildIndex, unsigned int iNumberOfChildren) override

virtual void	reallyCloseFile () override

virtual void	reallyOpenFile () override

virtual void	respondToCloseInputFile (FileBlock const &fb) override

virtual void	respondToOpenInputFile (FileBlock const &fb) override

void	startEndFile ()

void	writeBranchIDListRegistry ()

void	writeFileFormatVersion ()

void	writeFileIdentifier ()

void	writeIndexIntoFile ()

virtual void	writeLuminosityBlock (LuminosityBlockPrincipal const &lb, ModuleCallingContext const *) override

void	writeParameterSetRegistry ()

void	writeParentageRegistry ()

void	writeProcessHistoryRegistry ()

void	writeProductDependencies ()

void	writeProductDescriptionRegistry ()

virtual void	writeRun (RunPrincipal const &r, ModuleCallingContext const *) override

Private Attributes
AuxItemArray	auxItems_

std::string	basketOrder_

int const	basketSize_

std::string const	catalog_

unsigned int	childIndex_

std::string const	compressionAlgorithm_

int const	compressionLevel_

DropMetaData	dropMetaData_

int const	eventAutoFlushSize_

std::string const	fileName_

bool	initializedFromInput_

int	inputFileCount_

std::string const	logicalFileName_

unsigned int const	maxFileSize_

std::string const	moduleLabel_

unsigned int	numberOfDigitsInIndex_

int	outputFileCount_

bool	overrideInputFileSplitLevels_

std::unique_ptr< RootOutputFile >	rootOutputFile_

RootServiceChecker	rootServiceChecker_

OutputItemListArray	selectedOutputItemList_

int const	splitLevel_

std::string	statusFileName_

int const	treeMaxVirtualSize_

int	whyNotFastClonable_

Detailed Description

Definition at line 29 of file PoolOutputModule.h.

Member Typedef Documentation

typedef std::array<AuxItem, NumBranchTypes> edm::PoolOutputModule::AuxItemArray

Definition at line 65 of file PoolOutputModule.h.

typedef std::vector<OutputItem> edm::PoolOutputModule::OutputItemList

Definition at line 96 of file PoolOutputModule.h.

typedef std::array<OutputItemList, NumBranchTypes> edm::PoolOutputModule::OutputItemListArray

Definition at line 98 of file PoolOutputModule.h.

Member Enumeration Documentation

enum edm::PoolOutputModule::DropMetaData

Enumerator
DropNone
DropDroppedPrior
DropPrior
DropAll

Definition at line 31 of file PoolOutputModule.h.

31 { DropNone, DropDroppedPrior, DropPrior, DropAll };

edm::PoolOutputModule::DropAll

Definition: PoolOutputModule.h:31

edm::PoolOutputModule::DropDroppedPrior

Definition: PoolOutputModule.h:31

edm::PoolOutputModule::DropPrior

Definition: PoolOutputModule.h:31

edm::PoolOutputModule::DropNone

Definition: PoolOutputModule.h:31

Constructor & Destructor Documentation

edm::PoolOutputModule::PoolOutputModule ( ParameterSet const & ps )

explicit

Definition at line 30 of file PoolOutputModule.cc.

References edm::errors::Configuration, DropAll, DropDroppedPrior, dropMetaData(), dropMetaData_, DropNone, DropPrior, edm::FileBlock::EventSelectionUsed, edm::hlt::Exception, edm::ParameterSet::getUntrackedParameter(), edm::ParameterSet::getUntrackedParameterSet(), moduleLabel_, statusFileName_, AlCaHLTBitMon_QueryRunRegistry::string, edm::one::OutputModuleBase::wantAllEvents(), and whyNotFastClonable_.

                                                              :
   edm::one::OutputModuleBase::OutputModuleBase(pset),
   one::OutputModule<WatchInputFiles>(pset),
     rootServiceChecker_(),
     auxItems_(),
     selectedOutputItemList_(),
     fileName_(pset.getUntrackedParameter<std::string>("fileName")),
     logicalFileName_(pset.getUntrackedParameter<std::string>("logicalFileName")),
     catalog_(pset.getUntrackedParameter<std::string>("catalog")),
     maxFileSize_(pset.getUntrackedParameter<int>("maxSize")),
     compressionLevel_(pset.getUntrackedParameter<int>("compressionLevel")),
 #if ROOT_VERSION_CODE >= ROOT_VERSION(5,30,0)
     compressionAlgorithm_(pset.getUntrackedParameter<std::string>("compressionAlgorithm")),
 #else
     compressionAlgorithm_("ZLIB"),
 #endif
     basketSize_(pset.getUntrackedParameter<int>("basketSize")),
     eventAutoFlushSize_(pset.getUntrackedParameter<int>("eventAutoFlushCompressedSize")),
     splitLevel_(std::min<int>(pset.getUntrackedParameter<int>("splitLevel") + 1, 99)),
     basketOrder_(pset.getUntrackedParameter<std::string>("sortBaskets")),
     treeMaxVirtualSize_(pset.getUntrackedParameter<int>("treeMaxVirtualSize")),
     whyNotFastClonable_(pset.getUntrackedParameter<bool>("fastCloning") ? FileBlock::CanFastClone : FileBlock::DisabledInConfigFile),
     dropMetaData_(DropNone),
     moduleLabel_(pset.getParameter<std::string>("@module_label")),
     initializedFromInput_(false),
     outputFileCount_(0),
     inputFileCount_(0),
     childIndex_(0U),
     numberOfDigitsInIndex_(0U),
     overrideInputFileSplitLevels_(pset.getUntrackedParameter<bool>("overrideInputFileSplitLevels")),
     rootOutputFile_(),
     statusFileName_() {
 
       if (pset.getUntrackedParameter<bool>("writeStatusFile")) {
         std::ostringstream statusfilename;
         statusfilename << moduleLabel_ << '_' << getpid();
         statusFileName_ = statusfilename.str();
       }
 
       std::string dropMetaData(pset.getUntrackedParameter<std::string>("dropMetaData"));
       if(dropMetaData.empty()) dropMetaData_ = DropNone;
       else if(dropMetaData == std::string("NONE")) dropMetaData_ = DropNone;
       else if(dropMetaData == std::string("DROPPED")) dropMetaData_ = DropDroppedPrior;
       else if(dropMetaData == std::string("PRIOR")) dropMetaData_ = DropPrior;
       else if(dropMetaData == std::string("ALL")) dropMetaData_ = DropAll;
       else {
         throw edm::Exception(errors::Configuration, "Illegal dropMetaData parameter value: ")
             << dropMetaData << ".\n"
             << "Legal values are 'NONE', 'DROPPED', 'PRIOR', and 'ALL'.\n";
       }
 
     if (!wantAllEvents()) {
       whyNotFastClonable_+= FileBlock::EventSelectionUsed;
     }
 
     // We don't use this next parameter, but we read it anyway because it is part
     // of the configuration of this module.  An external parser creates the
     // configuration by reading this source code.
     pset.getUntrackedParameterSet("dataset");
   }

edm::PoolOutputModule::~PoolOutputModule ( )

virtual

Definition at line 239 of file PoolOutputModule.cc.

239 {

240 }

edm::PoolOutputModule::PoolOutputModule ( PoolOutputModule const & )

delete

Member Function Documentation

AuxItemArray const& edm::PoolOutputModule::auxItems ( ) const

inline

Definition at line 66 of file PoolOutputModule.h.

References auxItems_.

Referenced by edm::RootOutputFile::RootOutputFile().

66 {return auxItems_;}

edm::PoolOutputModule::auxItems_

AuxItemArray auxItems_

Definition: PoolOutputModule.h:137

std::string const& edm::PoolOutputModule::basketOrder ( ) const

inline

Definition at line 43 of file PoolOutputModule.h.

References basketOrder_.

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

43 {return basketOrder_;}

edm::PoolOutputModule::basketOrder_

std::string basketOrder_

Definition: PoolOutputModule.h:148

int const& edm::PoolOutputModule::basketSize ( ) const

inline

Definition at line 40 of file PoolOutputModule.h.

References basketSize_.

Referenced by fillSelectedItemList(), edm::RootOutputFile::writeBranchIDListRegistry(), edm::RootOutputFile::writeFileFormatVersion(), edm::RootOutputFile::writeFileIdentifier(), edm::RootOutputFile::writeIndexIntoFile(), edm::RootOutputFile::writeParameterSetRegistry(), edm::RootOutputFile::writeParentageRegistry(), edm::RootOutputFile::writeProcessHistoryRegistry(), edm::RootOutputFile::writeProductDependencies(), and edm::RootOutputFile::writeProductDescriptionRegistry().

40 {return basketSize_;}

edm::PoolOutputModule::basketSize_

int const basketSize_

Definition: PoolOutputModule.h:145

void edm::PoolOutputModule::beginInputFile ( FileBlock const & fb )

private

Definition at line 196 of file PoolOutputModule.cc.

References isFileOpen(), edm::one::OutputModuleBase::remainingEvents(), and rootOutputFile_.

Referenced by openFile(), and respondToOpenInputFile().

                                                            {
     if(isFileOpen()) {
       rootOutputFile_->beginInputFile(fb, remainingEvents());
     }
   }

void edm::PoolOutputModule::beginJob ( void )

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 91 of file PoolOutputModule.cc.

References revisionDML::branchType(), edm::checkDictionaries(), edm::BranchDescription::fullClassName(), i, edm::InEvent, edm::one::OutputModuleBase::keptProducts(), edm::NumBranchTypes, parseEventContent::prod, and edm::wrappedClassName().

                                   {
     for(int i = InEvent; i < NumBranchTypes; ++i) {
       BranchType branchType = static_cast<BranchType>(i);
       SelectedProducts const& keptVector = keptProducts()[branchType];
       for(SelectedProducts::const_iterator it = keptVector.begin(), itEnd = keptVector.end(); it != itEnd; ++it) {
         BranchDescription const& prod = **it;
         checkDictionaries(prod.fullClassName(), true);
         checkDictionaries(wrappedClassName(prod.fullClassName()), true);
       }
     }
   }

std::string const& edm::PoolOutputModule::catalog ( ) const

inline

Definition at line 47 of file PoolOutputModule.h.

References catalog_.

Referenced by edm::RootOutputFile::RootOutputFile().

47 {return catalog_;}

edm::PoolOutputModule::catalog_

std::string const catalog_

Definition: PoolOutputModule.h:141

std::string const& edm::PoolOutputModule::compressionAlgorithm ( ) const

inline

Definition at line 39 of file PoolOutputModule.h.

References compressionAlgorithm_.

Referenced by edm::RootOutputFile::RootOutputFile().

39 {return compressionAlgorithm_;}

edm::PoolOutputModule::compressionAlgorithm_

std::string const compressionAlgorithm_

Definition: PoolOutputModule.h:144

int const& edm::PoolOutputModule::compressionLevel ( ) const

inline

Definition at line 38 of file PoolOutputModule.h.

References compressionLevel_.

38 {return compressionLevel_;}

edm::PoolOutputModule::compressionLevel_

int const compressionLevel_

Definition: PoolOutputModule.h:143

std::string const & edm::PoolOutputModule::currentFileName ( ) const

Definition at line 103 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by edm::TimeoutPoolOutputModule::shouldWeCloseFile().

                                                            {
     return rootOutputFile_->fileName();
   }

void edm::PoolOutputModule::doExtrasAfterCloseFile ( )

protectedvirtual

Reimplemented in dqmservices::JsonWritingTimeoutPoolOutputModule.

Definition at line 289 of file PoolOutputModule.cc.

Referenced by reallyCloseFile().

289 {}

DropMetaData const& edm::PoolOutputModule::dropMetaData ( ) const

inline

Definition at line 46 of file PoolOutputModule.h.

References dropMetaData_.

Referenced by edm::RootOutputFile::fillBranches(), edm::RootOutputFile::insertAncestors(), and PoolOutputModule().

46 {return dropMetaData_;}

edm::PoolOutputModule::dropMetaData_

DropMetaData dropMetaData_

Definition: PoolOutputModule.h:151

int edm::PoolOutputModule::eventAutoFlushSize ( ) const

inline

Definition at line 41 of file PoolOutputModule.h.

References eventAutoFlushSize_.

Referenced by edm::RootOutputFile::RootOutputFile().

41 {return eventAutoFlushSize_;}

edm::PoolOutputModule::eventAutoFlushSize_

int const eventAutoFlushSize_

Definition: PoolOutputModule.h:146

std::string const& edm::PoolOutputModule::fileName ( ) const

inline

Definition at line 36 of file PoolOutputModule.h.

References fileName_.

Referenced by physicalAndLogicalNameForNewFile().

36 {return fileName_;}

edm::PoolOutputModule::fileName_

std::string const fileName_

Definition: PoolOutputModule.h:139

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

static

Definition at line 333 of file PoolOutputModule.cc.

References edm::ParameterSetDescription::addUntracked(), edm::OutputModule::fillDescription(), edm::ParameterSetDescription::setAllowAnything(), edm::ParameterSetDescription::setComment(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by fillDescriptions().

                                                                  {
     std::string defaultString;
 
     desc.setComment("Writes runs, lumis, and events into EDM/ROOT files.");
     desc.addUntracked<std::string>("fileName")
         ->setComment("Name of output file.");
     desc.addUntracked<std::string>("logicalFileName", defaultString)
         ->setComment("Passed to job report. Otherwise unused by module.");
     desc.addUntracked<std::string>("catalog", defaultString)
         ->setComment("Passed to job report. Otherwise unused by module.");
     desc.addUntracked<int>("maxSize", 0x7f000000)
         ->setComment("Maximum output file size, in kB.\n"
                      "If over maximum, new output file will be started at next input file transition.");
     desc.addUntracked<int>("compressionLevel", 7)
         ->setComment("ROOT compression level of output file.");
 #if ROOT_VERSION_CODE >= ROOT_VERSION(5,30,0)
     desc.addUntracked<std::string>("compressionAlgorithm", "ZLIB")
         ->setComment("Algorithm used to compress data in the ROOT output file, allowed values are ZLIB and LZMA");
 #endif
     desc.addUntracked<int>("basketSize", 16384)
         ->setComment("Default ROOT basket size in output file.");
     desc.addUntracked<int>("eventAutoFlushCompressedSize",-1)->setComment("Set ROOT auto flush stored data size (in bytes) for event TTree. The value sets how large the compressed buffer is allowed to get. The uncompressed buffer can be quite a bit larger than this depending on the average compression ratio. The value of -1 just uses ROOT's default value. The value of 0 turns off this feature.");
     desc.addUntracked<int>("splitLevel", 99)
         ->setComment("Default ROOT branch split level in output file.");
     desc.addUntracked<std::string>("sortBaskets", std::string("sortbasketsbyoffset"))
         ->setComment("Legal values: 'sortbasketsbyoffset', 'sortbasketsbybranch', 'sortbasketsbyentry'.\n"
                      "Used by ROOT when fast copying. Affects performance.");
     desc.addUntracked<int>("treeMaxVirtualSize", -1)
         ->setComment("Size of ROOT TTree TBasket cache.  Affects performance.");
     desc.addUntracked<bool>("fastCloning", true)
         ->setComment("True:  Allow fast copying, if possible.\n"
                      "False: Disable fast copying.");
     desc.addUntracked<bool>("overrideInputFileSplitLevels", false)
         ->setComment("False: Use branch split levels and basket sizes from input file, if possible.\n"
                      "True:  Always use specified or default split levels and basket sizes.");
     desc.addUntracked<bool>("writeStatusFile", false)
         ->setComment("Write a status file. Intended for use by workflow management.");
     desc.addUntracked<std::string>("dropMetaData", defaultString)
         ->setComment("Determines handling of per product per event metadata.  Options are:\n"
                      "'NONE':    Keep all of it.\n"
                      "'DROPPED': Keep it for products produced in current process and all kept products. Drop it for dropped products produced in prior processes.\n"
                      "'PRIOR':   Keep it for products produced in current process. Drop it for products produced in prior processes.\n"
                      "'ALL':     Drop all of it.");
     ParameterSetDescription dataSet;
     dataSet.setAllowAnything();
     desc.addUntracked<ParameterSetDescription>("dataset", dataSet)
      ->setComment("PSet is only used by Data Operations and not by this module.");
 
     OutputModule::fillDescription(desc);
   }

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

static

Definition at line 385 of file PoolOutputModule.cc.

References edm::ConfigurationDescriptions::add(), and fillDescription().

                                                                              {
     ParameterSetDescription desc;
     PoolOutputModule::fillDescription(desc);
     descriptions.add("edmOutput", desc);
   }

void edm::PoolOutputModule::fillSelectedItemList	(	BranchType	branchtype,
		TTree *	theInputTree
	)

private

Definition at line 155 of file PoolOutputModule.cc.

References auxItems_, basketSize(), edm::BranchDescription::basketSize(), edm::PoolOutputModule::AuxItem::basketSize_, edm::PoolOutputModule::OutputItem::basketSize_, edm::BranchDescription::branchName(), revisionDML::branchType(), edm::BranchTypeToAuxiliaryBranchName(), edm::BranchDescription::invalidBasketSize, edm::BranchDescription::invalidSplitLevel, edm::one::OutputModuleBase::keptProducts(), overrideInputFileSplitLevels_, parseEventContent::prod, edm::BranchDescription::produced(), selectedOutputItemList_, edm::sort_all(), splitLevel(), edm::BranchDescription::splitLevel(), and edm::PoolOutputModule::OutputItem::splitLevel_.

Referenced by respondToOpenInputFile().

                                                                                         {
 
     SelectedProducts const& keptVector = keptProducts()[branchType];
     OutputItemList&   outputItemList = selectedOutputItemList_[branchType];
     AuxItem&   auxItem = auxItems_[branchType];
 
     // Fill AuxItem
     if (theInputTree != 0 && !overrideInputFileSplitLevels_) {
       TBranch* auxBranch = theInputTree->GetBranch(BranchTypeToAuxiliaryBranchName(branchType).c_str());
       if (auxBranch) {
         auxItem.basketSize_ = auxBranch->GetBasketSize();
       } else {
         auxItem.basketSize_ = basketSize_;
       }
     } else {
       auxItem.basketSize_ = basketSize_;
     }
 
     // Fill outputItemList with an entry for each branch.
     for(SelectedProducts::const_iterator it = keptVector.begin(), itEnd = keptVector.end(); it != itEnd; ++it) {
       int splitLevel = BranchDescription::invalidSplitLevel;
       int basketSize = BranchDescription::invalidBasketSize;
 
       BranchDescription const& prod = **it;
       TBranch* theBranch = ((!prod.produced() && theInputTree != 0 && !overrideInputFileSplitLevels_) ? theInputTree->GetBranch(prod.branchName().c_str()) : 0);
 
       if(theBranch != 0) {
         splitLevel = theBranch->GetSplitLevel();
         basketSize = theBranch->GetBasketSize();
       } else {
         splitLevel = (prod.splitLevel() == BranchDescription::invalidSplitLevel ? splitLevel_ : prod.splitLevel());
         basketSize = (prod.basketSize() == BranchDescription::invalidBasketSize ? basketSize_ : prod.basketSize());
       }
       outputItemList.emplace_back(&prod, splitLevel, basketSize);
     }
 
     // Sort outputItemList to allow fast copying.
     // The branches in outputItemList must be in the same order as in the input tree, with all new branches at the end.
     sort_all(outputItemList, OutputItem::Sorter(theInputTree));
   }

void edm::PoolOutputModule::finishEndFile ( )

private

Definition at line 288 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

288 { rootOutputFile_->finishEndFile(); rootOutputFile_.reset(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

int const& edm::PoolOutputModule::inputFileCount ( ) const

inline

Definition at line 50 of file PoolOutputModule.h.

References inputFileCount_.

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

50 {return inputFileCount_;}

edm::PoolOutputModule::inputFileCount_

int inputFileCount_

Definition: PoolOutputModule.h:155

bool edm::PoolOutputModule::isFileOpen ( ) const

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 290 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by beginInputFile(), and openFile().

290 { return rootOutputFile_.get() != 0; }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

std::string const& edm::PoolOutputModule::logicalFileName ( ) const

inline

Definition at line 37 of file PoolOutputModule.h.

References logicalFileName_.

Referenced by physicalAndLogicalNameForNewFile().

37 {return logicalFileName_;}

edm::PoolOutputModule::logicalFileName_

std::string const logicalFileName_

Definition: PoolOutputModule.h:140

unsigned int const& edm::PoolOutputModule::maxFileSize ( ) const

inline

Definition at line 49 of file PoolOutputModule.h.

References maxFileSize_.

Referenced by edm::RootOutputFile::shouldWeCloseFile().

49 {return maxFileSize_;}

edm::PoolOutputModule::maxFileSize_

unsigned int const maxFileSize_

Definition: PoolOutputModule.h:142

std::string const& edm::PoolOutputModule::moduleLabel ( ) const

inline

Definition at line 48 of file PoolOutputModule.h.

References moduleLabel_.

Referenced by edm::RootOutputFile::RootOutputFile().

48 {return moduleLabel_;}

edm::PoolOutputModule::moduleLabel_

std::string const moduleLabel_

Definition: PoolOutputModule.h:152

void edm::PoolOutputModule::openFile ( FileBlock const & fb )

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 202 of file PoolOutputModule.cc.

References beginInputFile(), isFileOpen(), and reallyOpenFile().

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

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

delete

bool const& edm::PoolOutputModule::overrideInputFileSplitLevels ( ) const

inline

Definition at line 45 of file PoolOutputModule.h.

References overrideInputFileSplitLevels_.

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

45 {return overrideInputFileSplitLevels_;}

edm::PoolOutputModule::overrideInputFileSplitLevels_

bool overrideInputFileSplitLevels_

Definition: PoolOutputModule.h:158

std::pair< std::string, std::string > edm::PoolOutputModule::physicalAndLogicalNameForNewFile ( )

protectedvirtual

Reimplemented in dqmservices::JsonWritingTimeoutPoolOutputModule.

Definition at line 294 of file PoolOutputModule.cc.

References childIndex_, relativeConstraints::empty, edm::hlt::Exception, fileName(), inputFileCount_, logicalFileName(), edm::errors::LogicError, numberOfDigitsInIndex_, evf::evtn::offset(), outputFileCount_, AlCaHLTBitMon_QueryRunRegistry::string, and createPayload::suffix.

Referenced by reallyOpenFile().

                                                      {
       if(inputFileCount_ == 0) {
         throw edm::Exception(errors::LogicError)
           << "Attempt to open output file before input file. "
           << "Please report this to the core framework developers.\n";
       }
       std::string suffix(".root");
       std::string::size_type offset = fileName().rfind(suffix);
       bool ext = (offset == fileName().size() - suffix.size());
       if(!ext) suffix.clear();
       std::string fileBase(ext ? fileName().substr(0, offset) : fileName());
       std::ostringstream ofilename;
       std::ostringstream lfilename;
       ofilename << fileBase;
       lfilename << logicalFileName();
       if(numberOfDigitsInIndex_) {
         ofilename << '_' << std::setw(numberOfDigitsInIndex_) << std::setfill('0') << childIndex_;
         if(!logicalFileName().empty()) {
           lfilename << '_' << std::setw(numberOfDigitsInIndex_) << std::setfill('0') << childIndex_;
         }
       }
       if(outputFileCount_) {
         ofilename << std::setw(3) << std::setfill('0') << outputFileCount_;
         if(!logicalFileName().empty()) {
           lfilename << std::setw(3) << std::setfill('0') << outputFileCount_;
         }
       }
       ofilename << suffix;
       ++outputFileCount_;
 
       return std::make_pair(ofilename.str(), lfilename.str());
   }

void edm::PoolOutputModule::postForkReacquireResources	(	unsigned int	iChildIndex,
		unsigned int	iNumberOfChildren
	)

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 228 of file PoolOutputModule.cc.

References childIndex_, and numberOfDigitsInIndex_.

                                                                                                             {
     childIndex_ = iChildIndex;
     while (iNumberOfChildren != 0) {
       ++numberOfDigitsInIndex_;
       iNumberOfChildren /= 10;
     }
     if (numberOfDigitsInIndex_ == 0) {
       numberOfDigitsInIndex_ = 3; // Protect against zero iNumberOfChildren
     }
   }

void edm::PoolOutputModule::reallyCloseFile ( )

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 259 of file PoolOutputModule.cc.

References doExtrasAfterCloseFile(), finishEndFile(), startEndFile(), writeBranchIDListRegistry(), writeFileFormatVersion(), writeFileIdentifier(), writeIndexIntoFile(), writeParameterSetRegistry(), writeParentageRegistry(), writeProcessHistoryRegistry(), writeProductDependencies(), and writeProductDescriptionRegistry().

                                          {
     startEndFile();
     writeFileFormatVersion();
     writeFileIdentifier();
     writeIndexIntoFile();
     writeProcessHistoryRegistry();
     writeParameterSetRegistry();
     writeProductDescriptionRegistry();
     writeParentageRegistry();
     writeBranchIDListRegistry();
     writeProductDependencies();
     finishEndFile();
 
     doExtrasAfterCloseFile();
   }

void edm::PoolOutputModule::reallyOpenFile ( )

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 327 of file PoolOutputModule.cc.

References cscdqm::h::names, physicalAndLogicalNameForNewFile(), and rootOutputFile_.

Referenced by openFile().

                                         {
     auto names = physicalAndLogicalNameForNewFile();
     rootOutputFile_.reset( new RootOutputFile(this, names.first, names.second));
   }

void edm::PoolOutputModule::respondToCloseInputFile ( FileBlock const & fb )

overrideprivatevirtual

Definition at line 224 of file PoolOutputModule.cc.

References rootOutputFile_.

                                                                     {
     if(rootOutputFile_) rootOutputFile_->respondToCloseInputFile(fb);
   }

void edm::PoolOutputModule::respondToOpenInputFile ( FileBlock const & fb )

overrideprivatevirtual

Definition at line 209 of file PoolOutputModule.cc.

References beginInputFile(), revisionDML::branchType(), fillSelectedItemList(), i, edm::InEvent, initializedFromInput_, edm::InLumi, inputFileCount_, edm::FileBlock::lumiTree(), edm::NumBranchTypes, edm::FileBlock::runTree(), and edm::FileBlock::tree().

                                                                    {
     if(!initializedFromInput_) {
       for(int i = InEvent; i < NumBranchTypes; ++i) {
         BranchType branchType = static_cast<BranchType>(i);
         TTree* theInputTree = (branchType == InEvent ? fb.tree() :
                               (branchType == InLumi ? fb.lumiTree() :
                                fb.runTree()));
         fillSelectedItemList(branchType, theInputTree);
       }
       initializedFromInput_ = true;
     }
     ++inputFileCount_;
     beginInputFile(fb);
   }

OutputItemListArray const& edm::PoolOutputModule::selectedOutputItemList ( ) const

inline

Definition at line 100 of file PoolOutputModule.h.

References selectedOutputItemList_.

Referenced by edm::RootOutputFile::fillBranches(), and edm::RootOutputFile::RootOutputFile().

100 {return selectedOutputItemList_;}

edm::PoolOutputModule::selectedOutputItemList_

OutputItemListArray selectedOutputItemList_

Definition: PoolOutputModule.h:138

bool edm::PoolOutputModule::shouldWeCloseFile ( ) const

overrideprotectedvirtual

allow inheriting classes to override but still be able to call this method in the overridden version

Reimplemented from edm::one::OutputModuleBase.

Reimplemented in edm::TimeoutPoolOutputModule.

Definition at line 291 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by edm::TimeoutPoolOutputModule::shouldWeCloseFile().

291 { return rootOutputFile_->shouldWeCloseFile(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

int const& edm::PoolOutputModule::splitLevel ( ) const

inline

Definition at line 42 of file PoolOutputModule.h.

References splitLevel_.

Referenced by fillSelectedItemList().

42 {return splitLevel_;}

edm::PoolOutputModule::splitLevel_

int const splitLevel_

Definition: PoolOutputModule.h:147

void edm::PoolOutputModule::startEndFile ( )

private

Definition at line 277 of file PoolOutputModule.cc.

Referenced by reallyCloseFile().

277 { }

int const& edm::PoolOutputModule::treeMaxVirtualSize ( ) const

inline

Definition at line 44 of file PoolOutputModule.h.

References treeMaxVirtualSize_.

44 {return treeMaxVirtualSize_;}

edm::PoolOutputModule::treeMaxVirtualSize_

int const treeMaxVirtualSize_

Definition: PoolOutputModule.h:149

int const& edm::PoolOutputModule::whyNotFastClonable ( ) const

inline

Definition at line 51 of file PoolOutputModule.h.

References whyNotFastClonable_.

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

51 {return whyNotFastClonable_;}

edm::PoolOutputModule::whyNotFastClonable_

int whyNotFastClonable_

Definition: PoolOutputModule.h:150

void edm::PoolOutputModule::write	(	EventPrincipal const &	e,
		ModuleCallingContext const *	mcc
	)

overrideprotectedvirtual

Implements edm::one::OutputModuleBase.

Reimplemented in edm::TimeoutPoolOutputModule.

Definition at line 242 of file PoolOutputModule.cc.

References edm::EventPrincipal::id(), rootOutputFile_, and statusFileName_.

Referenced by edm::TimeoutPoolOutputModule::write().

                                                                                        {
     rootOutputFile_->writeOne(e, mcc);
       if (!statusFileName_.empty()) {
         std::ofstream statusFile(statusFileName_.c_str());
         statusFile << e.id() << " time: " << std::setprecision(3) << TimeOfDay() << '\n';
         statusFile.close();
       }
   }

void edm::PoolOutputModule::writeBranchIDListRegistry ( )

private

Definition at line 286 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

286 { rootOutputFile_->writeBranchIDListRegistry(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

void edm::PoolOutputModule::writeFileFormatVersion ( )

private

Definition at line 279 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

279 { rootOutputFile_->writeFileFormatVersion(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

void edm::PoolOutputModule::writeFileIdentifier ( )

private

Definition at line 280 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

280 { rootOutputFile_->writeFileIdentifier(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

void edm::PoolOutputModule::writeIndexIntoFile ( )

private

Definition at line 281 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

281 { rootOutputFile_->writeIndexIntoFile(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

void edm::PoolOutputModule::writeLuminosityBlock	(	LuminosityBlockPrincipal const &	lb,
		ModuleCallingContext const *	mcc
	)

overrideprivatevirtual

Implements edm::one::OutputModuleBase.

Definition at line 251 of file PoolOutputModule.cc.

References rootOutputFile_.

                                                                                                                  {
     rootOutputFile_->writeLuminosityBlock(lb, mcc);
   }

void edm::PoolOutputModule::writeParameterSetRegistry ( )

private

Definition at line 283 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

283 { rootOutputFile_->writeParameterSetRegistry(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

void edm::PoolOutputModule::writeParentageRegistry ( )

private

Definition at line 285 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

285 { rootOutputFile_->writeParentageRegistry(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

void edm::PoolOutputModule::writeProcessHistoryRegistry ( )

private

Definition at line 282 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

282 { rootOutputFile_->writeProcessHistoryRegistry(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

void edm::PoolOutputModule::writeProductDependencies ( )

private

Definition at line 287 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

287 { rootOutputFile_->writeProductDependencies(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

void edm::PoolOutputModule::writeProductDescriptionRegistry ( )

private

Definition at line 284 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

284 { rootOutputFile_->writeProductDescriptionRegistry(); }

edm::PoolOutputModule::rootOutputFile_

std::unique_ptr< RootOutputFile > rootOutputFile_

Definition: PoolOutputModule.h:159

void edm::PoolOutputModule::writeRun	(	RunPrincipal const &	r,
		ModuleCallingContext const *	mcc
	)

overrideprivatevirtual

Implements edm::one::OutputModuleBase.

Definition at line 255 of file PoolOutputModule.cc.

References rootOutputFile_.

                                                                                         {
     rootOutputFile_->writeRun(r, mcc);
   }

Member Data Documentation

AuxItemArray edm::PoolOutputModule::auxItems_

private

Definition at line 137 of file PoolOutputModule.h.

Referenced by auxItems(), and fillSelectedItemList().

std::string edm::PoolOutputModule::basketOrder_

private

Definition at line 148 of file PoolOutputModule.h.

Referenced by basketOrder().

int const edm::PoolOutputModule::basketSize_

private

Definition at line 145 of file PoolOutputModule.h.

Referenced by basketSize().

std::string const edm::PoolOutputModule::catalog_

private

Definition at line 141 of file PoolOutputModule.h.

Referenced by catalog().

unsigned int edm::PoolOutputModule::childIndex_

private

Definition at line 156 of file PoolOutputModule.h.

Referenced by physicalAndLogicalNameForNewFile(), and postForkReacquireResources().

std::string const edm::PoolOutputModule::compressionAlgorithm_

private

Definition at line 144 of file PoolOutputModule.h.

Referenced by compressionAlgorithm().

int const edm::PoolOutputModule::compressionLevel_

private

Definition at line 143 of file PoolOutputModule.h.

Referenced by compressionLevel().

DropMetaData edm::PoolOutputModule::dropMetaData_

private

Definition at line 151 of file PoolOutputModule.h.

Referenced by dropMetaData(), and PoolOutputModule().

int const edm::PoolOutputModule::eventAutoFlushSize_

private

Definition at line 146 of file PoolOutputModule.h.

Referenced by eventAutoFlushSize().

std::string const edm::PoolOutputModule::fileName_

private

Definition at line 139 of file PoolOutputModule.h.

Referenced by fileName().

bool edm::PoolOutputModule::initializedFromInput_

private

Definition at line 153 of file PoolOutputModule.h.

Referenced by respondToOpenInputFile().

int edm::PoolOutputModule::inputFileCount_

private

Definition at line 155 of file PoolOutputModule.h.

Referenced by inputFileCount(), physicalAndLogicalNameForNewFile(), and respondToOpenInputFile().

std::string const edm::PoolOutputModule::logicalFileName_

private

Definition at line 140 of file PoolOutputModule.h.

Referenced by logicalFileName().

unsigned int const edm::PoolOutputModule::maxFileSize_

private

Definition at line 142 of file PoolOutputModule.h.

Referenced by maxFileSize().

std::string const edm::PoolOutputModule::moduleLabel_

private

Definition at line 152 of file PoolOutputModule.h.

Referenced by Mixins._TypedParameterizable::insertInto(), moduleLabel(), Modules.ESSource::nameInProcessDesc_(), Modules.ESProducer::nameInProcessDesc_(), and PoolOutputModule().

unsigned int edm::PoolOutputModule::numberOfDigitsInIndex_

private

Definition at line 157 of file PoolOutputModule.h.

Referenced by physicalAndLogicalNameForNewFile(), and postForkReacquireResources().

int edm::PoolOutputModule::outputFileCount_

private

Definition at line 154 of file PoolOutputModule.h.

Referenced by physicalAndLogicalNameForNewFile().

bool edm::PoolOutputModule::overrideInputFileSplitLevels_

private

Definition at line 158 of file PoolOutputModule.h.

Referenced by fillSelectedItemList(), and overrideInputFileSplitLevels().

std::unique_ptr<RootOutputFile> edm::PoolOutputModule::rootOutputFile_

private

RootServiceChecker edm::PoolOutputModule::rootServiceChecker_

private

Definition at line 136 of file PoolOutputModule.h.

OutputItemListArray edm::PoolOutputModule::selectedOutputItemList_

private

Definition at line 138 of file PoolOutputModule.h.

Referenced by fillSelectedItemList(), and selectedOutputItemList().

int const edm::PoolOutputModule::splitLevel_

private

Definition at line 147 of file PoolOutputModule.h.

Referenced by splitLevel().

std::string edm::PoolOutputModule::statusFileName_

private

Definition at line 160 of file PoolOutputModule.h.

Referenced by PoolOutputModule(), and write().

int const edm::PoolOutputModule::treeMaxVirtualSize_

private

Definition at line 149 of file PoolOutputModule.h.

Referenced by treeMaxVirtualSize().

int edm::PoolOutputModule::whyNotFastClonable_

private

Definition at line 150 of file PoolOutputModule.h.

Referenced by PoolOutputModule(), and whyNotFastClonable().

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation