CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
edm::ProducerSourceBase Class Referenceabstract

#include <ProducerSourceBase.h>

Inheritance diagram for edm::ProducerSourceBase:
edm::InputSource edm::ProductRegistryHelper cond::EmptyIOVSource edm::EmptySource edm::ProducerSourceFromFiles LmfSource AlpgenSource edm::MCFileSource FRDStreamSource HcalTBSource L1MuGMTHWFileReader LHESource MCatNLOSource PixelSLinkDataInputSource

Public Member Functions

EventNumber_t event () const
 
unsigned int eventCreationDelay () const
 
EventID const & eventID () const
 
LuminosityBlockNumber_t luminosityBlock () const
 
unsigned int numberEventsInLumi () const
 
unsigned int numberEventsInRun () const
 
unsigned int numberEventsInThisLumi () const
 
unsigned int numberEventsInThisRun () const
 
TimeValue_t presentTime () const
 
 ProducerSourceBase (ParameterSet const &pset, InputSourceDescription const &desc, bool realData)
 
RunNumber_t run () const
 
unsigned int timeBetweenEvents () const
 
virtual ~ProducerSourceBase ()
 
- 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 doBeginLumi (LuminosityBlockPrincipal &lbp, ProcessContext const *)
 Called by framework at beginning of lumi block. More...
 
void doBeginRun (RunPrincipal &rp, ProcessContext const *)
 Called by framework at beginning of run. More...
 
void doEndJob ()
 Called by framework at end of job. More...
 
void doEndLumi (LuminosityBlockPrincipal &lbp, bool cleaningUpAfterException, ProcessContext const *)
 Called by framework at end of lumi block. More...
 
void doEndRun (RunPrincipal &rp, bool cleaningUpAfterException, ProcessContext const *)
 Called by framework at end of run. More...
 
void doPostForkReacquireResources (std::shared_ptr< multicore::MessageReceiverForSource >)
 
void doPreForkReleaseResources ()
 Called by the framework before forking the process. 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)
 issue an event report More...
 
LuminosityBlockNumber_t luminosityBlock () const
 Accessor for current luminosity block number. More...
 
std::shared_ptr
< LuminosityBlockAuxiliary
luminosityBlockAuxiliary () 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...
 
ItemType nextItemType ()
 Advances the source to the next item. More...
 
InputSourceoperator= (InputSource const &)=delete
 
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...
 
std::shared_ptr
< ProductRegistry > & 
productRegistry ()
 
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::unique_ptr< FileBlockreadFile ()
 Read next file. More...
 
void readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
 Read next luminosity block (new lumi) More...
 
std::shared_ptr
< LuminosityBlockAuxiliary
readLuminosityBlockAuxiliary ()
 Read next luminosity block Auxilary. 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
 
void registerProducts ()
 Register any produced products. More...
 
int remainingEvents () const
 
int remainingLuminosityBlocks () const
 
void repeat ()
 Reset the remaining number of events/lumis to the maximum number. More...
 
SharedResourcesAcquirerresourceSharedWithDelayedReader ()
 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)
 
bool skipForForking ()
 
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 ()
 Destructor. More...
 

Static Public Member Functions

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 advanceToNext (EventID &eventID, TimeValue_t &time)
 
virtual void beginJob () override
 
virtual void beginLuminosityBlock (LuminosityBlock &) override
 
virtual void beginRun (Run &) override
 
virtual void endLuminosityBlock (LuminosityBlock &) override
 
virtual void endRun (Run &) override
 
virtual size_t fileIndex () const
 
virtual ItemType getNextItemType () overridefinal
 
virtual void initialize (EventID &id, TimeValue_t &time, TimeValue_t &interval)
 
virtual bool noFiles () const
 
virtual void produce (Event &e)=0
 
virtual void readEvent_ (EventPrincipal &eventPrincipal) override
 
virtual std::shared_ptr
< LuminosityBlockAuxiliary
readLuminosityBlockAuxiliary_ () override
 
virtual std::shared_ptr
< RunAuxiliary
readRunAuxiliary_ () override
 
void retreatToPrevious (EventID &eventID, TimeValue_t &time)
 
virtual void rewind_ () override
 
virtual bool setRunAndEventInfo (EventID &id, TimeValue_t &time, EventAuxiliary::ExperimentType &etype)=0
 
virtual void skip (int offset) override
 

Private Attributes

EventAuxiliary::ExperimentType eType_
 
unsigned int eventCreationDelay_
 
EventID eventID_
 
bool isRealData_
 
unsigned int numberEventsInLumi_
 
unsigned int numberEventsInRun_
 
unsigned int numberEventsInThisLumi_
 
unsigned int numberEventsInThisRun_
 
EventID origEventID_
 
TimeValue_t origTime_
 
TimeValue_t presentTime_
 
TimeValue_t timeBetweenEvents_
 
EventNumber_t const zerothEvent_
 

Additional Inherited Members

- Public Types inherited from edm::InputSource
enum  ItemType {
  IsInvalid, IsStop, IsFile, IsRun,
  IsLumi, IsEvent, IsRepeat, IsSynchronize
}
 
enum  ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
 
typedef
ProductRegistryHelper::TypeLabelList 
TypeLabelList
 
- 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...
 
ItemType state () const
 

Detailed Description

Definition at line 20 of file ProducerSourceBase.h.

Constructor & Destructor Documentation

edm::ProducerSourceBase::ProducerSourceBase ( ParameterSet const &  pset,
InputSourceDescription const &  desc,
bool  realData 
)
explicit

Definition at line 19 of file ProducerSourceBase.cc.

edm::ProducerSourceBase::~ProducerSourceBase ( )
virtual

Definition at line 42 of file ProducerSourceBase.cc.

Member Function Documentation

void edm::ProducerSourceBase::advanceToNext ( EventID eventID,
TimeValue_t time 
)
private

Definition at line 174 of file ProducerSourceBase.cc.

void edm::ProducerSourceBase::beginJob ( void  )
overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 92 of file ProducerSourceBase.cc.

void edm::ProducerSourceBase::beginLuminosityBlock ( LuminosityBlock )
overrideprivatevirtual

Reimplemented from edm::InputSource.

Reimplemented in FRDStreamSource.

Definition at line 107 of file ProducerSourceBase.cc.

void edm::ProducerSourceBase::beginRun ( Run )
overrideprivatevirtual

Reimplemented from edm::InputSource.

Reimplemented in MCatNLOSource, AlpgenSource, LHESource, and FRDStreamSource.

Definition at line 99 of file ProducerSourceBase.cc.

void edm::ProducerSourceBase::endLuminosityBlock ( LuminosityBlock )
overrideprivatevirtual

Reimplemented from edm::InputSource.

Reimplemented in FRDStreamSource.

Definition at line 111 of file ProducerSourceBase.cc.

void edm::ProducerSourceBase::endRun ( Run )
overrideprivatevirtual

Reimplemented from edm::InputSource.

Reimplemented in LHESource, and FRDStreamSource.

Definition at line 103 of file ProducerSourceBase.cc.

EventNumber_t edm::ProducerSourceBase::event ( ) const
inline

Definition at line 34 of file ProducerSourceBase.h.

References edm::EventID::event(), and eventID_.

34 {return eventID_.event();}
EventNumber_t event() const
Definition: EventID.h:41
unsigned int edm::ProducerSourceBase::eventCreationDelay ( ) const
inline

Definition at line 29 of file ProducerSourceBase.h.

References eventCreationDelay_.

29 {return eventCreationDelay_;}
EventID const& edm::ProducerSourceBase::eventID ( ) const
inline

Definition at line 32 of file ProducerSourceBase.h.

References eventID_.

32 {return eventID_;}
size_t edm::ProducerSourceBase::fileIndex ( ) const
privatevirtual

Definition at line 225 of file ProducerSourceBase.cc.

void edm::ProducerSourceBase::fillDescription ( ParameterSetDescription desc)
static
InputSource::ItemType edm::ProducerSourceBase::getNextItemType ( )
finaloverrideprivatevirtual

Implements edm::InputSource.

Definition at line 129 of file ProducerSourceBase.cc.

void edm::ProducerSourceBase::initialize ( EventID id,
TimeValue_t time,
TimeValue_t interval 
)
privatevirtual

Reimplemented in cond::EmptyIOVSource.

Definition at line 115 of file ProducerSourceBase.cc.

LuminosityBlockNumber_t edm::ProducerSourceBase::luminosityBlock ( ) const
inline
bool edm::ProducerSourceBase::noFiles ( ) const
privatevirtual

Reimplemented in edm::ProducerSourceFromFiles.

Definition at line 220 of file ProducerSourceBase.cc.

unsigned int edm::ProducerSourceBase::numberEventsInLumi ( ) const
inline

Definition at line 26 of file ProducerSourceBase.h.

References numberEventsInLumi_.

26 {return numberEventsInLumi_;}
unsigned int edm::ProducerSourceBase::numberEventsInRun ( ) const
inline

Definition at line 25 of file ProducerSourceBase.h.

References numberEventsInRun_.

25 {return numberEventsInRun_;}
unsigned int edm::ProducerSourceBase::numberEventsInThisLumi ( ) const
inline

Definition at line 31 of file ProducerSourceBase.h.

References numberEventsInThisLumi_.

unsigned int numberEventsInThisLumi_
unsigned int edm::ProducerSourceBase::numberEventsInThisRun ( ) const
inline

Definition at line 30 of file ProducerSourceBase.h.

References numberEventsInThisRun_.

30 {return numberEventsInThisRun_;}
unsigned int numberEventsInThisRun_
TimeValue_t edm::ProducerSourceBase::presentTime ( ) const
inline

Definition at line 27 of file ProducerSourceBase.h.

References presentTime_.

Referenced by HcalTBSource::setRunAndEventInfo().

27 {return presentTime_;}
virtual void edm::ProducerSourceBase::produce ( Event e)
privatepure virtual
void edm::ProducerSourceBase::readEvent_ ( EventPrincipal eventPrincipal)
overrideprivatevirtual

Implements edm::InputSource.

Reimplemented in LHESource.

Definition at line 61 of file ProducerSourceBase.cc.

std::shared_ptr< LuminosityBlockAuxiliary > edm::ProducerSourceBase::readLuminosityBlockAuxiliary_ ( )
overrideprivatevirtual

Implements edm::InputSource.

Definition at line 53 of file ProducerSourceBase.cc.

std::shared_ptr< RunAuxiliary > edm::ProducerSourceBase::readRunAuxiliary_ ( )
overrideprivatevirtual

Implements edm::InputSource.

Definition at line 46 of file ProducerSourceBase.cc.

void edm::ProducerSourceBase::retreatToPrevious ( EventID eventID,
TimeValue_t time 
)
private

Definition at line 196 of file ProducerSourceBase.cc.

void edm::ProducerSourceBase::rewind_ ( )
overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 119 of file ProducerSourceBase.cc.

RunNumber_t edm::ProducerSourceBase::run ( void  ) const
inline

Definition at line 33 of file ProducerSourceBase.h.

References eventID_, and edm::EventID::run().

33 {return eventID_.run();}
RunNumber_t run() const
Definition: EventID.h:39
virtual bool edm::ProducerSourceBase::setRunAndEventInfo ( EventID id,
TimeValue_t time,
EventAuxiliary::ExperimentType etype 
)
privatepure virtual
void edm::ProducerSourceBase::skip ( int  offset)
overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 72 of file ProducerSourceBase.cc.

unsigned int edm::ProducerSourceBase::timeBetweenEvents ( ) const
inline

Definition at line 28 of file ProducerSourceBase.h.

References timeBetweenEvents_.

Referenced by HcalTBSource::setRunAndEventInfo().

28 {return timeBetweenEvents_;}

Member Data Documentation

EventAuxiliary::ExperimentType edm::ProducerSourceBase::eType_
private

Definition at line 75 of file ProducerSourceBase.h.

unsigned int edm::ProducerSourceBase::eventCreationDelay_
private

Definition at line 67 of file ProducerSourceBase.h.

Referenced by eventCreationDelay().

EventID edm::ProducerSourceBase::eventID_
private

Definition at line 72 of file ProducerSourceBase.h.

Referenced by event(), eventID(), luminosityBlock(), and run().

bool edm::ProducerSourceBase::isRealData_
private

Definition at line 74 of file ProducerSourceBase.h.

unsigned int edm::ProducerSourceBase::numberEventsInLumi_
private

Definition at line 63 of file ProducerSourceBase.h.

Referenced by numberEventsInLumi().

unsigned int edm::ProducerSourceBase::numberEventsInRun_
private

Definition at line 62 of file ProducerSourceBase.h.

Referenced by numberEventsInRun().

unsigned int edm::ProducerSourceBase::numberEventsInThisLumi_
private

Definition at line 70 of file ProducerSourceBase.h.

Referenced by numberEventsInThisLumi().

unsigned int edm::ProducerSourceBase::numberEventsInThisRun_
private

Definition at line 69 of file ProducerSourceBase.h.

Referenced by numberEventsInThisRun().

EventID edm::ProducerSourceBase::origEventID_
private

Definition at line 73 of file ProducerSourceBase.h.

TimeValue_t edm::ProducerSourceBase::origTime_
private

Definition at line 65 of file ProducerSourceBase.h.

TimeValue_t edm::ProducerSourceBase::presentTime_
private

Definition at line 64 of file ProducerSourceBase.h.

Referenced by presentTime().

TimeValue_t edm::ProducerSourceBase::timeBetweenEvents_
private

Definition at line 66 of file ProducerSourceBase.h.

Referenced by timeBetweenEvents().

EventNumber_t const edm::ProducerSourceBase::zerothEvent_
private

Definition at line 71 of file ProducerSourceBase.h.