CMS 3D CMS Logo

List of all members | Public Member Functions | Private Types | Private Member Functions | Private Attributes
edm::ThrowingSource Class Reference
Inheritance diagram for edm::ThrowingSource:
edm::ProducerSourceBase edm::IDGeneratorSourceBase< PuttableSourceBase > edm::PuttableSourceBase edm::InputSource edm::ProducerBase edm::ProductRegistryHelper

Public Member Functions

void beginJob () override
 Begin protected makes it easier to do template programming. More...
 
void beginLuminosityBlock (edm::LuminosityBlock &) override
 
void beginRun (edm::Run &) override
 
void closeFile_ () override
 
void endJob () override
 
void readEvent_ (edm::EventPrincipal &) override
 
std::shared_ptr< edm::FileBlockreadFile_ () override
 
std::shared_ptr< edm::LuminosityBlockAuxiliaryreadLuminosityBlockAuxiliary_ () override
 
std::shared_ptr< edm::RunAuxiliaryreadRunAuxiliary_ () override
 
 ThrowingSource (ParameterSet const &, InputSourceDescription const &)
 
 ~ThrowingSource () noexcept(false) override
 
- Public Member Functions inherited from edm::ProducerSourceBase
 ProducerSourceBase (ParameterSet const &pset, InputSourceDescription const &desc, bool realData)
 
 ~ProducerSourceBase () noexcept(false) override
 
- Public Member Functions inherited from edm::IDGeneratorSourceBase< PuttableSourceBase >
EventNumber_t event () const
 
unsigned int eventCreationDelay () const
 
EventID const & eventID () const
 
 IDGeneratorSourceBase (ParameterSet const &pset, InputSourceDescription const &desc, bool realData)
 
LuminosityBlockNumber_t luminosityBlock () const
 
unsigned int numberEventsInLumi () const
 
unsigned int numberEventsInRun () const
 
unsigned int numberEventsInThisLumi () const
 
unsigned int numberEventsInThisRun () const
 
TimeValue_t presentTime () const
 
RunNumber_t run () const
 
unsigned int timeBetweenEvents () const
 
 ~IDGeneratorSourceBase () noexcept(false) override
 
- Public Member Functions inherited from edm::PuttableSourceBase
bool hasAbilityToProduceInBeginLumis () const final
 
bool hasAbilityToProduceInBeginRuns () const final
 
PuttableSourceBaseoperator= (const PuttableSourceBase &)=delete
 
 PuttableSourceBase (ParameterSet const &, InputSourceDescription const &)
 
 PuttableSourceBase (const PuttableSourceBase &)=delete
 
void registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
 
void registerProducts () final
 Register any produced products. More...
 
void resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
 
- Public Member Functions inherited from edm::InputSource
std::shared_ptr< ActivityRegistryactReg () const
 Accessor for Activity Registry. More...
 
std::shared_ptr< BranchIDListHelper const > branchIDListHelper () const
 Accessors for branchIDListHelper. More...
 
std::shared_ptr< BranchIDListHelper > & branchIDListHelper ()
 
void closeFile (FileBlock *, bool cleaningUpAfterException)
 close current file More...
 
void doBeginJob ()
 Called by framework at beginning of job. More...
 
void doEndJob ()
 Called by framework at end of job. More...
 
void fillProcessBlockHelper ()
 Fill the ProcessBlockHelper with info for the current file. More...
 
ProcessingController::ForwardState forwardState () const
 
bool goToEvent (EventID const &eventID)
 
 InputSource (ParameterSet const &, InputSourceDescription const &)
 Constructor. More...
 
 InputSource (InputSource const &)=delete
 
void issueReports (EventID const &eventID, StreamID streamID)
 issue an event report More...
 
LuminosityBlockNumber_t luminosityBlock () const
 Accessor for current luminosity block number. More...
 
std::shared_ptr< LuminosityBlockAuxiliaryluminosityBlockAuxiliary () const
 Called by the framework to merge or insert lumi in principal cache. More...
 
int maxEvents () const
 
int maxLuminosityBlocks () const
 
ModuleDescription const & moduleDescription () const
 Accessor for 'module' description. More...
 
ItemTypeInfo nextItemType ()
 Advances the source to the next item. More...
 
bool nextProcessBlock (ProcessBlockPrincipal &)
 Next process block, return false if there is none, sets the processName in the principal. More...
 
InputSourceoperator= (InputSource const &)=delete
 
std::shared_ptr< ProcessBlockHelper const > processBlockHelper () const
 Accessors for processBlockHelper. More...
 
std::shared_ptr< ProcessBlockHelper > & processBlockHelper ()
 
ProcessConfiguration const & processConfiguration () const
 Accessor for Process Configuration. More...
 
std::string const & processGUID () const
 Accessor for global process identifier. More...
 
ProcessHistoryRegistry const & processHistoryRegistry () const
 Accessors for process history registry. More...
 
ProcessHistoryRegistryprocessHistoryRegistry ()
 
ProcessingMode processingMode () const
 RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...
 
std::shared_ptr< ProductRegistry const > productRegistry () const
 Accessors for product registry. More...
 
bool randomAccess () const
 
void readAndMergeLumi (LuminosityBlockPrincipal &lbp)
 Read next luminosity block (same as a prior lumi) More...
 
void readAndMergeRun (RunPrincipal &rp)
 Read next run (same as a prior run) More...
 
void readEvent (EventPrincipal &ep, StreamContext &)
 Read next event. More...
 
bool readEvent (EventPrincipal &ep, EventID const &, StreamContext &)
 Read a specific event. More...
 
std::shared_ptr< FileBlockreadFile ()
 Read next file. More...
 
void readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
 Read next luminosity block (new lumi) More...
 
std::shared_ptr< LuminosityBlockAuxiliaryreadLuminosityBlockAuxiliary ()
 Read next luminosity block Auxilary. More...
 
void readProcessBlock (ProcessBlockPrincipal &)
 Read next process block. More...
 
void readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
 Read next run (new run) More...
 
std::shared_ptr< RunAuxiliaryreadRunAuxiliary ()
 Read next run Auxiliary. More...
 
ProcessHistoryID const & reducedProcessHistoryID () const
 
int remainingEvents () const
 
int remainingLuminosityBlocks () const
 
void repeat ()
 Reset the remaining number of events/lumis to the maximum number. More...
 
std::pair< SharedResourcesAcquirer *, std::recursive_mutex * > resourceSharedWithDelayedReader ()
 Returns nullptr if no resource shared between the Source and a DelayedReader. More...
 
ProcessingController::ReverseState reverseState () const
 
void rewind ()
 Begin again at the first event. More...
 
RunNumber_t run () const
 Accessor for current run number. More...
 
std::shared_ptr< RunAuxiliaryrunAuxiliary () const
 Called by the framework to merge or insert run in principal cache. More...
 
void setLuminosityBlockNumber_t (LuminosityBlockNumber_t lb)
 Set the luminosity block ID. More...
 
void setRunNumber (RunNumber_t r)
 Set the run number. More...
 
void skipEvents (int offset)
 
void switchTo (std::shared_ptr< ProductRegistry > iOther)
 switch to a different ProductRegistry. More...
 
std::shared_ptr< ThinnedAssociationsHelper const > thinnedAssociationsHelper () const
 Accessors for thinnedAssociationsHelper. More...
 
std::shared_ptr< ThinnedAssociationsHelper > & thinnedAssociationsHelper ()
 
Timestamp const & timestamp () const
 Accessor for the current time, as seen by the input source. More...
 
virtual ~InputSource () noexcept(false)
 Destructor. More...
 
- Public Member Functions inherited from edm::ProducerBase
void callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
 
std::vector< edm::ProductResolverIndex > const & indiciesForPutProducts (BranchType iBranchType) const
 
 ProducerBase ()
 
std::vector< edm::ProductResolverIndex > const & putTokenIndexToProductResolverIndex () const
 
std::vector< bool > const & recordProvenanceList () const
 
void registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
 
std::function< void(BranchDescription const &)> registrationCallback () const
 used by the fwk to register list of products More...
 
void resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
 
TypeLabelList const & typeLabelList () const
 used by the fwk to register the list of products of this module More...
 
 ~ProducerBase () noexcept(false) override
 

Private Types

enum  {
  kDoNotThrow = 0, kConstructor = 1, kBeginJob = 2, kBeginRun = 3,
  kBeginLumi = 4, kEndLumi = 5, kEndRun = 6, kEndJob = 7,
  kGetNextItemType = 8, kReadEvent = 9, kReadLuminosityBlockAuxiliary = 10, kReadRunAuxiliary = 11,
  kReadFile = 12, kCloseFile = 13, kDestructor = 14
}
 

Private Member Functions

void produce (Event &) override
 
bool setRunAndEventInfo (EventID &id, TimeValue_t &time, edm::EventAuxiliary::ExperimentType &eType) override
 

Private Attributes

int whenToThrow_
 

Additional Inherited Members

- Public Types inherited from edm::InputSource
enum  ItemPosition : char { ItemPosition::Invalid, ItemPosition::LastItemToBeMerged, ItemPosition::NotLastItemToBeMerged }
 
enum  ItemType : char {
  ItemType::IsInvalid, ItemType::IsStop, ItemType::IsFile, ItemType::IsRun,
  ItemType::IsLumi, ItemType::IsEvent, ItemType::IsRepeat, ItemType::IsSynchronize
}
 
enum  ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
 
- Public Types inherited from edm::ProducerBase
template<typename T >
using BranchAliasSetterT = ProductRegistryHelper::BranchAliasSetterT< T >
 
using ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex > >
 
typedef ProductRegistryHelper::TypeLabelList TypeLabelList
 
- Static Public Member Functions inherited from edm::IDGeneratorSourceBase< PuttableSourceBase >
static void fillDescription (ParameterSetDescription &desc)
 
- Static Public Member Functions inherited from edm::InputSource
static const std::string & baseType ()
 
static void fillDescription (ParameterSetDescription &desc)
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &)
 
- Public Attributes inherited from edm::InputSource
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)> postEventReadFromSourceSignal_
 
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)> preEventReadFromSourceSignal_
 
- Protected Member Functions inherited from edm::IDGeneratorSourceBase< PuttableSourceBase >
void doReadEvent (EventPrincipal &eventPrincipal, F &&f)
 
void doReadEventWithDelayedReader (EventPrincipal &eventPrincipal, ProcessHistoryID const &historyID, EventSelectionIDVector eventSelectionIDs, BranchListIndexes branchListIndexes, DelayedReader *reader)
 
- Protected Member Functions inherited from edm::InputSource
void decreaseRemainingEventsBy (int iSkipped)
 
bool eventCached () const
 
bool newLumi () const
 
bool newRun () const
 
ProcessHistoryRegistryprocessHistoryRegistryForUpdate ()
 
ProductRegistryproductRegistryUpdate ()
 
void reset () const
 
void resetEventCached ()
 
void resetLuminosityBlockAuxiliary (bool isNewLumi=true) const
 
void resetNewLumi ()
 
void resetNewRun ()
 
void resetRunAuxiliary (bool isNewRun=true) const
 
void setEventCached ()
 Called by the framework to merge or ached() const {return eventCached_;}. More...
 
void setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)
 
void setNewLumi ()
 
void setNewRun ()
 
void setRunAuxiliary (RunAuxiliary *rp)
 
void setTimestamp (Timestamp const &theTime)
 To set the current time, as seen by the input source. More...
 
ItemTypeInfo state () const
 
- Protected Member Functions inherited from edm::ProducerBase
template<Transition Tr = Transition::Event>
auto produces (std::string instanceName) noexcept
 declare what type of product will make and with which optional label More...
 
template<Transition B>
BranchAliasSetter produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
 
template<BranchType B>
BranchAliasSetter produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
 
BranchAliasSetter produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
 
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<class ProductType >
BranchAliasSetterT< ProductType > produces ()
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces ()
 
template<class ProductType >
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType > produces ()
 
template<Transition Tr = Transition::Event>
auto produces () noexcept
 
ProducesCollector producesCollector ()
 

Detailed Description

Definition at line 10 of file ThrowingSource.cc.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
kDoNotThrow 
kConstructor 
kBeginJob 
kBeginRun 
kBeginLumi 
kEndLumi 
kEndRun 
kEndJob 
kGetNextItemType 
kReadEvent 
kReadLuminosityBlockAuxiliary 
kReadRunAuxiliary 
kReadFile 
kCloseFile 
kDestructor 

Definition at line 26 of file ThrowingSource.cc.

Constructor & Destructor Documentation

◆ ThrowingSource()

edm::ThrowingSource::ThrowingSource ( ParameterSet const &  pset,
InputSourceDescription const &  desc 
)
explicit

Definition at line 50 of file ThrowingSource.cc.

References Exception, kConstructor, and whenToThrow_.

51  : ProducerSourceBase(pset, desc, false),
52  whenToThrow_(pset.getUntrackedParameter<int>("whenToThrow", kDoNotThrow)) {
54  throw cms::Exception("TestThrow") << "ThrowingSource constructor";
55  }
ProducerSourceBase(ParameterSet const &pset, InputSourceDescription const &desc, bool realData)

◆ ~ThrowingSource()

edm::ThrowingSource::~ThrowingSource ( )
overridenoexcept

Definition at line 57 of file ThrowingSource.cc.

References Exception, kDestructor, and whenToThrow_.

57  {
59  throw cms::Exception("TestThrow") << "ThrowingSource destructor";
60  }

Member Function Documentation

◆ beginJob()

void edm::ThrowingSource::beginJob ( void  )
overridevirtual

Begin protected makes it easier to do template programming.

Reimplemented from edm::InputSource.

Definition at line 66 of file ThrowingSource.cc.

References Exception, kBeginJob, and whenToThrow_.

66  {
67  if (whenToThrow_ == kBeginJob)
68  throw cms::Exception("TestThrow") << "ThrowingSource::beginJob";
69  }

◆ beginLuminosityBlock()

void edm::ThrowingSource::beginLuminosityBlock ( edm::LuminosityBlock lb)
overridevirtual

Reimplemented from edm::PuttableSourceBase.

Definition at line 76 of file ThrowingSource.cc.

References Exception, kBeginLumi, and whenToThrow_.

76  {
77  if (whenToThrow_ == kBeginLumi)
78  throw cms::Exception("TestThrow") << "ThrowingSource::beginLuminosityBlock";
79  }

◆ beginRun()

void edm::ThrowingSource::beginRun ( edm::Run run)
overridevirtual

Reimplemented from edm::PuttableSourceBase.

Definition at line 81 of file ThrowingSource.cc.

References Exception, kBeginRun, and whenToThrow_.

81  {
82  if (whenToThrow_ == kBeginRun)
83  throw cms::Exception("TestThrow") << "ThrowingSource::beginRun";
84  }

◆ closeFile_()

void edm::ThrowingSource::closeFile_ ( )
overridevirtual

Reimplemented from edm::InputSource.

Definition at line 92 of file ThrowingSource.cc.

References Exception, kCloseFile, and whenToThrow_.

92  {
93  if (whenToThrow_ == kCloseFile)
94  throw cms::Exception("TestThrow") << "ThrowingSource::closeFile_";
95  }

◆ endJob()

void edm::ThrowingSource::endJob ( void  )
overridevirtual

Reimplemented from edm::InputSource.

Definition at line 71 of file ThrowingSource.cc.

References Exception, kEndJob, and whenToThrow_.

71  {
72  if (whenToThrow_ == kEndJob)
73  throw cms::Exception("TestThrow") << "ThrowingSource::endJob";
74  }

◆ produce()

void edm::ThrowingSource::produce ( edm::Event )
overrideprivatevirtual

Implements edm::ProducerSourceBase.

Definition at line 64 of file ThrowingSource.cc.

64 {}

◆ readEvent_()

void edm::ThrowingSource::readEvent_ ( edm::EventPrincipal eventPrincipal)
overridevirtual

Implements edm::InputSource.

Definition at line 116 of file ThrowingSource.cc.

References cms::cuda::assert(), printConversionInfo::aux, edm::InputSource::eventCached(), edm::IDGeneratorSourceBase< PuttableSourceBase >::eventID(), Exception, edm::EventPrincipal::fillEventPrincipal(), edm::ProcessHistoryRegistry::getMapped(), isotrackTrainRegressor::history, kReadEvent, edm::IDGeneratorSourceBase< PuttableSourceBase >::presentTime(), edm::InputSource::processGUID(), edm::InputSource::processHistoryRegistry(), edm::InputSource::processingMode(), edm::InputSource::RunsLumisAndEvents, edm::EventAuxiliary::Undefined, and whenToThrow_.

116  {
117  if (whenToThrow_ == kReadEvent)
118  throw cms::Exception("TestThrow") << "ThrowingSource::readEvent_";
120  EventAuxiliary aux(eventID(), processGUID(), Timestamp(presentTime()), false, EventAuxiliary::Undefined);
121  auto history = processHistoryRegistry().getMapped(aux.processHistoryID());
122  eventPrincipal.fillEventPrincipal(aux, history);
123  }
assert(be >=bs)
std::string const & processGUID() const
Accessor for global process identifier.
Definition: InputSource.h:226
bool eventCached() const
Definition: InputSource.h:389
ProcessHistoryRegistry const & processHistoryRegistry() const
Accessors for process history registry.
Definition: InputSource.h:168
bool getMapped(ProcessHistoryID const &key, ProcessHistory &value) const
void fillEventPrincipal(EventAuxiliary const &aux, ProcessHistory const *processHistory, DelayedReader *reader=nullptr)
ProcessingMode processingMode() const
RunsLumisAndEvents (default), RunsAndLumis, or Runs.
Definition: InputSource.h:255

◆ readFile_()

std::shared_ptr< FileBlock > edm::ThrowingSource::readFile_ ( )
overridevirtual

Reimplemented from edm::InputSource.

Definition at line 86 of file ThrowingSource.cc.

References Exception, kReadFile, and whenToThrow_.

86  {
87  if (whenToThrow_ == kReadFile)
88  throw cms::Exception("TestThrow") << "ThrowingSource::readFile_";
89  return std::make_shared<FileBlock>();
90  }

◆ readLuminosityBlockAuxiliary_()

std::shared_ptr< LuminosityBlockAuxiliary > edm::ThrowingSource::readLuminosityBlockAuxiliary_ ( )
overridevirtual

Implements edm::InputSource.

Definition at line 105 of file ThrowingSource.cc.

References edm::IDGeneratorSourceBase< PuttableSourceBase >::eventID(), Exception, edm::Timestamp::invalidTimestamp(), kReadLuminosityBlockAuxiliary, edm::EventID::luminosityBlock(), edm::IDGeneratorSourceBase< PuttableSourceBase >::presentTime(), edm::InputSource::processingMode(), edm::InputSource::resetNewLumi(), edm::EventID::run(), edm::InputSource::Runs, and whenToThrow_.

105  {
107  throw cms::Exception("TestThrow") << "ThrowingSource::readLuminosityBlockAuxiliary_";
108  if (processingMode() == Runs)
109  return std::shared_ptr<LuminosityBlockAuxiliary>();
111  resetNewLumi();
112  return std::make_shared<LuminosityBlockAuxiliary>(
114  }
static Timestamp invalidTimestamp()
Definition: Timestamp.h:75
LuminosityBlockNumber_t luminosityBlock() const
Definition: EventID.h:39
RunNumber_t run() const
Definition: EventID.h:38
ProcessingMode processingMode() const
RunsLumisAndEvents (default), RunsAndLumis, or Runs.
Definition: InputSource.h:255

◆ readRunAuxiliary_()

std::shared_ptr< RunAuxiliary > edm::ThrowingSource::readRunAuxiliary_ ( )
overridevirtual

◆ setRunAndEventInfo()

bool edm::ThrowingSource::setRunAndEventInfo ( EventID id,
TimeValue_t time,
edm::EventAuxiliary::ExperimentType eType 
)
overrideprivatevirtual

Implements edm::IDGeneratorSourceBase< PuttableSourceBase >.

Definition at line 62 of file ThrowingSource.cc.

62 { return true; }

Member Data Documentation

◆ whenToThrow_

int edm::ThrowingSource::whenToThrow_
private