Inheritance diagram for DQMFileSaver:

Public Types
typedef dqm::legacy::DQMStore	DQMStore

typedef dqm::legacy::MonitorElement	MonitorElement

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

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

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

Public Member Functions inherited from edm::one::EDAnalyzer< edm::one::WatchRuns >
	EDAnalyzer ()=default

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

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

	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () 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 &&)=default

	EDConsumerBase (EDConsumerBase const &)=delete

ESProxyIndex const *	esGetTokenIndices (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::vector< ModuleDescription const * > &modules, 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

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

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

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)

virtual	~EDConsumerBase () noexcept(false)

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

void	beginRun (edm::Run const &, edm::EventSetup const &) override

void	endJob () override

void	endRun (const edm::Run &, const edm::EventSetup &) override

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

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)

Private Member Functions
void	saveForOffline (const std::string &workflow, int run, int lumi)

void	saveJobReport (const std::string &filename)

Private Attributes
std::string	child_

DQMStore *	dbe_

std::string	dirName_

std::string	fileBaseName_

int	forceRunNumber_

int	irun_

int	nrun_

std::string	producer_

bool	runIsComplete_

bool	saveAtJobEnd_

int	saveByRun_

std::string	stream_label_

int	version_

std::string	workflow_

Additional Inherited Members
Static Public Member Functions inherited from edm::one::EDAnalyzerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Detailed Description

Definition at line 28 of file DQMFileSaver.cc.

Member Typedef Documentation

◆ DQMStore

typedef dqm::legacy::DQMStore DQMFileSaver::DQMStore

Definition at line 30 of file DQMFileSaver.cc.

◆ MonitorElement

typedef dqm::legacy::MonitorElement DQMFileSaver::MonitorElement

Definition at line 31 of file DQMFileSaver.cc.

Constructor & Destructor Documentation

◆ DQMFileSaver()

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

Definition at line 134 of file DQMFileSaver.cc.

     :
  
       workflow_(""),
       producer_("DQM"),
       dirName_("."),
       child_(""),
       version_(1),
       runIsComplete_(false),
       saveByRun_(-1),
       saveAtJobEnd_(false),
       forceRunNumber_(-1),
       fileBaseName_(""),
       dbe_(&*edm::Service<DQMStore>()),
       nrun_(0),
       irun_(0) {
   // Note: this is insufficient, we also need to enforce running *after* all
   // DQMEDAnalyzers (a.k.a. EDProducers) in endJob.
   // This is not supported in edm currently.
   consumesMany<DQMToken, edm::InRun>();
   workflow_ = ps.getUntrackedParameter<std::string>("workflow", workflow_);
   if (workflow_.empty() || workflow_[0] != '/' || *workflow_.rbegin() == '/' ||
       std::count(workflow_.begin(), workflow_.end(), '/') != 3 ||
       workflow_.find_first_not_of("ABCDEFGHIJKLMNOPQRSTUVWXYZ"
                                   "abcdefghijklmnopqrstuvwxyz"
                                   "0123456789"
                                   "-_/") != std::string::npos)
     throw cms::Exception("DQMFileSaver") << "Invalid 'workflow' parameter '" << workflow_ << "'.  Expected '/A/B/C'.";
  
   // version number to be used in filename
   // Note that version *must* always be 1 vor DQMGUI upload.
   version_ = ps.getUntrackedParameter<int>("version", version_);
   // flag to signal that file contains data from complete run
   runIsComplete_ = ps.getUntrackedParameter<bool>("runIsComplete", runIsComplete_);
  
   // Get and check the output directory.
   struct stat s;
   dirName_ = ps.getUntrackedParameter<std::string>("dirName", dirName_);
   if (dirName_.empty() || stat(dirName_.c_str(), &s) == -1)
     throw cms::Exception("DQMFileSaver") << "Invalid 'dirName' parameter '" << dirName_ << "'.";
  
   // Find out when and how to save files.  The following contraints apply:
   // - For offline allow files to be saved per run, at job end, and run number to be overridden (for mc data).
  
   getAnInt(ps, saveByRun_, "saveByRun");
   getAnInt(ps, forceRunNumber_, "forceRunNumber");
   saveAtJobEnd_ = ps.getUntrackedParameter<bool>("saveAtJobEnd", saveAtJobEnd_);
  
   // Set up base file name:
   // - for online and offline, follow the convention <dirName>/<producer>_V<4digits>_
   char version[8];
   sprintf(version, "_V%04d_", int(version_));
   version[7] = '\0';
   fileBaseName_ = dirName_ + "/" + producer_ + version;
  
   // Log some information what we will do.
   edm::LogInfo("DQMFileSaver") << "DQM file saving settings:\n"
                                << " using base file name '" << fileBaseName_ << "'\n"
                                << " forcing run number " << forceRunNumber_ << "\n"
                                << " saving every " << saveByRun_ << " run(s)\n"
                                << " saving at job end: " << (saveAtJobEnd_ ? "yes" : "no") << "\n";
 }

References KineDebug3::count(), dirName_, Exception, fileBaseName_, forceRunNumber_, getAnInt(), edm::ParameterSet::getUntrackedParameter(), producer_, runIsComplete_, alignCSCRings::s, saveAtJobEnd_, saveByRun_, hgcalPlots::stat, AlCaHLTBitMon_QueryRunRegistry::string, BeamSplash_cfg::version, version_, and workflow_.

Member Function Documentation

◆ analyze()

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

overrideprotectedvirtual

Implements edm::one::EDAnalyzerBase.

Definition at line 197 of file DQMFileSaver.cc.

                                                                    {
   //save by event and save by time are not supported
   //anymore in the threaded framework. please use
   //savebyLumiSection instead.
 }

◆ beginRun()

void DQMFileSaver::beginRun	(	edm::Run const &	,
		edm::EventSetup const &
	)

inlineoverrideprotected

Definition at line 35 of file DQMFileSaver.cc.

35 {};

◆ endJob()

void DQMFileSaver::endJob ( void )

overrideprotectedvirtual

Reimplemented from edm::one::EDAnalyzerBase.

Definition at line 211 of file DQMFileSaver.cc.

                           {
   if (saveAtJobEnd_) {
     if (forceRunNumber_ > 0)
       saveForOffline(workflow_, forceRunNumber_, 0);
     else
       saveForOffline(workflow_, irun_, 0);
   }
 }

References forceRunNumber_, irun_, saveAtJobEnd_, saveForOffline(), and workflow_.

◆ endRun()

void DQMFileSaver::endRun	(	const edm::Run &	iRun,
		const edm::EventSetup &
	)

overrideprotected

Definition at line 203 of file DQMFileSaver.cc.

                                                                    {
   int irun = iRun.id().run();
   irun_ = irun;
   if (irun > 0 && saveByRun_ > 0 && (nrun_ % saveByRun_) == 0) {
     saveForOffline(workflow_, irun, 0);
   }
 }

References edm::RunBase::id(), irun_, nrun_, edm::RunID::run(), saveByRun_, saveForOffline(), and workflow_.

◆ saveForOffline()

void DQMFileSaver::saveForOffline	(	const std::string &	workflow,
		int	run,
		int	lumi
	)

private

Definition at line 88 of file DQMFileSaver.cc.

                                                                               {
   char suffix[64];
   sprintf(suffix, "R%09d", run);
  
   std::string filename = onlineOfflineFileName(fileBaseName_, std::string(suffix), workflow, child_);
   assert(lumi == 0);
  
   // set run end flag
   dbe_->cd();
   dbe_->setCurrentFolder("Info/ProvInfo");
  
   // do this, because ProvInfo is not yet run in offline DQM
   MonitorElement *me = dbe_->get("Info/ProvInfo/CMSSW");
   if (!me)
     me = dbe_->bookString("CMSSW", edm::getReleaseVersion().c_str());
  
   me = dbe_->get("Info/ProvInfo/runIsComplete");
   if (!me)
     me = dbe_->bookFloat("runIsComplete");
  
   if (me) {
     if (runIsComplete_)
       me->Fill(1.);
     else
       me->Fill(0.);
   }
  
   LegacyIOHelper h(dbe_);
   h.save(filename, "", run, /* saveall */ true, "RECREATE");
  
   // save the JobReport
   saveJobReport(filename);
 }

References cms::cuda::assert(), dqm::implementation::IBooker::bookFloat(), dqm::implementation::IBooker::bookString(), dqm::implementation::DQMStore::cd(), child_, dbe_, fileBaseName_, corrVsCorr::filename, dqm::implementation::IGetter::get(), edm::getReleaseVersion(), h, hlt_dqm_clientPB-live_cfg::me, onlineOfflineFileName(), writedatasetfile::run, runIsComplete_, saveJobReport(), dqm::implementation::DQMStore::setCurrentFolder(), AlCaHLTBitMon_QueryRunRegistry::string, createPayload::suffix, and AlCaHarvesting_cff::workflow.

Referenced by endJob(), and endRun().

◆ saveJobReport()

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

private

Definition at line 122 of file DQMFileSaver.cc.

                                                           {
   // 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);
   }
 }

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

Referenced by saveForOffline().

Member Data Documentation

◆ child_

std::string DQMFileSaver::child_

private

Definition at line 48 of file DQMFileSaver.cc.

Referenced by saveForOffline().

◆ dbe_

DQMStore* DQMFileSaver::dbe_

private

Definition at line 58 of file DQMFileSaver.cc.

Referenced by saveForOffline().

◆ dirName_

std::string DQMFileSaver::dirName_

private

Definition at line 47 of file DQMFileSaver.cc.

Referenced by DQMFileSaver().

◆ fileBaseName_

std::string DQMFileSaver::fileBaseName_

private

Definition at line 56 of file DQMFileSaver.cc.

Referenced by DQMFileSaver(), and saveForOffline().

◆ forceRunNumber_

int DQMFileSaver::forceRunNumber_

private

Definition at line 54 of file DQMFileSaver.cc.

Referenced by DQMFileSaver(), and endJob().

◆ irun_

int DQMFileSaver::irun_

private

Definition at line 62 of file DQMFileSaver.cc.

Referenced by endJob(), and endRun().

◆ nrun_

int DQMFileSaver::nrun_

private

Definition at line 59 of file DQMFileSaver.cc.

Referenced by endRun().

◆ producer_

std::string DQMFileSaver::producer_

private

Definition at line 45 of file DQMFileSaver.cc.

Referenced by DQMFileSaver().

◆ runIsComplete_

bool DQMFileSaver::runIsComplete_

private

Definition at line 50 of file DQMFileSaver.cc.

Referenced by DQMFileSaver(), and saveForOffline().

◆ saveAtJobEnd_

bool DQMFileSaver::saveAtJobEnd_

private

Definition at line 53 of file DQMFileSaver.cc.

Referenced by DQMFileSaver(), and endJob().

◆ saveByRun_

int DQMFileSaver::saveByRun_

private

Definition at line 52 of file DQMFileSaver.cc.

Referenced by DQMFileSaver(), and endRun().

◆ stream_label_

std::string DQMFileSaver::stream_label_

private

Definition at line 46 of file DQMFileSaver.cc.

◆ version_

int DQMFileSaver::version_

private

Definition at line 49 of file DQMFileSaver.cc.

Referenced by DQMFileSaver().

◆ workflow_

std::string DQMFileSaver::workflow_

private

Definition at line 44 of file DQMFileSaver.cc.

Referenced by DQMFileSaver(), endJob(), and endRun().

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DQMStore

◆ MonitorElement

Constructor & Destructor Documentation

◆ DQMFileSaver()

Member Function Documentation

◆ analyze()

◆ beginRun()

◆ endJob()

◆ endRun()

◆ saveForOffline()

◆ saveJobReport()

Member Data Documentation

◆ child_

◆ dbe_

◆ dirName_

◆ fileBaseName_

◆ forceRunNumber_

◆ irun_

◆ nrun_

◆ producer_

◆ runIsComplete_

◆ saveAtJobEnd_

◆ saveByRun_

◆ stream_label_

◆ version_

◆ workflow_