edm::PoolOutputModule Class Reference

#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 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
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
BranchIDLists const *	branchIDLists ()
std::array< bool, NumBranchTypes > const &	hasNewlyDroppedBranch () const
SelectedProductsForBranchType const &	keptProducts () const
int	maxEvents () const
const ModuleDescription &	moduleDescription () const
OutputModuleBase &	operator= (OutputModuleBase const &)=delete
	OutputModuleBase (ParameterSet const &pset)
	OutputModuleBase (OutputModuleBase const &)=delete
std::string const &	processName () const
int	remainingEvents () const
bool	selected (BranchDescription const &desc) const
void	selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &)
ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const
bool	wantAllEvents () const
virtual	~OutputModuleBase ()
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
	EDConsumerBase ()
ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const
std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesDependentUpon (std::string const &iProcessName, std::string const &iModuleLabel, bool iPrint, std::vector< char const * > &oModuleLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)
virtual	~EDConsumerBase ()

Static Public Member Functions
static 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 ()
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 (EventPrincipal const &ep)
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
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 32 of file PoolOutputModule.h.

Member Typedef Documentation

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

Definition at line 68 of file PoolOutputModule.h.

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

private

Definition at line 126 of file PoolOutputModule.h.

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

Definition at line 99 of file PoolOutputModule.h.

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

Definition at line 101 of file PoolOutputModule.h.

Member Enumeration Documentation

enum edm::PoolOutputModule::DropMetaData

Enumerator
DropNone
DropDroppedPrior
DropPrior
DropAll

Definition at line 34 of file PoolOutputModule.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 31 of file PoolOutputModule.cc.

edm::PoolOutputModule::~PoolOutputModule ( )

virtual

Definition at line 229 of file PoolOutputModule.cc.

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

delete

Member Function Documentation

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

inline

Definition at line 69 of file PoolOutputModule.h.

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

inline

Definition at line 46 of file PoolOutputModule.h.

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

inline

Definition at line 43 of file PoolOutputModule.h.

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

private

Definition at line 186 of file PoolOutputModule.cc.

void edm::PoolOutputModule::beginJob ( void  )

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 90 of file PoolOutputModule.cc.

BranchChildren const& edm::PoolOutputModule::branchChildren ( ) const

inline

Definition at line 105 of file PoolOutputModule.h.

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

inline

Definition at line 50 of file PoolOutputModule.h.

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

inline

Definition at line 42 of file PoolOutputModule.h.

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

inline

Definition at line 41 of file PoolOutputModule.h.

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

(

)

const

Definition at line 93 of file PoolOutputModule.cc.

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

void edm::PoolOutputModule::doExtrasAfterCloseFile ( )

protectedvirtual

Reimplemented in dqmservices::JsonWritingTimeoutPoolOutputModule.

Definition at line 285 of file PoolOutputModule.cc.

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

inline

Definition at line 49 of file PoolOutputModule.h.

int edm::PoolOutputModule::eventAutoFlushSize ( ) const

inline

Definition at line 44 of file PoolOutputModule.h.

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

inline

Definition at line 39 of file PoolOutputModule.h.

void edm::PoolOutputModule::fillDependencyGraph ( )

private

Definition at line 344 of file PoolOutputModule.cc.

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

static

Definition at line 363 of file PoolOutputModule.cc.

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

static

Definition at line 413 of file PoolOutputModule.cc.

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

private

Definition at line 145 of file PoolOutputModule.cc.

void edm::PoolOutputModule::finishEndFile ( )

private

Definition at line 284 of file PoolOutputModule.cc.

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

inline

Definition at line 53 of file PoolOutputModule.h.

bool edm::PoolOutputModule::isFileOpen ( ) const

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 286 of file PoolOutputModule.cc.

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

inline

Definition at line 40 of file PoolOutputModule.h.

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

inline

Definition at line 52 of file PoolOutputModule.h.

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

inline

Definition at line 51 of file PoolOutputModule.h.

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

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 192 of file PoolOutputModule.cc.

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

delete

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

inline

Definition at line 48 of file PoolOutputModule.h.

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

protectedvirtual

Reimplemented in dqmservices::JsonWritingTimeoutPoolOutputModule.

Definition at line 290 of file PoolOutputModule.cc.

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

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 218 of file PoolOutputModule.cc.

void edm::PoolOutputModule::reallyCloseFile ( )

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 250 of file PoolOutputModule.cc.

void edm::PoolOutputModule::reallyOpenFile ( )

overrideprivatevirtual

Reimplemented from edm::one::OutputModuleBase.

Definition at line 323 of file PoolOutputModule.cc.

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

overrideprivatevirtual

Definition at line 214 of file PoolOutputModule.cc.

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

overrideprivatevirtual

Definition at line 199 of file PoolOutputModule.cc.

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

inline

Definition at line 103 of file PoolOutputModule.h.

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 287 of file PoolOutputModule.cc.

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

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

inline

Definition at line 45 of file PoolOutputModule.h.

void edm::PoolOutputModule::startEndFile ( )

private

Definition at line 272 of file PoolOutputModule.cc.

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

inline

Definition at line 47 of file PoolOutputModule.h.

void edm::PoolOutputModule::updateBranchParents ( EventPrincipal const &  ep )

private

Definition at line 329 of file PoolOutputModule.cc.

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

inline

Definition at line 54 of file PoolOutputModule.h.

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

overrideprotectedvirtual

Implements edm::one::OutputModuleBase.

Reimplemented in edm::TimeoutPoolOutputModule.

Definition at line 232 of file PoolOutputModule.cc.

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

void edm::PoolOutputModule::writeBranchIDListRegistry ( )

private

Definition at line 281 of file PoolOutputModule.cc.

void edm::PoolOutputModule::writeFileFormatVersion ( )

private

Definition at line 274 of file PoolOutputModule.cc.

void edm::PoolOutputModule::writeFileIdentifier ( )

private

Definition at line 275 of file PoolOutputModule.cc.

void edm::PoolOutputModule::writeIndexIntoFile ( )

private

Definition at line 276 of file PoolOutputModule.cc.

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

overrideprivatevirtual

Implements edm::one::OutputModuleBase.

Definition at line 242 of file PoolOutputModule.cc.

void edm::PoolOutputModule::writeParameterSetRegistry ( )

private

Definition at line 278 of file PoolOutputModule.cc.

void edm::PoolOutputModule::writeParentageRegistry ( )

private

Definition at line 280 of file PoolOutputModule.cc.

void edm::PoolOutputModule::writeProcessHistoryRegistry ( )

private

Definition at line 277 of file PoolOutputModule.cc.

void edm::PoolOutputModule::writeProductDependencies ( )

private

Definition at line 283 of file PoolOutputModule.cc.

void edm::PoolOutputModule::writeProductDescriptionRegistry ( )

private

Definition at line 279 of file PoolOutputModule.cc.

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

overrideprivatevirtual

Implements edm::one::OutputModuleBase.

Definition at line 246 of file PoolOutputModule.cc.

void edm::PoolOutputModule::writeThinnedAssociationsHelper ( )

private

Definition at line 282 of file PoolOutputModule.cc.

Member Data Documentation

AuxItemArray edm::PoolOutputModule::auxItems_

private

Definition at line 147 of file PoolOutputModule.h.

std::string edm::PoolOutputModule::basketOrder_

private

Definition at line 158 of file PoolOutputModule.h.

int const edm::PoolOutputModule::basketSize_

private

Definition at line 155 of file PoolOutputModule.h.

BranchChildren edm::PoolOutputModule::branchChildren_

private

Definition at line 169 of file PoolOutputModule.h.

BranchParents edm::PoolOutputModule::branchParents_

private

Definition at line 168 of file PoolOutputModule.h.

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

private

Definition at line 151 of file PoolOutputModule.h.

unsigned int edm::PoolOutputModule::childIndex_

private

Definition at line 166 of file PoolOutputModule.h.

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

private

Definition at line 154 of file PoolOutputModule.h.

int const edm::PoolOutputModule::compressionLevel_

private

Definition at line 153 of file PoolOutputModule.h.

DropMetaData edm::PoolOutputModule::dropMetaData_

private

Definition at line 161 of file PoolOutputModule.h.

int const edm::PoolOutputModule::eventAutoFlushSize_

private

Definition at line 156 of file PoolOutputModule.h.

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

private

Definition at line 149 of file PoolOutputModule.h.

bool edm::PoolOutputModule::initializedFromInput_

private

Definition at line 163 of file PoolOutputModule.h.

int edm::PoolOutputModule::inputFileCount_

private

Definition at line 165 of file PoolOutputModule.h.

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

private

Definition at line 150 of file PoolOutputModule.h.

unsigned int const edm::PoolOutputModule::maxFileSize_

private

Definition at line 152 of file PoolOutputModule.h.

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

private

Definition at line 162 of file PoolOutputModule.h.

unsigned int edm::PoolOutputModule::numberOfDigitsInIndex_

private

Definition at line 167 of file PoolOutputModule.h.

int edm::PoolOutputModule::outputFileCount_

private

Definition at line 164 of file PoolOutputModule.h.

bool edm::PoolOutputModule::overrideInputFileSplitLevels_

private

Definition at line 170 of file PoolOutputModule.h.

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

private

Definition at line 171 of file PoolOutputModule.h.

RootServiceChecker edm::PoolOutputModule::rootServiceChecker_

private

Definition at line 146 of file PoolOutputModule.h.

OutputItemListArray edm::PoolOutputModule::selectedOutputItemList_

private

Definition at line 148 of file PoolOutputModule.h.

int const edm::PoolOutputModule::splitLevel_

private

Definition at line 157 of file PoolOutputModule.h.

std::string edm::PoolOutputModule::statusFileName_

private

Definition at line 172 of file PoolOutputModule.h.

int const edm::PoolOutputModule::treeMaxVirtualSize_

private

Definition at line 159 of file PoolOutputModule.h.

int edm::PoolOutputModule::whyNotFastClonable_

private

Definition at line 160 of file PoolOutputModule.h.