Belle II Software  release-08-01-10
DQMFileMetaData Class Reference

Metadata information about a DQM file. More...

#include <DQMFileMetaData.h>

Inheritance diagram for DQMFileMetaData:
Collaboration diagram for DQMFileMetaData:

Public Member Functions

 DQMFileMetaData ()
 Constructor.
 
unsigned int getNEvents () const
 Number of events getter.
 
int getExperiment () const
 experiment number getter.
 
int getRun () const
 run number getter.
 
const std::string & getRunDate () const
 Run date getter (UTC)
 
const std::string & getRelease () const
 Software release version getter.
 
const std::string & getProcessingID () const
 Processing ID getter.
 
const std::string & getRunType () const
 Run type getter.
 
bool isMC () const
 Is it generated data?.
 
const std::string & getDatabaseGlobalTag () const
 Get the database global tag used when creating this file. More...
 
void setNEvents (unsigned int nEvents)
 Number of events setter. More...
 
void setExperimentRun (int experiment, int run)
 Set experiment and run. More...
 
void setRelease (const std::string &release)
 set release More...
 
void setRunDate (const std::string &date)
 set run date More...
 
void setProcessingID (const std::string &procID)
 set processing ID More...
 
void setRunType (const std::string &rtype)
 set run type More...
 
void setDatabaseGlobalTag (const std::string &globalTag)
 Set the database global tag used when creating this file. More...
 
virtual void Print (Option_t *option="") const override
 Print the content of the meta data object. More...
 

Private Member Functions

void declareMCData ()
 Declare that this is not generated, but real data.
 
 ClassDefOverride (DQMFileMetaData, 1)
 Metadata information about a file.
 

Private Attributes

unsigned int m_nEvents
 Number of events. More...
 
int m_experiment
 experiment number. More...
 
int m_run
 run number. More...
 
std::string m_date
 run date and time (UTC). More...
 
std::string m_release
 Software release version. More...
 
std::string m_procID
 processing ID
 
std::string m_rtype
 run type (physics, cosmics, etc.)
 
bool m_isMC
 Is it generated or real data?. More...
 
std::string m_databaseGlobalTag
 Global tag in the database used for production of this file.
 

Detailed Description

Metadata information about a DQM file.

Definition at line 27 of file DQMFileMetaData.h.

Member Function Documentation

◆ getDatabaseGlobalTag()

const std::string& getDatabaseGlobalTag ( ) const
inline

Get the database global tag used when creating this file.

If more then one global tag was used by multiple conditions database instances all are concatenated using ',' as separation. If no conditions database was used an empty string is returned

Definition at line 66 of file DQMFileMetaData.h.

66 { return m_databaseGlobalTag; }
std::string m_databaseGlobalTag
Global tag in the database used for production of this file.

◆ Print()

void Print ( Option_t *  option = "") const
overridevirtual

Print the content of the meta data object.

Parameters
optionUse "all" to print everything, except steering file. Use "steering" for printing (only) steering file. "json" for machine-readable output

Definition at line 29 of file DQMFileMetaData.cc.

30 {
31 
32  const bool all = (option && option == std::string("all"));
33  KeyValuePrinter printer(false);
34  printer.put("nEvents", m_nEvents);
35  printer.put("Experiment", m_experiment);
36  printer.put("Run", m_run);
37 
38  if (all) {
39  printer.put("run type", m_rtype);
40  printer.put("run date", m_date);
41  printer.put("processing", m_procID);
42  printer.put("release", m_release);
43  printer.put("isMC", m_isMC);
44  printer.put("globalTag", m_databaseGlobalTag);
45  }
46  std::cout << "=== DQMFileMetaData ===\n";
47  std::cout << printer.string();
48  std::cout << "=======================\n";
49 }
unsigned int m_nEvents
Number of events.
bool m_isMC
Is it generated or real data?.
std::string m_rtype
run type (physics, cosmics, etc.)
std::string m_procID
processing ID
std::string m_release
Software release version.
std::string m_date
run date and time (UTC).
int m_experiment
experiment number.
create human-readable or JSON output for key value pairs.

◆ setDatabaseGlobalTag()

void setDatabaseGlobalTag ( const std::string &  globalTag)
inline

Set the database global tag used when creating this file.

If more then one global tag was used by multiple conditions database instances all should be concatenated using ',' as separation. If no conditions database was used an empty string should be set.

Definition at line 118 of file DQMFileMetaData.h.

◆ setExperimentRun()

void setExperimentRun ( int  experiment,
int  run 
)
inline

Set experiment and run.

Parameters
experimentexperiment number.
runrun number.

Definition at line 79 of file DQMFileMetaData.h.

◆ setNEvents()

void setNEvents ( unsigned int  nEvents)
inline

Number of events setter.

Parameters
nEventsThe number of events.

Definition at line 72 of file DQMFileMetaData.h.

◆ setProcessingID()

void setProcessingID ( const std::string &  procID)
inline

set processing ID

Parameters
procIDprocessing ID (online,proc9,proc10,etc.)

Definition at line 100 of file DQMFileMetaData.h.

◆ setRelease()

void setRelease ( const std::string &  release)
inline

set release

Parameters
releaserelease number

Definition at line 84 of file DQMFileMetaData.h.

◆ setRunDate()

void setRunDate ( const std::string &  date)
inline

set run date

Parameters
datedate and time of run

Definition at line 92 of file DQMFileMetaData.h.

◆ setRunType()

void setRunType ( const std::string &  rtype)
inline

set run type

Parameters
rtyperun type (physics,cosmic,local,null)

Definition at line 108 of file DQMFileMetaData.h.

Member Data Documentation

◆ m_date

std::string m_date
private

run date and time (UTC).


Definition at line 134 of file DQMFileMetaData.h.

◆ m_experiment

int m_experiment
private

experiment number.


Definition at line 130 of file DQMFileMetaData.h.

◆ m_isMC

bool m_isMC
private

Is it generated or real data?.


Definition at line 142 of file DQMFileMetaData.h.

◆ m_nEvents

unsigned int m_nEvents
private

Number of events.


Definition at line 128 of file DQMFileMetaData.h.

◆ m_release

std::string m_release
private

Software release version.


Definition at line 136 of file DQMFileMetaData.h.

◆ m_run

int m_run
private

run number.


Definition at line 132 of file DQMFileMetaData.h.


The documentation for this class was generated from the following files: