#include <JsonWritingTimeoutPoolOutputModule.h>

Inheritance diagram for dqmservices::JsonWritingTimeoutPoolOutputModule:

Public Member Functions
	JsonWritingTimeoutPoolOutputModule (edm::ParameterSet const &ps)

	~JsonWritingTimeoutPoolOutputModule () override

Public Member Functions inherited from edm::TimeoutPoolOutputModule
TimeoutPoolOutputModule &	operator= (TimeoutPoolOutputModule const &)=delete

	TimeoutPoolOutputModule (ParameterSet const &ps)

	TimeoutPoolOutputModule (TimeoutPoolOutputModule const &)=delete

	~TimeoutPoolOutputModule () override

Public Member Functions inherited from edm::PoolOutputModule
AuxItemArray const &	auxItems () const

std::string const &	basketOrder () const

int	basketSize () const

BranchChildren const &	branchChildren () const

std::string const &	catalog () const

bool	compactEventAuxiliary () const

std::string const &	compressionAlgorithm () const

int	compressionLevel () const

std::string const &	currentFileName () const

DropMetaData const &	dropMetaData () const

int	eventAutoFlushSize () const

int	eventAuxiliaryBasketSize () const

std::string const &	fileName () const

int	inputFileCount () const

std::string const &	logicalFileName () const

unsigned int	maxFileSize () const

std::string const &	moduleLabel () const

PoolOutputModule &	operator= (PoolOutputModule const &)=delete

bool	overrideInputFileSplitLevels () const

	PoolOutputModule (ParameterSet const &ps)

	PoolOutputModule (PoolOutputModule const &)=delete

std::vector< OutputItemList > &	selectedOutputItemList ()

std::vector< OutputItemList > const &	selectedOutputItemList () const

int	splitLevel () const

int	treeMaxVirtualSize () const

int	whyNotFastClonable () const

	~PoolOutputModule () override

Public Member Functions inherited from edm::one::OutputModule< WatchInputFiles >
SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

const OutputModule &	operator= (const OutputModule &)=delete

	OutputModule (const OutputModule &)=delete

	OutputModule (edm::ParameterSet const &iPSet)

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

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 (OutputModuleBase const &)=delete

	OutputModuleBase (ParameterSet const &pset)

OutputProcessBlockHelper const &	outputProcessBlockHelper () const

std::string const &	processName () const

int	remainingEvents () const

bool	selected (BranchDescription const &desc) const

void	selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &, ProcessBlockHelperBase const &)

SharedResourcesAcquirer &	sharedResourcesAcquirer ()

SubProcessParentageHelper const *	subProcessParentageHelper () const

ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const

bool	wantAllEvents () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () const

	~OutputModuleBase () override

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

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase &&)=default

	EDConsumerBase (EDConsumerBase const &)=delete

ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const

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 &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const * > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const > const &labelsToDesc, std::string const &processName) const

EDConsumerBase &	operator= (EDConsumerBase &&)=default

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &)

Static Public Member Functions inherited from edm::TimeoutPoolOutputModule
static void	fillDescriptions (ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::PoolOutputModule
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, std::vector< std::string > const &iDefaultOutputCommands=ProductSelectorRules::defaultSelectionStrings())

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Protected Member Functions
void	doExtrasAfterCloseFile () override

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

Protected Member Functions inherited from edm::TimeoutPoolOutputModule
bool	shouldWeCloseFile () const override
	allow inheriting classes to override but still be able to call this method in the overridden version More...

void	write (EventForOutput const &e) override

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

ModuleDescription const &	description () const

void	doAccessInputProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

void	doBeginJob ()

bool	doBeginLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)

void	doBeginProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

bool	doBeginRun (RunTransitionInfo const &, ModuleCallingContext const *)

void	doEndJob ()

bool	doEndLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)

void	doEndProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

bool	doEndRun (RunTransitionInfo const &, ModuleCallingContext const *)

bool	doEvent (EventTransitionInfo const &, ActivityRegistry , ModuleCallingContext const )

void	doPreallocate (PreallocationConfiguration const &)

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

virtual void	preallocLumis (unsigned int)

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
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

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

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

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

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

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

Protected Attributes
std::string	currentFileName_

std::string	currentJsonName_

std::string	outputPath_

uint32_t	runNumber_

uint32_t	sequence_

std::string	streamLabel_

Additional Inherited Members
Public Types inherited from edm::PoolOutputModule
using	AuxItemArray = std::array< AuxItem, numberOfRunLumiEventProductTrees >

enum	DropMetaData { DropNone, DropDroppedPrior, DropPrior, DropAll }

using	OutputItemList = std::vector< OutputItem >

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

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Detailed Description

Definition at line 11 of file JsonWritingTimeoutPoolOutputModule.h.

Constructor & Destructor Documentation

◆ JsonWritingTimeoutPoolOutputModule()

dqmservices::JsonWritingTimeoutPoolOutputModule::JsonWritingTimeoutPoolOutputModule ( edm::ParameterSet const & ps )

explicit

Definition at line 13 of file JsonWritingTimeoutPoolOutputModule.cc.

       : edm::one::OutputModuleBase::OutputModuleBase(ps), edm::TimeoutPoolOutputModule(ps) {
     runNumber_ = ps.getUntrackedParameter<uint32_t>("runNumber");
     outputPath_ = ps.getUntrackedParameter<std::string>("outputPath");
     streamLabel_ = ps.getUntrackedParameter<std::string>("streamLabel");
  
     sequence_ = 0;
   }

References edm::ParameterSet::getUntrackedParameter(), outputPath_, runNumber_, sequence_, streamLabel_, and AlCaHLTBitMon_QueryRunRegistry::string.

◆ ~JsonWritingTimeoutPoolOutputModule()

dqmservices::JsonWritingTimeoutPoolOutputModule::~JsonWritingTimeoutPoolOutputModule ( )

inlineoverride

Definition at line 14 of file JsonWritingTimeoutPoolOutputModule.h.

14 {};

Member Function Documentation

◆ doExtrasAfterCloseFile()

void dqmservices::JsonWritingTimeoutPoolOutputModule::doExtrasAfterCloseFile ( )

overrideprotectedvirtual

Reimplemented from edm::PoolOutputModule.

Definition at line 35 of file JsonWritingTimeoutPoolOutputModule.cc.

                                                                   {
     std::string json_tmp_ = currentJsonName_ + ".open";
     std::string transferDest = "";
     std::string mergeType = "ROOT";
     auto pt = dqmfilesaver::fillJson(runNumber_, sequence_, currentFileName_, transferDest, mergeType, nullptr);
     write_json(json_tmp_, pt);
     rename(json_tmp_.c_str(), currentJsonName_.c_str());
   }

References currentFileName_, currentJsonName_, dqmfilesaver::fillJson(), DiDispStaMuonMonitor_cfi::pt, runNumber_, sequence_, and AlCaHLTBitMon_QueryRunRegistry::string.

◆ fillDescriptions()

void dqmservices::JsonWritingTimeoutPoolOutputModule::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 44 of file JsonWritingTimeoutPoolOutputModule.cc.

                                                                                                       {
     edm::ParameterSetDescription desc;
     TimeoutPoolOutputModule::fillDescription(desc);
  
     desc.setComment(
         "Almost same as TimeoutPoolOutputModule, but the output files names "
         "follow the FFF naming convention. Additionally a json 'description' "
         "file is emitted for every .root file written.");
  
     desc.addUntracked<uint32_t>("runNumber", 0)
         ->setComment(
             "The run number, only used for file prefix: "
             "'run000001_lumi0000_...'.");
  
     desc.addUntracked<std::string>("outputPath", "./")
         ->setComment(
             "Output path for the root and json files, usually the run "
             "directory.");
  
     desc.addUntracked<std::string>("streamLabel", "streamEvDOutput")->setComment("Stream label, used for file suffix.");
  
     descriptions.add("jsonWriting", desc);
   }

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, and AlCaHLTBitMon_QueryRunRegistry::string.

◆ physicalAndLogicalNameForNewFile()

std::pair< std::string, std::string > dqmservices::JsonWritingTimeoutPoolOutputModule::physicalAndLogicalNameForNewFile ( )

overrideprotectedvirtual

Reimplemented from edm::PoolOutputModule.

Definition at line 22 of file JsonWritingTimeoutPoolOutputModule.cc.

                                                                                                      {
     sequence_++;
  
     std::string base = fmt::sprintf("run%06d_ls%04d_%s", runNumber_, sequence_, streamLabel_);
  
     std::filesystem::path p(outputPath_);
  
     currentFileName_ = (p / base).string() + ".root";
     currentJsonName_ = (p / base).string() + ".jsn";
  
     return std::make_pair(currentFileName_, currentFileName_);
   }