#include <DQMFileSaverBase.h>

Inheritance diagram for dqm::DQMFileSaverBase:

Classes
struct	FileParameters

Public Types
typedef dqm::legacy::DQMStore	DQMStore

typedef dqm::legacy::MonitorElement	MonitorElement

Public Types inherited from edm::global::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

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

	~DQMFileSaverBase () override

Public Member Functions inherited from edm::global::EDAnalyzer< edm::RunCache< NoCache >, edm::LuminosityBlockCache< NoCache > >
	EDAnalyzer ()=default

	EDAnalyzer (const EDAnalyzer &)=delete

const EDAnalyzer &	operator= (const EDAnalyzer &)=delete

bool	wantsGlobalLuminosityBlocks () const noexcept final

bool	wantsGlobalRuns () const noexcept final

bool	wantsInputProcessBlocks () const noexcept final

bool	wantsProcessBlocks () const noexcept final

bool	wantsStreamLuminosityBlocks () const noexcept final

bool	wantsStreamRuns () const noexcept final

Public Member Functions inherited from edm::global::EDAnalyzerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

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

	EDConsumerBase (EDConsumerBase &&)=default

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

std::vector< ESResolverIndex > 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 const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

bool	registeredToConsume (ProductResolverIndex, bool, 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::ESRecordsToProductResolverIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescription (edm::ParameterSetDescription &d)

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Protected Member Functions
void	analyze (edm::StreamID, const edm::Event &e, const edm::EventSetup &) const final

std::shared_ptr< NoCache >	globalBeginLuminosityBlock (const edm::LuminosityBlock &, const edm::EventSetup &) const final

std::shared_ptr< NoCache >	globalBeginRun (const edm::Run &, const edm::EventSetup &) const final

void	globalEndLuminosityBlock (const edm::LuminosityBlock &, const edm::EventSetup &) const final

void	globalEndRun (const edm::Run &, const edm::EventSetup &) const final

virtual void	initRun () const

void	logFileAction (const std::string &msg, const std::string &fileName) const

void	saveJobReport (const std::string &filename) const

virtual void	saveLumi (const FileParameters &fp) const

virtual void	saveRun (const FileParameters &fp) const

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

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

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

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

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

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

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

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)

void	resetItemsToGetFrom (BranchType iType)

Static Protected Member Functions
static const std::string	filename (const FileParameters &fp, bool useLumi=false)

Protected Attributes
FileParameters	initial_fp_

std::mutex	initial_fp_lock_

edm::GetterOfProducts< DQMToken >	lumigetter_

edm::GetterOfProducts< DQMToken >	rungetter_

int	runNumber_

Detailed Description

Definition at line 27 of file DQMFileSaverBase.h.

Member Typedef Documentation

◆ DQMStore

typedef dqm::legacy::DQMStore dqm::DQMFileSaverBase::DQMStore

Definition at line 30 of file DQMFileSaverBase.h.

◆ MonitorElement

typedef dqm::legacy::MonitorElement dqm::DQMFileSaverBase::MonitorElement

Definition at line 29 of file DQMFileSaverBase.h.

Constructor & Destructor Documentation

◆ DQMFileSaverBase()

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

Definition at line 31 of file DQMFileSaverBase.cc.

References edm::global::EDAnalyzerBase::callWhenNewProductsRegistered(), personalPlayback::fp, edm::ParameterSet::getUntrackedParameter(), initial_fp_, initial_fp_lock_, edm::InLumi, edm::InRun, lumigetter_, rungetter_, runNumber_, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                             {
   FileParameters fp;
 
   fp.path_ = ps.getUntrackedParameter<std::string>("path");
   fp.producer_ = ps.getUntrackedParameter<std::string>("producer");
   fp.run_ = 0;
   fp.tag_ = ps.getUntrackedParameter<std::string>("tag");
   fp.lumi_ = 0;
   fp.version_ = 1;
   fp.child_ = "";
 
   std::unique_lock<std::mutex> lck(initial_fp_lock_);
   initial_fp_ = fp;
 
   runNumber_ = ps.getUntrackedParameter<int>("runNumber", 111);
 
   // This makes sure a file saver runs in a very end
   lumigetter_ = edm::GetterOfProducts<DQMToken>(edm::ProcessMatch("*"), this, edm::InLumi);
   rungetter_ = edm::GetterOfProducts<DQMToken>(edm::ProcessMatch("*"), this, edm::InRun);
   callWhenNewProductsRegistered([this](edm::BranchDescription const &bd) {
     this->lumigetter_(bd);
     this->rungetter_(bd);
   });
 }

◆ ~DQMFileSaverBase()

DQMFileSaverBase::~DQMFileSaverBase ( )

overridedefault

Member Function Documentation

◆ analyze()

void DQMFileSaverBase::analyze	(	edm::StreamID	,
		const edm::Event &	e,
		const edm::EventSetup &
	)		const

finalprotectedvirtual

Implements edm::global::EDAnalyzerBase.

Definition at line 69 of file DQMFileSaverBase.cc.

                                                                                           {
   // not supported
 }

◆ filename()

const std::string DQMFileSaverBase::filename	(	const FileParameters &	fp,
		bool	useLumi = `false`
	)

staticprotected

Definition at line 98 of file DQMFileSaverBase.cc.

References visDQMUpload::buf, geometryDiff::file, personalPlayback::fp, compareTotals::fs, and EnsembleCalibrationLA_cfg::path.

Referenced by dqm::DQMFileSaverOnline::fillOrigin(), dqm::DQMFileSaverOnline::makeSnapshot(), saveJobReport(), and dqm::DQMFileSaverPB::savePB().

                                                                                  {
   char buf[256];
   if (useLumi) {
     snprintf(buf,
              256,
              "%s_V%04d_%s_R%09ld_L%09ld%s",
              fp.producer_.c_str(),
              fp.version_,
              fp.tag_.c_str(),
              fp.run_,
              fp.lumi_,
              fp.child_.c_str());
   } else {
     snprintf(buf,
              256,
              "%s_V%04d_%s_R%09ld%s",
              fp.producer_.c_str(),
              fp.version_,
              fp.tag_.c_str(),
              fp.run_,
              fp.child_.c_str());
   }
   buf[255] = 0;
 
   namespace fs = std::filesystem;
   fs::path path(fp.path_);
   fs::path file(buf);
 
   return (path / file).string();
 }

◆ fillDescription()

void DQMFileSaverBase::fillDescription ( edm::ParameterSetDescription & d )

static

Definition at line 145 of file DQMFileSaverBase.cc.

References submitPVResolutionJobs::desc, dqm::qstatus::STATUS_OK, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by dqm::DQMFileSaverPB::fillDescriptions(), and dqm::DQMFileSaverOnline::fillDescriptions().

                                                                        {
   desc.addUntracked<std::string>("tag", "UNKNOWN")->setComment("File tag, DQM_V000_<TAG>*, usually a subsytem name.");
 
   desc.addUntracked<std::string>("producer", "DQM")
       ->setComment("Base prefix for files, <BASE>_V000_**, either 'DQM' or 'Playback'.");
 
   desc.addUntracked<std::string>("referenceHandling", "all")->setComment("saveReference_, passed to the DQMStore");
 
   desc.addUntracked<int>("referenceRequireStatus", dqm::qstatus::STATUS_OK)
       ->setComment("saveReference_, passed to the DQMStore");
 
   desc.addUntracked<std::string>("path", "./")->setComment("Output path prefix.");
 
   desc.addUntracked<int>("runNumber", 111)
       ->setComment("Run number passed in the configuration. Will appear in output file names.");
 }

◆ globalBeginLuminosityBlock()

std::shared_ptr< NoCache > DQMFileSaverBase::globalBeginLuminosityBlock	(	const edm::LuminosityBlock &	l,
		const edm::EventSetup &
	)		const

finalprotected

Definition at line 64 of file DQMFileSaverBase.cc.

                                                                                                    {
   return nullptr;
 }

◆ globalBeginRun()

std::shared_ptr< NoCache > DQMFileSaverBase::globalBeginRun	(	const edm::Run &	r,
		const edm::EventSetup &
	)		const

finalprotected

Definition at line 58 of file DQMFileSaverBase.cc.

References initRun().

                                                                                                     {
   this->initRun();
 
   return nullptr;
 }

◆ globalEndLuminosityBlock()

void DQMFileSaverBase::globalEndLuminosityBlock	(	const edm::LuminosityBlock &	iLS,
		const edm::EventSetup &
	)		const

finalprotected

Definition at line 73 of file DQMFileSaverBase.cc.

References personalPlayback::fp, edm::LuminosityBlockBase::id(), initial_fp_, initial_fp_lock_, edm::LuminosityBlockID::luminosityBlock(), edm::LuminosityBlockID::run(), runNumber_, and saveLumi().

                                                                                                           {
   int ilumi = iLS.id().luminosityBlock();
   int irun = iLS.id().run();
 
   std::unique_lock<std::mutex> lck(initial_fp_lock_);
   FileParameters fp = initial_fp_;
   lck.unlock();
 
   fp.lumi_ = ilumi;
   fp.run_ = runNumber_ == 111 ? irun : runNumber_;
 
   this->saveLumi(fp);
 }

◆ globalEndRun()

void DQMFileSaverBase::globalEndRun	(	const edm::Run &	iRun,
		const edm::EventSetup &
	)		const

finalprotected

Definition at line 87 of file DQMFileSaverBase.cc.

References personalPlayback::fp, edm::RunBase::id(), initial_fp_, initial_fp_lock_, edm::RunID::run(), runNumber_, and saveRun().

                                                                                    {
   std::unique_lock<std::mutex> lck(initial_fp_lock_);
   FileParameters fp = initial_fp_;
   lck.unlock();
 
   fp.run_ = runNumber_ == 111 ? iRun.id().run() : runNumber_;
 
   // empty
   this->saveRun(fp);
 }

◆ initRun()

virtual void dqm::DQMFileSaverBase::initRun ( ) const

inlineprotectedvirtual

Reimplemented in dqm::DQMFileSaverPB.

Definition at line 63 of file DQMFileSaverBase.h.

Referenced by globalBeginRun().

63 {};

◆ logFileAction()

void DQMFileSaverBase::logFileAction	(	const std::string &	msg,
		const std::string &	fileName
	)		const

protected

Definition at line 140 of file DQMFileSaverBase.cc.

References MillePedeFileConverter_cfg::fileName, edm::FlushMessageLog(), and mps_check::msg.

Referenced by dqm::DQMFileSaverOnline::appendSnapshot(), dqm::DQMFileSaverOnline::checkError(), and dqm::DQMFileSaverOnline::makeSnapshot().

                                                                                           {
   edm::LogAbsolute("fileAction") << std::setprecision(0) << edm::TimeOfDay() << "  " << msg << fileName;
   edm::FlushMessageLog();
 }

◆ saveJobReport()

void DQMFileSaverBase::saveJobReport ( const std::string & filename ) const

protected

Definition at line 129 of file DQMFileSaverBase.cc.

References filename(), info(), edm::Service< T >::isAvailable(), and edm::JobReport::reportAnalysisFile().

Referenced by dqm::DQMFileSaverOnline::makeSnapshot().

                                                                     {
   // Report the file to job report service.
   edm::Service<edm::JobReport> jr;
   if (jr.isAvailable()) {
     std::map<std::string, std::string> info;
     info["Source"] = "DQMStore";
     info["FileClass"] = "DQM";
     jr->reportAnalysisFile(filename, info);
   }
 }

◆ saveLumi()

virtual void dqm::DQMFileSaverBase::saveLumi ( const FileParameters & fp ) const

inlineprotectedvirtual

Reimplemented in dqm::DQMFileSaverPB, and dqm::DQMFileSaverOnline.

Definition at line 64 of file DQMFileSaverBase.h.

Referenced by globalEndLuminosityBlock().

64 {};

◆ saveRun()

virtual void dqm::DQMFileSaverBase::saveRun ( const FileParameters & fp ) const

inlineprotectedvirtual

Reimplemented in dqm::DQMFileSaverPB, and dqm::DQMFileSaverOnline.

Definition at line 65 of file DQMFileSaverBase.h.

Referenced by globalEndRun().

65 {};

Member Data Documentation

◆ initial_fp_

FileParameters dqm::DQMFileSaverBase::initial_fp_

protected

Definition at line 75 of file DQMFileSaverBase.h.

Referenced by DQMFileSaverBase(), globalEndLuminosityBlock(), and globalEndRun().

◆ initial_fp_lock_

std::mutex dqm::DQMFileSaverBase::initial_fp_lock_

mutableprotected

Definition at line 74 of file DQMFileSaverBase.h.

Referenced by DQMFileSaverBase(), globalEndLuminosityBlock(), and globalEndRun().

◆ lumigetter_

edm::GetterOfProducts<DQMToken> dqm::DQMFileSaverBase::lumigetter_

protected

Definition at line 78 of file DQMFileSaverBase.h.

Referenced by DQMFileSaverBase().

◆ rungetter_

edm::GetterOfProducts<DQMToken> dqm::DQMFileSaverBase::rungetter_

protected

Definition at line 79 of file DQMFileSaverBase.h.

Referenced by DQMFileSaverBase().

◆ runNumber_

int dqm::DQMFileSaverBase::runNumber_

protected

Definition at line 76 of file DQMFileSaverBase.h.

Referenced by DQMFileSaverBase(), globalEndLuminosityBlock(), and globalEndRun().

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DQMStore

◆ MonitorElement

Constructor & Destructor Documentation

◆ DQMFileSaverBase()

◆ ~DQMFileSaverBase()

Member Function Documentation

◆ analyze()

◆ filename()

◆ fillDescription()

◆ globalBeginLuminosityBlock()

◆ globalBeginRun()

◆ globalEndLuminosityBlock()

◆ globalEndRun()

◆ initRun()

◆ logFileAction()

◆ saveJobReport()

◆ saveLumi()

◆ saveRun()

Member Data Documentation

◆ initial_fp_

◆ initial_fp_lock_

◆ lumigetter_

◆ rungetter_

◆ runNumber_