#include <DQMFileSaverBase.h>

Inheritance diagram for dqm::DQMFileSaverBase:

Classes
struct	FileParameters

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

	~DQMFileSaverBase ()

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

Public Member Functions inherited from edm::global::EDAnalyzerBase
	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

virtual	~EDAnalyzerBase ()

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 (const std::string &iProcessName, std::vector< const char * > &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 (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
virtual void	analyze (edm::StreamID, const edm::Event &e, const edm::EventSetup &) const overridefinal

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

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

virtual void	globalEndLuminosityBlock (const edm::LuminosityBlock &, const edm::EventSetup &) const overridefinal

virtual void	globalEndRun (const edm::Run &, const edm::EventSetup &) const overridefinal

virtual void	initRun (void) const

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

virtual void	postForkReacquireResources (unsigned int childIndex, unsigned int numberOfChildren)

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)

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)

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_

Additional Inherited Members
Public Types inherited from edm::global::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Detailed Description

Definition at line 23 of file DQMFileSaverBase.h.

Constructor & Destructor Documentation

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

Definition at line 28 of file DQMFileSaverBase.cc.

                                                             {
   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_ = "";
 
   fp.saveReference_ = DQMStore::SaveWithReference;
   // Check how we should save the references.
   std::string refsave = ps.getUntrackedParameter<std::string>("referenceHandling", "all");
   if (refsave == "skip")
   {
     fp.saveReference_ = DQMStore::SaveWithoutReference;
   }
   else if (refsave == "all")
   {
     fp.saveReference_ = DQMStore::SaveWithReference;
   }
   else if (refsave == "qtests")
   {
     fp.saveReference_ = DQMStore::SaveWithReferenceForQTest;
   }
   else {
     //edm::LogInfo("DQMFileSaverBase")
     std::cerr
       << "Invalid 'referenceHandling' parameter '" << refsave
       << "'.  Expected 'skip', 'all' or 'qtests'.";
 
   }
 
   // Check minimum required quality test result for which reference is saved.
   fp.saveReferenceQMin_ = ps.getUntrackedParameter<int>("referenceRequireStatus", dqm::qstatus::STATUS_OK);
 
   std::unique_lock<std::mutex> lck(initial_fp_lock_);
   initial_fp_ = fp;
 }

DQMFileSaverBase::~DQMFileSaverBase ( )

Definition at line 69 of file DQMFileSaverBase.cc.

69 {}

Member Function Documentation

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

finaloverrideprotectedvirtual

Implements edm::global::EDAnalyzerBase.

Definition at line 85 of file DQMFileSaverBase.cc.

                                                             {
   // not supported
 }

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

staticprotected

Definition at line 141 of file DQMFileSaverBase.cc.

References dqm::DQMFileSaverBase::FileParameters::child_, mergeVDriftHistosByStation::file, dqm::DQMFileSaverBase::FileParameters::lumi_, cmsHarvester::path, dqm::DQMFileSaverBase::FileParameters::path_, dqm::DQMFileSaverBase::FileParameters::producer_, dqm::DQMFileSaverBase::FileParameters::run_, dqm::DQMFileSaverBase::FileParameters::tag_, and dqm::DQMFileSaverBase::FileParameters::version_.

Referenced by cuy.ValElement::__init__(), dqm::DQMFileSaverOnline::makeSnapshot(), and Vispa.Plugins.ConfigEditor.ConfigDataAccessor.ConfigDataAccessor::properties().

                                                                                  {
   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 = boost::filesystem;
   fs::path path(fp.path_);
   fs::path file(buf);
 
   return (path / file).string();
 }

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

static

Definition at line 180 of file DQMFileSaverBase.cc.

References edm::ParameterSetDescription::addUntracked(), 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.");
 }

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

finaloverrideprotectedvirtual

Definition at line 79 of file DQMFileSaverBase.cc.

                                                               {
 
   return nullptr;
 }

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

finaloverrideprotectedvirtual

Definition at line 71 of file DQMFileSaverBase.cc.

References initRun().

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

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

finaloverrideprotectedvirtual

Definition at line 90 of file DQMFileSaverBase.cc.

References personalPlayback::fp, edm::LuminosityBlockBase::id(), initial_fp_, initial_fp_lock_, dqm::DQMFileSaverBase::FileParameters::lumi_, edm::LuminosityBlockID::luminosityBlock(), edm::LuminosityBlockID::run(), dqm::DQMFileSaverBase::FileParameters::run_, 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_ = irun;
 
   this->saveLumi(fp);
 
   edm::Service<DQMStore> store;
   store->deleteUnusedLumiHistograms(store->mtEnabled() ? irun : 0, ilumi);
 }

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

finaloverrideprotectedvirtual

Definition at line 108 of file DQMFileSaverBase.cc.

References personalPlayback::fp, edm::RunBase::id(), initial_fp_, initial_fp_lock_, edm::RunID::run(), dqm::DQMFileSaverBase::FileParameters::run_, and saveRun().

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

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

inlineprotectedvirtual

Reimplemented in dqm::DQMFileSaverPB.

Definition at line 69 of file DQMFileSaverBase.h.

Referenced by globalBeginRun().

69 {};

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

protected

Definition at line 174 of file DQMFileSaverBase.cc.

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

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

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

void DQMFileSaverBase::postForkReacquireResources	(	unsigned int	childIndex,
		unsigned int	numberOfChildren
	)

protectedvirtual

Reimplemented from edm::global::EDAnalyzerBase.

Definition at line 121 of file DQMFileSaverBase.cc.

References dqm::DQMFileSaverBase::FileParameters::child_, initial_fp_, initial_fp_lock_, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                             {
   // this is copied from IOPool/Output/src/PoolOutputModule.cc, for consistency
   unsigned int digits = 0;
   while (numberOfChildren != 0) {
     ++digits;
     numberOfChildren /= 10;
   }
   // protect against zero numberOfChildren
   if (digits == 0) {
     digits = 3;
   }
 
   char buffer[digits + 2];
   snprintf(buffer, digits + 2, "_F%0*d", digits, childIndex);
 
   std::unique_lock<std::mutex> lck(initial_fp_lock_);
   initial_fp_.child_ = std::string(buffer);
 }

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

protected

Definition at line 160 of file DQMFileSaverBase.cc.

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