#include <EmbeddedRootSource.h>

Inheritance diagram for edm::EmbeddedRootSource:

Public Member Functions
bool	bypassVersionCheck () const

	EmbeddedRootSource (ParameterSet const &pset, VectorInputSourceDescription const &desc)

unsigned int	nStreams () const

ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()

ProductRegistry &	productRegistryUpdate ()

ProductSelectorRules const &	productSelectorRules () const

RunHelperBase *	runHelper ()

bool	skipBadFiles () const

int	treeMaxVirtualSize () const

	~EmbeddedRootSource () override

Public Member Functions inherited from edm::VectorInputSource
void	doBeginJob ()
	Called at beginning of job. More...

void	doEndJob ()
	Called at end of job. More...

void	dropUnwantedBranches (std::vector< std::string > const &wantedBranches)

template<typename T >
size_t	loopOverEvents (EventPrincipal &cache, size_t &fileNameHash, size_t number, T eventOperator, CLHEP::HepRandomEngine =nullptr, EventID const id=nullptr, bool recycleFiles=true)

template<typename T , typename Iterator >
size_t	loopSpecified (EventPrincipal &cache, size_t &fileNameHash, Iterator const &begin, Iterator const &end, T eventOperator)

ProcessHistoryRegistry const &	processHistoryRegistry () const

ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()

std::shared_ptr< ProductRegistry > &	productRegistry ()

std::shared_ptr< ProductRegistry const >	productRegistry () const

ProductRegistry &	productRegistryUpdate ()

	VectorInputSource (ParameterSet const &pset, VectorInputSourceDescription const &desc)

virtual	~VectorInputSource ()

Static Public Member Functions
static void	fillDescriptions (ConfigurationDescriptions &descriptions)

Private Member Functions
void	beginJob () override

virtual void	closeFile_ ()

void	dropUnwantedBranches_ (std::vector< std::string > const &wantedBranches) override

void	endJob () override

bool	readOneEvent (EventPrincipal &cache, size_t &fileNameHash, CLHEP::HepRandomEngine , EventID const id, bool recycleFiles) override

void	readOneSpecified (EventPrincipal &cache, size_t &fileNameHash, SecondaryEventIDAndFileInfo const &id) override

Private Attributes
bool	bypassVersionCheck_

InputFileCatalog	catalog_

edm::propagate_const< std::unique_ptr< RootEmbeddedFileSequence > >	fileSequence_

unsigned int	nStreams_

ProductSelectorRules	productSelectorRules_

RootServiceChecker	rootServiceChecker_

std::unique_ptr< RunHelperBase >	runHelper_

bool	skipBadFiles_

const int	treeMaxVirtualSize_

Detailed Description

Definition at line 34 of file EmbeddedRootSource.h.

Constructor & Destructor Documentation

◆ EmbeddedRootSource()

edm::EmbeddedRootSource::EmbeddedRootSource	(	ParameterSet const &	pset,
		VectorInputSourceDescription const &	desc
	)

explicit

Definition at line 16 of file EmbeddedRootSource.cc.

       : VectorInputSource(pset, desc),
         rootServiceChecker_(),
         nStreams_(desc.allocations_->numberOfStreams()),
         // The default value provided as the second argument to the getUntrackedParameter function call
         // is not used when the ParameterSet has been validated and the parameters are not optional
         // in the description.  This is currently true when PoolSource is the primary input source.
         // The modules that use PoolSource as a SecSource have not defined their fillDescriptions function
         // yet, so the ParameterSet does not get validated yet.  As soon as all the modules with a SecSource
         // have defined descriptions, the defaults in the getUntrackedParameterSet function calls can
         // and should be deleted from the code.
         //
         skipBadFiles_(pset.getUntrackedParameter<bool>("skipBadFiles", false)),
         bypassVersionCheck_(pset.getUntrackedParameter<bool>("bypassVersionCheck", false)),
         treeMaxVirtualSize_(pset.getUntrackedParameter<int>("treeMaxVirtualSize", -1)),
         productSelectorRules_(pset, "inputCommands", "InputSource"),
         runHelper_(new DefaultRunHelper()),
         catalog_(pset.getUntrackedParameter<std::vector<std::string> >("fileNames"),
                  pset.getUntrackedParameter<std::string>("overrideCatalog", std::string())),
         // Note: fileSequence_ needs to be initialized last, because it uses data members
         // initialized previously in its own initialization.
         fileSequence_(new RootEmbeddedFileSequence(pset, *this, catalog_)) {}

◆ ~EmbeddedRootSource()

edm::EmbeddedRootSource::~EmbeddedRootSource ( )

override

Definition at line 39 of file EmbeddedRootSource.cc.

39 {}

Member Function Documentation

◆ beginJob()

void edm::EmbeddedRootSource::beginJob ( void )

overrideprivatevirtual

Implements edm::VectorInputSource.

Definition at line 41 of file EmbeddedRootSource.cc.

41 {}

◆ bypassVersionCheck()

bool edm::EmbeddedRootSource::bypassVersionCheck ( ) const

inline

Definition at line 43 of file EmbeddedRootSource.h.

43 { return bypassVersionCheck_; }

References bypassVersionCheck_.

Referenced by edm::RootEmbeddedFileSequence::makeRootFile().

◆ closeFile_()

void edm::EmbeddedRootSource::closeFile_ ( )

privatevirtual

Definition at line 48 of file EmbeddedRootSource.cc.

48 { fileSequence_->closeFile_(); }

References fileSequence_.

◆ dropUnwantedBranches_()

void edm::EmbeddedRootSource::dropUnwantedBranches_ ( std::vector< std::string > const & wantedBranches )

overrideprivatevirtual

Implements edm::VectorInputSource.

Definition at line 64 of file EmbeddedRootSource.cc.

                                                                                            {
     std::vector<std::string> rules;
     rules.reserve(wantedBranches.size() + 1);
     rules.emplace_back("drop *");
     for (std::string const& branch : wantedBranches) {
       rules.push_back("keep " + branch + "_*");
     }
     ParameterSet pset;
     pset.addUntrackedParameter("inputCommands", rules);
     productSelectorRules_ = ProductSelectorRules(pset, "inputCommands", "InputSource");
   }

References MicroEventContent_cff::branch, productSelectorRules_, muonDTDigis_cfi::pset, cmsCodeRulesChecker::rules, and AlCaHLTBitMon_QueryRunRegistry::string.

◆ endJob()

void edm::EmbeddedRootSource::endJob ( void )

overrideprivatevirtual

Implements edm::VectorInputSource.

Definition at line 43 of file EmbeddedRootSource.cc.

                                   {
     fileSequence_->endJob();
     InputFile::reportReadBranches();
   }

References fileSequence_, and edm::InputFile::reportReadBranches().

◆ fillDescriptions()

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

static

Definition at line 76 of file EmbeddedRootSource.cc.

                                                                                    {
     ParameterSetDescription desc;
  
     std::vector<std::string> defaultStrings;
     desc.setComment("Reads EDM/Root files for mixing.");
     desc.addUntracked<std::vector<std::string> >("fileNames")->setComment("Names of files to be processed.");
     desc.addUntracked<std::string>("overrideCatalog", std::string());
     desc.addUntracked<bool>("skipBadFiles", false)
         ->setComment(
             "True:  Ignore any missing or unopenable input file.\n"
             "False: Throw exception if missing or unopenable input file.");
     desc.addUntracked<bool>("bypassVersionCheck", false)
         ->setComment(
             "True:  Bypass release version check.\n"
             "False: Throw exception if reading file in a release prior to the release in which the file was written.");
     desc.addUntracked<int>("treeMaxVirtualSize", -1)
         ->setComment("Size of ROOT TTree TBasket cache.  Affects performance.");
  
     ProductSelectorRules::fillDescription(desc, "inputCommands");
     RootEmbeddedFileSequence::fillDescription(desc);
  
     descriptions.add("source", desc);
   }

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), edm::ProductSelectorRules::fillDescription(), edm::RootEmbeddedFileSequence::fillDescription(), edm::ParameterSetDescription::setComment(), and AlCaHLTBitMon_QueryRunRegistry::string.

◆ nStreams()

unsigned int edm::EmbeddedRootSource::nStreams ( ) const

inline

Definition at line 44 of file EmbeddedRootSource.h.

44 { return nStreams_; }

References nStreams_.

Referenced by edm::RootEmbeddedFileSequence::makeRootFile().

◆ processHistoryRegistryForUpdate()

ProcessHistoryRegistry& edm::VectorInputSource::processHistoryRegistryForUpdate

inline

Definition at line 57 of file VectorInputSource.h.

57 { return *processHistoryRegistry_; }

Referenced by edm::RootEmbeddedFileSequence::makeRootFile().

◆ productRegistryUpdate()

ProductRegistry& edm::VectorInputSource::productRegistryUpdate

inline

Definition at line 55 of file VectorInputSource.h.

55 { return *productRegistry_; }

Referenced by edm::RootEmbeddedFileSequence::RootEmbeddedFileSequence().

◆ productSelectorRules()

ProductSelectorRules const& edm::EmbeddedRootSource::productSelectorRules ( ) const

inline

Definition at line 46 of file EmbeddedRootSource.h.

46 { return productSelectorRules_; }

References productSelectorRules_.

Referenced by edm::RootEmbeddedFileSequence::makeRootFile().

◆ readOneEvent()

bool edm::EmbeddedRootSource::readOneEvent	(	EventPrincipal &	cache,
		size_t &	fileNameHash,
		CLHEP::HepRandomEngine *	engine,
		EventID const *	id,
		bool	recycleFiles
	)

overrideprivatevirtual

Implements edm::VectorInputSource.

Definition at line 50 of file EmbeddedRootSource.cc.

                                                            {
     return fileSequence_->readOneEvent(cache, fileNameHash, engine, id, recycleFiles);
   }

References utilities::cache(), and fileSequence_.

◆ readOneSpecified()

void edm::EmbeddedRootSource::readOneSpecified	(	EventPrincipal &	cache,
		size_t &	fileNameHash,
		SecondaryEventIDAndFileInfo const &	id
	)

overrideprivatevirtual

Implements edm::VectorInputSource.

Definition at line 58 of file EmbeddedRootSource.cc.

                                                                                    {
     fileSequence_->readOneSpecified(cache, fileNameHash, id);
   }

References utilities::cache(), and fileSequence_.

◆ runHelper()

RunHelperBase* edm::EmbeddedRootSource::runHelper ( )

inline

Definition at line 47 of file EmbeddedRootSource.h.

47 { return runHelper_.get(); }

References runHelper_.

Referenced by edm::RootEmbeddedFileSequence::makeRootFile().

◆ skipBadFiles()

bool edm::EmbeddedRootSource::skipBadFiles ( ) const

inline

Definition at line 42 of file EmbeddedRootSource.h.

42 { return skipBadFiles_; }

References skipBadFiles_.

Referenced by edm::RootEmbeddedFileSequence::RootEmbeddedFileSequence().

◆ treeMaxVirtualSize()

int edm::EmbeddedRootSource::treeMaxVirtualSize ( ) const

inline

Definition at line 45 of file EmbeddedRootSource.h.

45 { return treeMaxVirtualSize_; }

References treeMaxVirtualSize_.

Referenced by edm::RootEmbeddedFileSequence::makeRootFile().

Member Data Documentation

◆ bypassVersionCheck_

bool edm::EmbeddedRootSource::bypassVersionCheck_

private

Definition at line 67 of file EmbeddedRootSource.h.

Referenced by bypassVersionCheck().

◆ catalog_

InputFileCatalog edm::EmbeddedRootSource::catalog_

private

Definition at line 72 of file EmbeddedRootSource.h.

◆ fileSequence_

edm::propagate_const<std::unique_ptr<RootEmbeddedFileSequence> > edm::EmbeddedRootSource::fileSequence_

private

Definition at line 73 of file EmbeddedRootSource.h.

Referenced by closeFile_(), endJob(), readOneEvent(), and readOneSpecified().

◆ nStreams_

unsigned int edm::EmbeddedRootSource::nStreams_

private

Definition at line 65 of file EmbeddedRootSource.h.

Referenced by nStreams().

◆ productSelectorRules_

ProductSelectorRules edm::EmbeddedRootSource::productSelectorRules_

private

Definition at line 69 of file EmbeddedRootSource.h.

Referenced by dropUnwantedBranches_(), and productSelectorRules().

◆ rootServiceChecker_

RootServiceChecker edm::EmbeddedRootSource::rootServiceChecker_

private

Definition at line 63 of file EmbeddedRootSource.h.

◆ runHelper_

std::unique_ptr<RunHelperBase> edm::EmbeddedRootSource::runHelper_

private

Definition at line 70 of file EmbeddedRootSource.h.

Referenced by runHelper().

◆ skipBadFiles_

bool edm::EmbeddedRootSource::skipBadFiles_

private

Definition at line 66 of file EmbeddedRootSource.h.

Referenced by skipBadFiles().

◆ treeMaxVirtualSize_

const int edm::EmbeddedRootSource::treeMaxVirtualSize_

private

Definition at line 68 of file EmbeddedRootSource.h.

Referenced by treeMaxVirtualSize().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EmbeddedRootSource()

◆ ~EmbeddedRootSource()

Member Function Documentation

◆ beginJob()

◆ bypassVersionCheck()

◆ closeFile_()

◆ dropUnwantedBranches_()

◆ endJob()

◆ fillDescriptions()

◆ nStreams()

◆ processHistoryRegistryForUpdate()

◆ productRegistryUpdate()

◆ productSelectorRules()

◆ readOneEvent()

◆ readOneSpecified()

◆ runHelper()

◆ skipBadFiles()

◆ treeMaxVirtualSize()

Member Data Documentation

◆ bypassVersionCheck_

◆ catalog_

◆ fileSequence_

◆ nStreams_

◆ productSelectorRules_

◆ rootServiceChecker_

◆ runHelper_

◆ skipBadFiles_

◆ treeMaxVirtualSize_