test
CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes
edm::PoolOutputModule Class Reference

#include <PoolOutputModule.h>

Inheritance diagram for edm::PoolOutputModule:
edm::one::OutputModule< WatchInputFiles > edm::one::OutputModuleBase edm::EDConsumerBase edm::TimeoutPoolOutputModule dqmservices::JsonWritingTimeoutPoolOutputModule

Classes

struct  AuxItem
 
struct  OutputItem
 

Public Types

typedef std::array< AuxItem,
NumBranchTypes
AuxItemArray
 
enum  DropMetaData { DropNone, DropDroppedPrior, DropPrior, DropAll }
 
typedef std::vector< OutputItemOutputItemList
 
typedef std::array
< OutputItemList,
NumBranchTypes
OutputItemListArray
 
- Public Types inherited from edm::one::OutputModuleBase
typedef OutputModuleBase ModuleType
 
- Public Types inherited from edm::EDConsumerBase
typedef ProductLabels Labels
 

Public Member Functions

AuxItemArray const & auxItems () const
 
std::string const & basketOrder () const
 
int const & basketSize () const
 
BranchChildren const & branchChildren () 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
 
PoolOutputModuleoperator= (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
BranchIDLists const * branchIDLists ()
 
std::array< bool,
NumBranchTypes > const & 
hasNewlyDroppedBranch () const
 
SelectedProductsForBranchType
const & 
keptProducts () const
 
int maxEvents () const
 
const ModuleDescriptionmoduleDescription () const
 
OutputModuleBaseoperator= (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< ConsumesInfoconsumesInfo () const
 
 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 & 
itemsToGetFromEvent () 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
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
bool registeredToConsume (ProductResolverIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
void updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
 
virtual ~EDConsumerBase () noexcept(false)
 

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 (EventForOutput const &e) 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 ()
 
ParameterSetID selectorConfig () const
 
void setEventSelectionInfo (std::map< std::string, std::vector< std::pair< std::string, int > > > const &outputModulePathPositions, bool anyProductProduced)
 
- Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
EDGetToken consumes (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken consumes (TypeToGet const &id, edm::InputTag const &tag)
 
ConsumesCollector consumesCollector ()
 Use a ConsumesCollector to gather consumes information from helper functions. More...
 
template<typename ProductType , BranchType B = InEvent>
void consumesMany ()
 
void consumesMany (const TypeToGet &id)
 
template<BranchType B>
void consumesMany (const TypeToGet &id)
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > mayConsume (edm::InputTag const &tag)
 
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 

Private Types

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

Private Member Functions

void beginInputFile (FileBlock const &fb)
 
virtual void beginJob () override
 
void fillDependencyGraph ()
 
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 updateBranchParents (EventForOutput const &e)
 
void writeBranchIDListRegistry ()
 
void writeFileFormatVersion ()
 
void writeFileIdentifier ()
 
void writeIndexIntoFile ()
 
virtual void writeLuminosityBlock (LuminosityBlockForOutput const &lb) override
 
void writeParameterSetRegistry ()
 
void writeParentageRegistry ()
 
void writeProcessHistoryRegistry ()
 
void writeProductDependencies ()
 
void writeProductDescriptionRegistry ()
 
virtual void writeRun (RunForOutput const &r) override
 
void writeThinnedAssociationsHelper ()
 

Private Attributes

AuxItemArray auxItems_
 
std::string basketOrder_
 
int const basketSize_
 
BranchChildren branchChildren_
 
BranchParents branchParents_
 
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_
 
edm::propagate_const
< 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 33 of file PoolOutputModule.h.

Member Typedef Documentation

Definition at line 69 of file PoolOutputModule.h.

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

Definition at line 128 of file PoolOutputModule.h.

Definition at line 101 of file PoolOutputModule.h.

Definition at line 103 of file PoolOutputModule.h.

Member Enumeration Documentation

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, Exception, edm::ParameterSet::getUntrackedParameter(), edm::ParameterSet::getUntrackedParameterSet(), moduleLabel_, statusFileName_, AlCaHLTBitMon_QueryRunRegistry::string, edm::one::OutputModuleBase::wantAllEvents(), and whyNotFastClonable_.

30  :
32  one::OutputModule<WatchInputFiles>(pset),
34  auxItems_(),
36  fileName_(pset.getUntrackedParameter<std::string>("fileName")),
37  logicalFileName_(pset.getUntrackedParameter<std::string>("logicalFileName")),
38  catalog_(pset.getUntrackedParameter<std::string>("catalog")),
39  maxFileSize_(pset.getUntrackedParameter<int>("maxSize")),
40  compressionLevel_(pset.getUntrackedParameter<int>("compressionLevel")),
41  compressionAlgorithm_(pset.getUntrackedParameter<std::string>("compressionAlgorithm")),
42  basketSize_(pset.getUntrackedParameter<int>("basketSize")),
43  eventAutoFlushSize_(pset.getUntrackedParameter<int>("eventAutoFlushCompressedSize")),
44  splitLevel_(std::min<int>(pset.getUntrackedParameter<int>("splitLevel") + 1, 99)),
45  basketOrder_(pset.getUntrackedParameter<std::string>("sortBaskets")),
46  treeMaxVirtualSize_(pset.getUntrackedParameter<int>("treeMaxVirtualSize")),
47  whyNotFastClonable_(pset.getUntrackedParameter<bool>("fastCloning") ? FileBlock::CanFastClone : FileBlock::DisabledInConfigFile),
49  moduleLabel_(pset.getParameter<std::string>("@module_label")),
50  initializedFromInput_(false),
52  inputFileCount_(0),
53  childIndex_(0U),
57  overrideInputFileSplitLevels_(pset.getUntrackedParameter<bool>("overrideInputFileSplitLevels")),
59  statusFileName_() {
60 
61  if (pset.getUntrackedParameter<bool>("writeStatusFile")) {
62  std::ostringstream statusfilename;
63  statusfilename << moduleLabel_ << '_' << getpid();
64  statusFileName_ = statusfilename.str();
65  }
66 
67  std::string dropMetaData(pset.getUntrackedParameter<std::string>("dropMetaData"));
68  if(dropMetaData.empty()) dropMetaData_ = DropNone;
69  else if(dropMetaData == std::string("NONE")) dropMetaData_ = DropNone;
70  else if(dropMetaData == std::string("DROPPED")) dropMetaData_ = DropDroppedPrior;
71  else if(dropMetaData == std::string("PRIOR")) dropMetaData_ = DropPrior;
72  else if(dropMetaData == std::string("ALL")) dropMetaData_ = DropAll;
73  else {
74  throw edm::Exception(errors::Configuration, "Illegal dropMetaData parameter value: ")
75  << dropMetaData << ".\n"
76  << "Legal values are 'NONE', 'DROPPED', 'PRIOR', and 'ALL'.\n";
77  }
78 
79  if (!wantAllEvents()) {
81  }
82 
83  // We don't use this next parameter, but we read it anyway because it is part
84  // of the configuration of this module. An external parser creates the
85  // configuration by reading this source code.
86  pset.getUntrackedParameterSet("dataset");
87  }
std::string const compressionAlgorithm_
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
std::string const catalog_
DropMetaData const & dropMetaData() const
BranchChildren branchChildren_
std::string const moduleLabel_
OutputItemListArray selectedOutputItemList_
BranchParents branchParents_
unsigned int numberOfDigitsInIndex_
OutputModuleBase(ParameterSet const &pset)
unsigned int const maxFileSize_
std::string const fileName_
std::string const logicalFileName_
RootServiceChecker rootServiceChecker_
edm::PoolOutputModule::~PoolOutputModule ( )
virtual

Definition at line 230 of file PoolOutputModule.cc.

230  {
231  }
edm::PoolOutputModule::PoolOutputModule ( PoolOutputModule const &  )
delete

Member Function Documentation

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

Definition at line 70 of file PoolOutputModule.h.

References auxItems_.

70 {return auxItems_;}
std::string const& edm::PoolOutputModule::basketOrder ( ) const
inline

Definition at line 47 of file PoolOutputModule.h.

References basketOrder_.

47 {return basketOrder_;}
int const& edm::PoolOutputModule::basketSize ( ) const
inline

Definition at line 44 of file PoolOutputModule.h.

References basketSize_.

Referenced by fillSelectedItemList().

44 {return basketSize_;}
void edm::PoolOutputModule::beginInputFile ( FileBlock const &  fb)
private

Definition at line 187 of file PoolOutputModule.cc.

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

Referenced by openFile(), and respondToOpenInputFile().

187  {
188  if(isFileOpen()) {
189  rootOutputFile_->beginInputFile(fb, remainingEvents());
190  }
191  }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
virtual bool isFileOpen() const override
void edm::PoolOutputModule::beginJob ( void  )
overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 89 of file PoolOutputModule.cc.

89  {
90  }
BranchChildren const& edm::PoolOutputModule::branchChildren ( ) const
inline

Definition at line 107 of file PoolOutputModule.h.

References branchChildren_.

107 {return branchChildren_;}
BranchChildren branchChildren_
std::string const& edm::PoolOutputModule::catalog ( ) const
inline

Definition at line 51 of file PoolOutputModule.h.

References catalog_.

51 {return catalog_;}
std::string const catalog_
std::string const& edm::PoolOutputModule::compressionAlgorithm ( ) const
inline

Definition at line 43 of file PoolOutputModule.h.

References compressionAlgorithm_.

43 {return compressionAlgorithm_;}
std::string const compressionAlgorithm_
int const& edm::PoolOutputModule::compressionLevel ( ) const
inline

Definition at line 42 of file PoolOutputModule.h.

References compressionLevel_.

42 {return compressionLevel_;}
std::string const & edm::PoolOutputModule::currentFileName ( ) const

Definition at line 92 of file PoolOutputModule.cc.

References rootOutputFile_.

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

92  {
93  return rootOutputFile_->fileName();
94  }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::doExtrasAfterCloseFile ( )
protectedvirtual

Reimplemented in dqmservices::JsonWritingTimeoutPoolOutputModule.

Definition at line 286 of file PoolOutputModule.cc.

Referenced by reallyCloseFile().

286 {}
DropMetaData const& edm::PoolOutputModule::dropMetaData ( ) const
inline

Definition at line 50 of file PoolOutputModule.h.

References dropMetaData_.

Referenced by PoolOutputModule().

50 {return dropMetaData_;}
int edm::PoolOutputModule::eventAutoFlushSize ( ) const
inline

Definition at line 45 of file PoolOutputModule.h.

References eventAutoFlushSize_.

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

45 {return eventAutoFlushSize_;}
std::string const& edm::PoolOutputModule::fileName ( ) const
inline

Definition at line 40 of file PoolOutputModule.h.

References fileName_.

Referenced by physicalAndLogicalNameForNewFile().

40 {return fileName_;}
std::string const fileName_
void edm::PoolOutputModule::fillDependencyGraph ( )
private

Definition at line 349 of file PoolOutputModule.cc.

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

Referenced by reallyCloseFile().

349  {
350  for(auto const& branchParent : branchParents_) {
351  BranchID const& child = branchParent.first;
352  std::set<ParentageID> const& eIds = branchParent.second;
353  for(auto const& eId : eIds) {
354  Parentage entryDesc;
355  ParentageRegistry::instance()->getMapped(eId, entryDesc);
356  std::vector<BranchID> const& parents = entryDesc.parents();
357  for(auto const& parent : parents) {
359  }
360  }
361  }
362  }
TPRegexp parents
Definition: eve_filter.cc:21
BranchChildren branchChildren_
void insertChild(BranchID parent, BranchID child)
bool getMapped(key_type const &k, value_type &result) const
BranchParents branchParents_
static ParentageRegistry * instance()
void edm::PoolOutputModule::fillDescription ( ParameterSetDescription desc)
static

Definition at line 365 of file PoolOutputModule.cc.

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

Referenced by fillDescriptions().

365  {
366  std::string defaultString;
367 
368  desc.setComment("Writes runs, lumis, and events into EDM/ROOT files.");
369  desc.addUntracked<std::string>("fileName")
370  ->setComment("Name of output file.");
371  desc.addUntracked<std::string>("logicalFileName", defaultString)
372  ->setComment("Passed to job report. Otherwise unused by module.");
373  desc.addUntracked<std::string>("catalog", defaultString)
374  ->setComment("Passed to job report. Otherwise unused by module.");
375  desc.addUntracked<int>("maxSize", 0x7f000000)
376  ->setComment("Maximum output file size, in kB.\n"
377  "If over maximum, new output file will be started at next input file transition.");
378  desc.addUntracked<int>("compressionLevel", 7)
379  ->setComment("ROOT compression level of output file.");
380  desc.addUntracked<std::string>("compressionAlgorithm", "ZLIB")
381  ->setComment("Algorithm used to compress data in the ROOT output file, allowed values are ZLIB and LZMA");
382  desc.addUntracked<int>("basketSize", 16384)
383  ->setComment("Default ROOT basket size in output file.");
384  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.");
385  desc.addUntracked<int>("splitLevel", 99)
386  ->setComment("Default ROOT branch split level in output file.");
387  desc.addUntracked<std::string>("sortBaskets", std::string("sortbasketsbyoffset"))
388  ->setComment("Legal values: 'sortbasketsbyoffset', 'sortbasketsbybranch', 'sortbasketsbyentry'.\n"
389  "Used by ROOT when fast copying. Affects performance.");
390  desc.addUntracked<int>("treeMaxVirtualSize", -1)
391  ->setComment("Size of ROOT TTree TBasket cache. Affects performance.");
392  desc.addUntracked<bool>("fastCloning", true)
393  ->setComment("True: Allow fast copying, if possible.\n"
394  "False: Disable fast copying.");
395  desc.addUntracked<bool>("overrideInputFileSplitLevels", false)
396  ->setComment("False: Use branch split levels and basket sizes from input file, if possible.\n"
397  "True: Always use specified or default split levels and basket sizes.");
398  desc.addUntracked<bool>("writeStatusFile", false)
399  ->setComment("Write a status file. Intended for use by workflow management.");
400  desc.addUntracked<std::string>("dropMetaData", defaultString)
401  ->setComment("Determines handling of per product per event metadata. Options are:\n"
402  "'NONE': Keep all of it.\n"
403  "'DROPPED': Keep it for products produced in current process and all kept products. Drop it for dropped products produced in prior processes.\n"
404  "'PRIOR': Keep it for products produced in current process. Drop it for products produced in prior processes.\n"
405  "'ALL': Drop all of it.");
406  ParameterSetDescription dataSet;
407  dataSet.setAllowAnything();
408  desc.addUntracked<ParameterSetDescription>("dataset", dataSet)
409  ->setComment("PSet is only used by Data Operations and not by this module.");
410 
412  }
static void fillDescription(ParameterSetDescription &desc, std::vector< std::string > const &iDefaultOutputCommands=ProductSelectorRules::defaultSelectionStrings())
void edm::PoolOutputModule::fillDescriptions ( ConfigurationDescriptions descriptions)
static

Definition at line 415 of file PoolOutputModule.cc.

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

415  {
418  descriptions.add("edmOutput", desc);
419  }
static void fillDescription(ParameterSetDescription &desc)
void edm::PoolOutputModule::fillSelectedItemList ( BranchType  branchtype,
TTree *  theInputTree 
)
private

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

146  {
147 
148  SelectedProducts const& keptVector = keptProducts()[branchType];
150  AuxItem& auxItem = auxItems_[branchType];
151 
152  // Fill AuxItem
153  if (theInputTree != nullptr && !overrideInputFileSplitLevels_) {
154  TBranch* auxBranch = theInputTree->GetBranch(BranchTypeToAuxiliaryBranchName(branchType).c_str());
155  if (auxBranch) {
156  auxItem.basketSize_ = auxBranch->GetBasketSize();
157  } else {
158  auxItem.basketSize_ = basketSize_;
159  }
160  } else {
161  auxItem.basketSize_ = basketSize_;
162  }
163 
164  // Fill outputItemList with an entry for each branch.
165  for(auto const& kept : keptVector) {
168 
169  BranchDescription const& prod = *kept.first;
170  TBranch* theBranch = ((!prod.produced() && theInputTree != nullptr && !overrideInputFileSplitLevels_) ? theInputTree->GetBranch(prod.branchName().c_str()) : 0);
171 
172  if(theBranch != nullptr) {
173  splitLevel = theBranch->GetSplitLevel();
174  basketSize = theBranch->GetBasketSize();
175  } else {
176  splitLevel = (prod.splitLevel() == BranchDescription::invalidSplitLevel ? splitLevel_ : prod.splitLevel());
177  basketSize = (prod.basketSize() == BranchDescription::invalidBasketSize ? basketSize_ : prod.basketSize());
178  }
179  outputItemList.emplace_back(&prod, kept.second, splitLevel, basketSize);
180  }
181 
182  // Sort outputItemList to allow fast copying.
183  // The branches in outputItemList must be in the same order as in the input tree, with all new branches at the end.
184  sort_all(outputItemList, OutputItem::Sorter(theInputTree));
185  }
std::string const & BranchTypeToAuxiliaryBranchName(BranchType const &branchType)
Definition: BranchType.cc:115
int const & basketSize() const
static int const invalidSplitLevel
static int const invalidBasketSize
std::vector< OutputItem > OutputItemList
std::vector< std::pair< BranchDescription const *, EDGetToken > > SelectedProducts
OutputItemListArray selectedOutputItemList_
SelectedProductsForBranchType const & keptProducts() const
int const & splitLevel() const
void sort_all(RandomAccessSequence &s)
wrappers for std::sort
Definition: Algorithms.h:120
void edm::PoolOutputModule::finishEndFile ( )
private

Definition at line 285 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

285 { rootOutputFile_->finishEndFile(); rootOutputFile_ = nullptr; } // propagate_const<T> has no reset() function
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
int const& edm::PoolOutputModule::inputFileCount ( ) const
inline

Definition at line 54 of file PoolOutputModule.h.

References inputFileCount_.

bool edm::PoolOutputModule::isFileOpen ( ) const
overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 287 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by beginInputFile(), and openFile().

287 { return rootOutputFile_.get() != nullptr; }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
std::string const& edm::PoolOutputModule::logicalFileName ( ) const
inline

Definition at line 41 of file PoolOutputModule.h.

References logicalFileName_.

Referenced by physicalAndLogicalNameForNewFile().

41 {return logicalFileName_;}
std::string const logicalFileName_
unsigned int const& edm::PoolOutputModule::maxFileSize ( ) const
inline

Definition at line 53 of file PoolOutputModule.h.

References maxFileSize_.

53 {return maxFileSize_;}
unsigned int const maxFileSize_
std::string const& edm::PoolOutputModule::moduleLabel ( ) const
inline

Definition at line 52 of file PoolOutputModule.h.

References moduleLabel_.

52 {return moduleLabel_;}
std::string const moduleLabel_
void edm::PoolOutputModule::openFile ( FileBlock const &  fb)
overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 193 of file PoolOutputModule.cc.

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

193  {
194  if(!isFileOpen()) {
195  reallyOpenFile();
197  }
198  }
virtual void reallyOpenFile() override
virtual bool isFileOpen() const override
void beginInputFile(FileBlock const &fb)
PoolOutputModule& edm::PoolOutputModule::operator= ( PoolOutputModule const &  )
delete
bool const& edm::PoolOutputModule::overrideInputFileSplitLevels ( ) const
inline

Definition at line 49 of file PoolOutputModule.h.

References overrideInputFileSplitLevels_.

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

Reimplemented in dqmservices::JsonWritingTimeoutPoolOutputModule.

Definition at line 291 of file PoolOutputModule.cc.

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

Referenced by reallyOpenFile().

291  {
292  if(inputFileCount_ == 0) {
294  << "Attempt to open output file before input file. "
295  << "Please report this to the core framework developers.\n";
296  }
297  std::string suffix(".root");
299  bool ext = (offset == fileName().size() - suffix.size());
300  if(!ext) suffix.clear();
301  std::string fileBase(ext ? fileName().substr(0, offset) : fileName());
302  std::ostringstream ofilename;
303  std::ostringstream lfilename;
304  ofilename << fileBase;
305  lfilename << logicalFileName();
307  ofilename << '_' << std::setw(numberOfDigitsInIndex_) << std::setfill('0') << childIndex_;
308  if(!logicalFileName().empty()) {
309  lfilename << '_' << std::setw(numberOfDigitsInIndex_) << std::setfill('0') << childIndex_;
310  }
311  }
312  if(outputFileCount_) {
313  ofilename << std::setw(3) << std::setfill('0') << outputFileCount_;
314  if(!logicalFileName().empty()) {
315  lfilename << std::setw(3) << std::setfill('0') << outputFileCount_;
316  }
317  }
318  ofilename << suffix;
320 
321  return std::make_pair(ofilename.str(), lfilename.str());
322  }
std::string const & fileName() const
uint16_t size_type
std::string const & logicalFileName() const
unsigned int numberOfDigitsInIndex_
void edm::PoolOutputModule::postForkReacquireResources ( unsigned int  iChildIndex,
unsigned int  iNumberOfChildren 
)
overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 219 of file PoolOutputModule.cc.

References childIndex_, and numberOfDigitsInIndex_.

219  {
220  childIndex_ = iChildIndex;
221  while (iNumberOfChildren != 0) {
223  iNumberOfChildren /= 10;
224  }
225  if (numberOfDigitsInIndex_ == 0) {
226  numberOfDigitsInIndex_ = 3; // Protect against zero iNumberOfChildren
227  }
228  }
unsigned int numberOfDigitsInIndex_
void edm::PoolOutputModule::reallyCloseFile ( )
overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 251 of file PoolOutputModule.cc.

References branchChildren_, branchParents_, edm::BranchChildren::clear(), doExtrasAfterCloseFile(), fillDependencyGraph(), finishEndFile(), startEndFile(), writeBranchIDListRegistry(), writeFileFormatVersion(), writeFileIdentifier(), writeIndexIntoFile(), writeParameterSetRegistry(), writeParentageRegistry(), writeProcessHistoryRegistry(), writeProductDependencies(), writeProductDescriptionRegistry(), and writeThinnedAssociationsHelper().

251  {
253  branchParents_.clear();
255  startEndFile();
266  finishEndFile();
267 
269  }
BranchChildren branchChildren_
virtual void doExtrasAfterCloseFile()
BranchParents branchParents_
void edm::PoolOutputModule::reallyOpenFile ( )
overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 324 of file PoolOutputModule.cc.

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

Referenced by openFile().

324  {
326  rootOutputFile_ = std::make_unique<RootOutputFile>(this, names.first, names.second); // propagate_const<T> has no reset() function
327  }
virtual std::pair< std::string, std::string > physicalAndLogicalNameForNewFile()
static const HistoName names[]
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::respondToCloseInputFile ( FileBlock const &  fb)
overrideprivatevirtual

Definition at line 215 of file PoolOutputModule.cc.

References rootOutputFile_.

215  {
216  if(rootOutputFile_) rootOutputFile_->respondToCloseInputFile(fb);
217  }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::respondToOpenInputFile ( FileBlock const &  fb)
overrideprivatevirtual

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

200  {
201  if(!initializedFromInput_) {
202  for(int i = InEvent; i < NumBranchTypes; ++i) {
203  BranchType branchType = static_cast<BranchType>(i);
204  TTree* theInputTree = (branchType == InEvent ? fb.tree() :
205  (branchType == InLumi ? fb.lumiTree() :
206  fb.runTree()));
207  fillSelectedItemList(branchType, theInputTree);
208  }
209  initializedFromInput_ = true;
210  }
211  ++inputFileCount_;
213  }
int i
Definition: DBlmapReader.cc:9
BranchType
Definition: BranchType.h:11
void fillSelectedItemList(BranchType branchtype, TTree *theInputTree)
void beginInputFile(FileBlock const &fb)
OutputItemListArray const& edm::PoolOutputModule::selectedOutputItemList ( ) const
inline

Definition at line 105 of file PoolOutputModule.h.

References selectedOutputItemList_.

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

105 {return selectedOutputItemList_;}
OutputItemListArray selectedOutputItemList_
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 288 of file PoolOutputModule.cc.

References rootOutputFile_.

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

288 { return rootOutputFile_->shouldWeCloseFile(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
int const& edm::PoolOutputModule::splitLevel ( ) const
inline

Definition at line 46 of file PoolOutputModule.h.

References splitLevel_.

Referenced by fillSelectedItemList().

46 {return splitLevel_;}
void edm::PoolOutputModule::startEndFile ( )
private

Definition at line 273 of file PoolOutputModule.cc.

Referenced by reallyCloseFile().

273 { }
int const& edm::PoolOutputModule::treeMaxVirtualSize ( ) const
inline

Definition at line 48 of file PoolOutputModule.h.

References treeMaxVirtualSize_.

48 {return treeMaxVirtualSize_;}
void edm::PoolOutputModule::updateBranchParents ( EventForOutput const &  e)
private

Definition at line 330 of file PoolOutputModule.cc.

References branchChildren_, edm::BranchDescription::branchID(), edm::ProductProvenanceRetriever::branchIDToProvenance(), branchParents_, edm::InEvent, edm::BranchChildren::insertEmpty(), edm::one::OutputModuleBase::keptProducts(), edm::ProductProvenance::parentageID(), edm::EventForOutput::productProvenanceRetrieverPtr(), and edm::es::products().

Referenced by write().

330  {
331  ProductProvenanceRetriever const* provRetriever = e.productProvenanceRetrieverPtr();
333  for(auto const& product : products) {
334  BranchDescription const& bd = *product.first;
335  BranchID const& bid = bd.branchID();
336  ProductProvenance const* provenance = provRetriever->branchIDToProvenance(bid);
337  if(provenance != nullptr) {
338  BranchParents::iterator it = branchParents_.find(bid);
339  if(it == branchParents_.end()) {
340  it = branchParents_.insert(std::make_pair(bid, std::set<ParentageID>())).first;
341  }
342  it->second.insert(provenance->parentageID());
344  }
345  }
346  }
BranchChildren branchChildren_
void insertEmpty(BranchID parent)
std::vector< std::pair< BranchDescription const *, EDGetToken > > SelectedProducts
ESProducts< T, S > products(const T &i1, const S &i2)
Definition: ESProducts.h:189
SelectedProductsForBranchType const & keptProducts() const
BranchParents branchParents_
int const& edm::PoolOutputModule::whyNotFastClonable ( ) const
inline

Definition at line 55 of file PoolOutputModule.h.

References whyNotFastClonable_.

void edm::PoolOutputModule::write ( EventForOutput const &  e)
overrideprotectedvirtual

Implements edm::one::OutputModuleBase.

Reimplemented in edm::TimeoutPoolOutputModule.

Definition at line 233 of file PoolOutputModule.cc.

References edm::EventForOutput::id(), rootOutputFile_, statusFileName_, and updateBranchParents().

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

233  {
235  rootOutputFile_->writeOne(e);
236  if (!statusFileName_.empty()) {
237  std::ofstream statusFile(statusFileName_.c_str());
238  statusFile << e.id() << " time: " << std::setprecision(3) << TimeOfDay() << '\n';
239  statusFile.close();
240  }
241  }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void updateBranchParents(EventForOutput const &e)
void edm::PoolOutputModule::writeBranchIDListRegistry ( )
private

Definition at line 282 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

282 { rootOutputFile_->writeBranchIDListRegistry(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeFileFormatVersion ( )
private

Definition at line 275 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

275 { rootOutputFile_->writeFileFormatVersion(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeFileIdentifier ( )
private

Definition at line 276 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

276 { rootOutputFile_->writeFileIdentifier(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeIndexIntoFile ( )
private

Definition at line 277 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

277 { rootOutputFile_->writeIndexIntoFile(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeLuminosityBlock ( LuminosityBlockForOutput const &  lb)
overrideprivatevirtual

Implements edm::one::OutputModuleBase.

Definition at line 243 of file PoolOutputModule.cc.

References rootOutputFile_.

243  {
244  rootOutputFile_->writeLuminosityBlock(lb);
245  }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeParameterSetRegistry ( )
private

Definition at line 279 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

279 { rootOutputFile_->writeParameterSetRegistry(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeParentageRegistry ( )
private

Definition at line 281 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

281 { rootOutputFile_->writeParentageRegistry(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeProcessHistoryRegistry ( )
private

Definition at line 278 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

278 { rootOutputFile_->writeProcessHistoryRegistry(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeProductDependencies ( )
private

Definition at line 284 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

284 { rootOutputFile_->writeProductDependencies(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeProductDescriptionRegistry ( )
private

Definition at line 280 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

280 { rootOutputFile_->writeProductDescriptionRegistry(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeRun ( RunForOutput const &  r)
overrideprivatevirtual

Implements edm::one::OutputModuleBase.

Definition at line 247 of file PoolOutputModule.cc.

References rootOutputFile_.

247  {
248  rootOutputFile_->writeRun(r);
249  }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_
void edm::PoolOutputModule::writeThinnedAssociationsHelper ( )
private

Definition at line 283 of file PoolOutputModule.cc.

References rootOutputFile_.

Referenced by reallyCloseFile().

283 { rootOutputFile_->writeThinnedAssociationsHelper(); }
edm::propagate_const< std::unique_ptr< RootOutputFile > > rootOutputFile_

Member Data Documentation

AuxItemArray edm::PoolOutputModule::auxItems_
private

Definition at line 149 of file PoolOutputModule.h.

Referenced by auxItems(), and fillSelectedItemList().

std::string edm::PoolOutputModule::basketOrder_
private

Definition at line 160 of file PoolOutputModule.h.

Referenced by basketOrder().

int const edm::PoolOutputModule::basketSize_
private

Definition at line 157 of file PoolOutputModule.h.

Referenced by basketSize().

BranchChildren edm::PoolOutputModule::branchChildren_
private
BranchParents edm::PoolOutputModule::branchParents_
private

Definition at line 170 of file PoolOutputModule.h.

Referenced by fillDependencyGraph(), reallyCloseFile(), and updateBranchParents().

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

Definition at line 153 of file PoolOutputModule.h.

Referenced by catalog().

unsigned int edm::PoolOutputModule::childIndex_
private
std::string const edm::PoolOutputModule::compressionAlgorithm_
private

Definition at line 156 of file PoolOutputModule.h.

Referenced by compressionAlgorithm().

int const edm::PoolOutputModule::compressionLevel_
private

Definition at line 155 of file PoolOutputModule.h.

Referenced by compressionLevel().

DropMetaData edm::PoolOutputModule::dropMetaData_
private

Definition at line 163 of file PoolOutputModule.h.

Referenced by dropMetaData(), and PoolOutputModule().

int const edm::PoolOutputModule::eventAutoFlushSize_
private

Definition at line 158 of file PoolOutputModule.h.

Referenced by eventAutoFlushSize().

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

Definition at line 151 of file PoolOutputModule.h.

Referenced by fileName().

bool edm::PoolOutputModule::initializedFromInput_
private

Definition at line 165 of file PoolOutputModule.h.

Referenced by respondToOpenInputFile().

int edm::PoolOutputModule::inputFileCount_
private
std::string const edm::PoolOutputModule::logicalFileName_
private

Definition at line 152 of file PoolOutputModule.h.

Referenced by logicalFileName().

unsigned int const edm::PoolOutputModule::maxFileSize_
private

Definition at line 154 of file PoolOutputModule.h.

Referenced by maxFileSize().

std::string const edm::PoolOutputModule::moduleLabel_
private
unsigned int edm::PoolOutputModule::numberOfDigitsInIndex_
private
int edm::PoolOutputModule::outputFileCount_
private

Definition at line 166 of file PoolOutputModule.h.

Referenced by physicalAndLogicalNameForNewFile().

bool edm::PoolOutputModule::overrideInputFileSplitLevels_
private

Definition at line 172 of file PoolOutputModule.h.

Referenced by fillSelectedItemList(), and overrideInputFileSplitLevels().

edm::propagate_const<std::unique_ptr<RootOutputFile> > edm::PoolOutputModule::rootOutputFile_
private
RootServiceChecker edm::PoolOutputModule::rootServiceChecker_
private

Definition at line 148 of file PoolOutputModule.h.

OutputItemListArray edm::PoolOutputModule::selectedOutputItemList_
private

Definition at line 150 of file PoolOutputModule.h.

Referenced by fillSelectedItemList(), and selectedOutputItemList().

int const edm::PoolOutputModule::splitLevel_
private

Definition at line 159 of file PoolOutputModule.h.

Referenced by splitLevel().

std::string edm::PoolOutputModule::statusFileName_
private

Definition at line 174 of file PoolOutputModule.h.

Referenced by PoolOutputModule(), and write().

int const edm::PoolOutputModule::treeMaxVirtualSize_
private

Definition at line 161 of file PoolOutputModule.h.

Referenced by treeMaxVirtualSize().

int edm::PoolOutputModule::whyNotFastClonable_
private

Definition at line 162 of file PoolOutputModule.h.

Referenced by PoolOutputModule(), and whyNotFastClonable().