CMS 3D CMS Logo

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
edmtest::ThingExtSource Class Reference

#include <ThingExtSource.h>

Inheritance diagram for edmtest::ThingExtSource:
edm::ProducerSourceFromFiles edm::ProducerSourceBase edm::FromFiles edm::IDGeneratorSourceBase< PuttableSourceBase > edm::PuttableSourceBase edm::InputSource edm::ProducerBase edm::ProductRegistryHelper

Public Member Functions

void beginLuminosityBlock (edm::LuminosityBlock &lb) override
 
void beginRun (edm::Run &r) override
 
void produce (edm::Event &e) override
 
bool setRunAndEventInfo (edm::EventID &, edm::TimeValue_t &, edm::EventAuxiliary::ExperimentType &) override
 
 ThingExtSource (edm::ParameterSet const &pset, edm::InputSourceDescription const &desc)
 
 ~ThingExtSource () override
 
- Public Member Functions inherited from edm::ProducerSourceFromFiles
InputFileCatalogcatalog ()
 
std::vector< std::string > fileNames (unsigned iCatalog) const
 
std::vector< std::string > const & logicalFileNames () const
 
 ProducerSourceFromFiles (ParameterSet const &pset, InputSourceDescription const &desc, bool realData)
 
 ~ProducerSourceFromFiles () 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
 

Static Public Member Functions

static void fillDescriptions (edm::ConfigurationDescriptions &descriptions)
 
- Static Public Member Functions inherited from edm::ProducerSourceFromFiles
static void fillDescription (ParameterSetDescription &desc)
 
- 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 &)
 

Private Member Functions

void endLuminosityBlock (edm::LuminosityBlock &lb)
 
void endRun (edm::Run &r)
 

Private Attributes

ThingAlgorithm alg_
 

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
 
- 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::ProducerSourceFromFiles
void incrementFileIndex ()
 
- 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 17 of file ThingExtSource.h.

Constructor & Destructor Documentation

◆ ThingExtSource()

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

Definition at line 9 of file ThingExtSource.cc.

10  : ProducerSourceFromFiles(pset, desc, true), alg_() {
11  produces<ThingCollection>();
12  produces<ThingCollection, edm::Transition::BeginLuminosityBlock>("beginLumi");
13  produces<ThingCollection, edm::Transition::BeginLuminosityBlock>("endLumi");
14  produces<ThingCollection, edm::Transition::BeginRun>("beginRun");
15  produces<ThingCollection, edm::Transition::BeginRun>("endRun");
16  }
ProducerSourceFromFiles(ParameterSet const &pset, InputSourceDescription const &desc, bool realData)

◆ ~ThingExtSource()

ThingExtSource::~ThingExtSource ( )
override

Definition at line 19 of file ThingExtSource.cc.

19 {}

Member Function Documentation

◆ beginLuminosityBlock()

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

Reimplemented from edm::PuttableSourceBase.

Definition at line 43 of file ThingExtSource.cc.

References alg_, endLuminosityBlock(), eostools::move(), edm::LuminosityBlock::put(), mps_fire::result, and edmtest::ThingAlgorithm::run().

43  {
44  // Step A: Get Inputs
45 
46  // Step B: Create empty output
47  auto result = std::make_unique<ThingCollection>(); //Empty
48 
49  // Step C: Invoke the algorithm, passing in inputs (NONE) and getting back outputs.
50  alg_.run(*result);
51 
52  // Step D: Put outputs into lumi block
53  lb.put(std::move(result), "beginLumi");
54 
56  }
void put(std::unique_ptr< PROD > product)
Put a new product.
void endLuminosityBlock(edm::LuminosityBlock &lb)
void run(ThingCollection &thingCollection) const
def move(src, dest)
Definition: eostools.py:511

◆ beginRun()

void ThingExtSource::beginRun ( edm::Run r)
overridevirtual

Reimplemented from edm::PuttableSourceBase.

Definition at line 72 of file ThingExtSource.cc.

References alg_, endRun(), eostools::move(), mps_fire::result, and edmtest::ThingAlgorithm::run().

72  {
73  // Step A: Get Inputs
74 
75  // Step B: Create empty output
76  auto result = std::make_unique<ThingCollection>(); //Empty
77 
78  // Step C: Invoke the algorithm, passing in inputs (NONE) and getting back outputs.
79  alg_.run(*result);
80 
81  // Step D: Put outputs into event
82  r.put(std::move(result), "beginRun");
83 
84  endRun(r);
85  }
void endRun(edm::Run &r)
void run(ThingCollection &thingCollection) const
def move(src, dest)
Definition: eostools.py:511

◆ endLuminosityBlock()

void ThingExtSource::endLuminosityBlock ( edm::LuminosityBlock lb)
private

Definition at line 58 of file ThingExtSource.cc.

References alg_, eostools::move(), edm::LuminosityBlock::put(), mps_fire::result, and edmtest::ThingAlgorithm::run().

Referenced by beginLuminosityBlock().

58  {
59  // Step A: Get Inputs
60 
61  // Step B: Create empty output
62  auto result = std::make_unique<ThingCollection>(); //Empty
63 
64  // Step C: Invoke the algorithm, passing in inputs (NONE) and getting back outputs.
65  alg_.run(*result);
66 
67  // Step D: Put outputs into lumi block
68  lb.put(std::move(result), "endLumi");
69  }
void put(std::unique_ptr< PROD > product)
Put a new product.
void run(ThingCollection &thingCollection) const
def move(src, dest)
Definition: eostools.py:511

◆ endRun()

void ThingExtSource::endRun ( edm::Run r)
private

Definition at line 87 of file ThingExtSource.cc.

References alg_, eostools::move(), mps_fire::result, and edmtest::ThingAlgorithm::run().

Referenced by beginRun().

87  {
88  // Step A: Get Inputs
89 
90  // Step B: Create empty output
91  auto result = std::make_unique<ThingCollection>(); //Empty
92 
93  // Step C: Invoke the algorithm, passing in inputs (NONE) and getting back outputs.
94  alg_.run(*result);
95 
96  // Step D: Put outputs into event
97  r.put(std::move(result), "endRun");
98  }
void run(ThingCollection &thingCollection) const
def move(src, dest)
Definition: eostools.py:511

◆ fillDescriptions()

void ThingExtSource::fillDescriptions ( edm::ConfigurationDescriptions descriptions)
static

Definition at line 100 of file ThingExtSource.cc.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, and edm::ProducerSourceFromFiles::fillDescription().

100  {
102  desc.setComment("Creates ThingCollections from a file for testing.");
104  descriptions.add("source", desc);
105  }
static void fillDescription(ParameterSetDescription &desc)
void add(std::string const &label, ParameterSetDescription const &psetDescription)

◆ produce()

void ThingExtSource::produce ( edm::Event e)
overridevirtual

Implements edm::ProducerSourceBase.

Definition at line 29 of file ThingExtSource.cc.

References alg_, MillePedeFileConverter_cfg::e, eostools::move(), mps_fire::result, and edmtest::ThingAlgorithm::run().

29  {
30  // Step A: Get Inputs
31 
32  // Step B: Create empty output
33  auto result = std::make_unique<ThingCollection>(); //Empty
34 
35  // Step C: Invoke the algorithm, passing in inputs (NONE) and getting back outputs.
36  alg_.run(*result);
37 
38  // Step D: Put outputs into event
39  e.put(std::move(result));
40  }
void run(ThingCollection &thingCollection) const
def move(src, dest)
Definition: eostools.py:511

◆ setRunAndEventInfo()

bool ThingExtSource::setRunAndEventInfo ( edm::EventID ,
edm::TimeValue_t ,
edm::EventAuxiliary::ExperimentType  
)
overridevirtual

Implements edm::IDGeneratorSourceBase< PuttableSourceBase >.

Definition at line 22 of file ThingExtSource.cc.

References edm::IDGeneratorSourceBase< PuttableSourceBase >::event().

22  {
23  // Fake running out of data.
24  if (event() > 2)
25  return false;
26  return true;
27  }

Member Data Documentation

◆ alg_

ThingAlgorithm edmtest::ThingExtSource::alg_
private

Definition at line 41 of file ThingExtSource.h.

Referenced by beginLuminosityBlock(), beginRun(), endLuminosityBlock(), endRun(), and produce().