CMS 3D CMS Logo

List of all members | Public Member Functions | Static Public Member Functions
edm::RunHelperBase Class Reference

#include <RunHelper.h>

Inheritance diagram for edm::RunHelperBase:
edm::DefaultRunHelper edm::FirstLuminosityBlockForEachRunHelper edm::SetRunForEachLumiHelper edm::SetRunHelper

Public Member Functions

virtual void checkForNewRun (RunNumber_t run, LuminosityBlockNumber_t nextLumi)
 
virtual void checkLumiConsistency (LuminosityBlockNumber_t lumi, LuminosityBlockNumber_t origninalLumi) const
 
virtual void checkRunConsistency (RunNumber_t run, RunNumber_t origninalRun) const
 
virtual bool fakeNewRun () const
 
virtual InputSource::ItemType nextItemType (InputSource::ItemType const &previousItemType, InputSource::ItemType const &newItemType, RunNumber_t, LuminosityBlockNumber_t, EventNumber_t)
 
virtual void overrideRunNumber (EventID &event, bool isRealData)
 
virtual void overrideRunNumber (LuminosityBlockID &lumi)
 
virtual void overrideRunNumber (RunID &run)
 
 RunHelperBase ()=default
 
virtual RunNumber_t runNumberToUseForThisLumi () const
 
virtual void setForcedRunOffset (RunNumber_t firstRun)
 
virtual ~RunHelperBase ()
 

Static Public Member Functions

static void fillDescription (ParameterSetDescription &desc)
 

Detailed Description

Definition at line 15 of file RunHelper.h.

Constructor & Destructor Documentation

◆ RunHelperBase()

edm::RunHelperBase::RunHelperBase ( )
explicitdefault

◆ ~RunHelperBase()

edm::RunHelperBase::~RunHelperBase ( )
virtual

Definition at line 33 of file RunHelper.cc.

33 {}

Member Function Documentation

◆ checkForNewRun()

virtual void edm::RunHelperBase::checkForNewRun ( RunNumber_t  run,
LuminosityBlockNumber_t  nextLumi 
)
inlinevirtual

Reimplemented in edm::FirstLuminosityBlockForEachRunHelper, and edm::SetRunForEachLumiHelper.

Definition at line 30 of file RunHelper.h.

30 {}

◆ checkLumiConsistency()

void edm::RunHelperBase::checkLumiConsistency ( LuminosityBlockNumber_t  lumi,
LuminosityBlockNumber_t  origninalLumi 
) const
virtual

Definition at line 35 of file RunHelper.cc.

35  {
36  assert(lumi == originalLumi);
37  }

References cms::cuda::assert().

◆ checkRunConsistency()

void edm::RunHelperBase::checkRunConsistency ( RunNumber_t  run,
RunNumber_t  origninalRun 
) const
virtual

Reimplemented in edm::SetRunForEachLumiHelper, edm::SetRunHelper, and edm::FirstLuminosityBlockForEachRunHelper.

Definition at line 39 of file RunHelper.cc.

39  {
40  assert(run == originalRun);
41  }

References cms::cuda::assert(), and writedatasetfile::run.

◆ fakeNewRun()

virtual bool edm::RunHelperBase::fakeNewRun ( ) const
inlinevirtual

Reimplemented in edm::FirstLuminosityBlockForEachRunHelper, and edm::SetRunForEachLumiHelper.

Definition at line 28 of file RunHelper.h.

28 { return false; }

◆ fillDescription()

void edm::RunHelperBase::fillDescription ( ParameterSetDescription desc)
static

Definition at line 240 of file RunHelper.cc.

240  {
241  desc.addOptionalNode(ParameterDescription<unsigned int>("setRunNumber", 0U, false) xor
242  ParameterDescription<std::vector<unsigned int>>(
243  "setRunNumberForEachLumi", std::vector<unsigned int>(), false) xor
244  ParameterDescription<std::vector<LuminosityBlockID>>(
245  "firstLuminosityBlockForEachRun", std::vector<LuminosityBlockID>(), false),
246  true)
247  ->setComment(
248  "If 'setRun' is non-zero, change number of first run to this number. Apply same offset to all runs."
249  "If 'setRunNumberForEachLumi' is non-empty, use these as run numbers for each lumi respectively."
250  "If 'firstLuminosityBlockForEachRun' is non-empty, the LuminosityBlock ID is used to determine which Run "
251  "ID to use. The entries must be ascending values of LuminosityBlock ID."
252  "''setRun', 'setRunNumberForEachLumi' and 'firstLuminosityBlockForEachRun' are mutually exclusive and "
253  "allowed only for simulation.");
254  }

References edm::ParameterSetDescription::addOptionalNode(), edm::ParameterDescriptionNode::setComment(), and mitigatedMETSequence_cff::U.

Referenced by edm::PoolSource::fillDescriptions().

◆ nextItemType()

virtual InputSource::ItemType edm::RunHelperBase::nextItemType ( InputSource::ItemType const &  previousItemType,
InputSource::ItemType const &  newItemType,
RunNumber_t  ,
LuminosityBlockNumber_t  ,
EventNumber_t   
)
inlinevirtual

Reimplemented in edm::FirstLuminosityBlockForEachRunHelper, and edm::SetRunForEachLumiHelper.

Definition at line 20 of file RunHelper.h.

24  {
25  return newItemType;
26  }

◆ overrideRunNumber() [1/3]

virtual void edm::RunHelperBase::overrideRunNumber ( EventID event,
bool  isRealData 
)
inlinevirtual

◆ overrideRunNumber() [2/3]

virtual void edm::RunHelperBase::overrideRunNumber ( LuminosityBlockID lumi)
inlinevirtual

◆ overrideRunNumber() [3/3]

virtual void edm::RunHelperBase::overrideRunNumber ( RunID run)
inlinevirtual

◆ runNumberToUseForThisLumi()

virtual RunNumber_t edm::RunHelperBase::runNumberToUseForThisLumi ( ) const
inlinevirtual

Reimplemented in edm::FirstLuminosityBlockForEachRunHelper, and edm::SetRunForEachLumiHelper.

Definition at line 27 of file RunHelper.h.

27 { return 0; }

◆ setForcedRunOffset()

virtual void edm::RunHelperBase::setForcedRunOffset ( RunNumber_t  firstRun)
inlinevirtual

Reimplemented in edm::SetRunHelper.

Definition at line 29 of file RunHelper.h.

29 {}
ParameterDescription
cms::cuda::assert
assert(be >=bs)
mitigatedMETSequence_cff.U
U
Definition: mitigatedMETSequence_cff.py:36
writedatasetfile.run
run
Definition: writedatasetfile.py:27
lumi
Definition: LumiSectionData.h:20