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, edm::WatchProcessBlock >
	EDAnalyzer ()=default

	EDAnalyzer (const EDAnalyzer &)=delete

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

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

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

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

	EDConsumerBase (EDConsumerBase &&)=default

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

EDConsumerBase &	operator= (EDConsumerBase &&)=default

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)

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

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

void	endProcessBlock (const edm::ProcessBlock &) override

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

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 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)

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)

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_

edm::GetterOfProducts< DQMToken >	jobmegetter_

int	nrun_

std::string	producer_

bool	runIsComplete_

edm::GetterOfProducts< DQMToken >	runmegetter_

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 31 of file DQMFileSaver.cc.

Member Typedef Documentation

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

Definition at line 33 of file DQMFileSaver.cc.

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

Definition at line 34 of file DQMFileSaver.cc.

Constructor & Destructor Documentation

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

Definition at line 142 of file DQMFileSaver.cc.

References edm::one::EDAnalyzerBase::callWhenNewProductsRegistered(), submitPVResolutionJobs::count, dirName_, Exception, fileBaseName_, forceRunNumber_, getAnInt(), edm::ParameterSet::getUntrackedParameter(), jobmegetter_, producer_, runIsComplete_, runmegetter_, alignCSCRings::s, saveAtJobEnd_, saveByRun_, edm_modernize_messagelogger::stat, AlCaHLTBitMon_QueryRunRegistry::string, relval_steps::version, version_, and workflow_.

     :
 
       workflow_(""),
       producer_("DQM"),
       dirName_("."),
       child_(""),
       version_(1),
       runIsComplete_(false),
       saveByRun_(-1),
       saveAtJobEnd_(false),
       forceRunNumber_(-1),
       fileBaseName_(""),
       dbe_(&*edm::Service<DQMStore>()),
       nrun_(0),
       irun_(0),
       // Abuse ProcessMatch as a "match all".
       jobmegetter_(edm::GetterOfProducts<DQMToken>(edm::ProcessMatch("*"), this, edm::InProcess)),
       runmegetter_(edm::GetterOfProducts<DQMToken>(edm::ProcessMatch("*"), this, edm::InRun)) {
   callWhenNewProductsRegistered([this](edm::BranchDescription const &bd) {
     this->jobmegetter_(bd);
     this->runmegetter_(bd);
   });
 
   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";
 }

Member Function Documentation

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

overrideprotectedvirtual

Implements edm::one::EDAnalyzerBase.

Definition at line 209 of file DQMFileSaver.cc.

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

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

inlineoverrideprotected

Definition at line 38 of file DQMFileSaver.cc.

38 {};

void DQMFileSaver::endProcessBlock ( const edm::ProcessBlock & )

overrideprotected

Definition at line 223 of file DQMFileSaver.cc.

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

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

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

overrideprotected

Definition at line 215 of file DQMFileSaver.cc.

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

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

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

private

Definition at line 96 of file DQMFileSaver.cc.

References cms::cuda::assert(), dqm::implementation::IBooker::bookFloat(), dqm::implementation::IBooker::bookString(), dqm::implementation::DQMStore::cd(), child_, dbe_, fileBaseName_, lut2db_cfg::filename, dqm::impl::MonitorElement::Fill(), dqm::implementation::IGetter::get(), edm::getReleaseVersion(), h, hlt_dqm_clientPB-live_cfg::me, onlineOfflineFileName(), runIsComplete_, LegacyIOHelper::save(), saveJobReport(), dqm::implementation::DQMStore::setCurrentFolder(), AlCaHLTBitMon_QueryRunRegistry::string, and makePlotsFromDump::suffix.

Referenced by endProcessBlock(), and endRun().

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

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

private

Definition at line 130 of file DQMFileSaver.cc.

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

Referenced by saveForOffline().

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