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 | Protected Member Functions | Private Member Functions | Private Attributes
edm::RawInputSource Class Referenceabstract

#include <RawInputSource.h>

Inheritance diagram for edm::RawInputSource:
edm::InputSource edm::ProductRegistryHelper edm::DQMHttpSource edm::RawInputSourceFromFiles edm::StreamerInputSource edm::EventStreamHttpReader edm::StreamerFileReader edm::StreamerInputModule< Producer >

Public Member Functions

 RawInputSource (ParameterSet const &pset, InputSourceDescription const &desc)
 
virtual ~RawInputSource ()
 
- Public Member Functions inherited from edm::InputSource
boost::shared_ptr
< ActivityRegistry
actReg () const
 Accessor for Activity Registry. More...
 
boost::shared_ptr
< BranchIDListHelper
branchIDListHelper () const
 Accessor for branchIDListHelper. More...
 
void closeFile (FileBlock *, bool cleaningUpAfterException)
 close current file More...
 
void doBeginJob ()
 Called by framework at beginning of job. More...
 
void doBeginLumi (LuminosityBlockPrincipal &lbp)
 Called by framework at beginning of lumi block. More...
 
void doBeginRun (RunPrincipal &rp)
 Called by framework at beginning of run. More...
 
void doEndJob ()
 Called by framework at end of job. More...
 
void doEndLumi (LuminosityBlockPrincipal &lbp, bool cleaningUpAfterException)
 Called by framework at end of lumi block. More...
 
void doEndRun (RunPrincipal &rp, bool cleaningUpAfterException)
 Called by framework at end of run. More...
 
void doPostForkReacquireResources (boost::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...
 
boost::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 ()
 
InputSourceoperator= (InputSource const &)=delete
 
bool primary () const
 Accessor for primary input source flag. More...
 
ProcessConfiguration const & processConfiguration () const
 Accessor for Process Configuration. More...
 
std::string const & processGUID () const
 Accessor for global process identifier. More...
 
ProcessingMode processingMode () const
 RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...
 
boost::shared_ptr
< ProductRegistry const > 
productRegistry () const
 Accessor for product registry. More...
 
bool randomAccess () const
 
boost::shared_ptr
< LuminosityBlockPrincipal
readAndCacheLumi (HistoryAppender &historyAppender)
 Read next luminosity block (new lumi) More...
 
boost::shared_ptr< RunPrincipalreadAndCacheRun (HistoryAppender &historyAppender)
 Read next run (new run) More...
 
void readAndMergeLumi (boost::shared_ptr< LuminosityBlockPrincipal > lbp)
 Read next luminosity block (same as a prior lumi) More...
 
void readAndMergeRun (boost::shared_ptr< RunPrincipal > rp)
 Read next run (same as a prior run) More...
 
EventPrincipalreadEvent (EventPrincipal &ep)
 
EventPrincipalreadEvent (EventPrincipal &ep, EventID const &)
 Read a specific event. More...
 
std::unique_ptr< FileBlockreadFile ()
 Read next file. More...
 
boost::shared_ptr
< LuminosityBlockAuxiliary
readLuminosityBlockAuxiliary ()
 Read next luminosity block Auxilary. More...
 
boost::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...
 
ProcessingController::ReverseState reverseState () const
 
void rewind ()
 Begin again at the first event. More...
 
RunNumber_t run () const
 Accessor for current run number. More...
 
boost::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 ()
 
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 &description)
 
- 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 &)
 

Protected Member Functions

virtual bool checkNextEvent ()=0
 
EventPrincipalmakeEvent (EventPrincipal &eventPrincipal, EventAuxiliary const &eventAuxiliary)
 
virtual EventPrincipalread (EventPrincipal &eventPrincipal)=0
 
void setInputFileTransitionsEachEvent ()
 
- Protected Member Functions inherited from edm::InputSource
void decreaseRemainingEventsBy (int iSkipped)
 
bool eventCached () const
 
boost::shared_ptr
< LuminosityBlockPrincipal >
const 
luminosityBlockPrincipal () const
 
bool newLumi () const
 
bool newRun () const
 
ProductRegistryproductRegistryUpdate () const
 
void reset () const
 
void resetEventCached ()
 
void resetLuminosityBlockAuxiliary (bool isNewLumi=true) const
 
void resetNewLumi ()
 
void resetNewRun ()
 
void resetRunAuxiliary (bool isNewRun=true) const
 
boost::shared_ptr
< RunPrincipal > const 
runPrincipal () 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...
 
virtual void skip (int offset)
 
ItemType state () const
 

Private Member Functions

virtual ItemType getNextItemType () override
 
virtual void preForkReleaseResources () override
 
virtual EventPrincipalreadEvent_ (EventPrincipal &eventPrincipal) override
 
virtual boost::shared_ptr
< LuminosityBlockAuxiliary
readLuminosityBlockAuxiliary_ () override
 
virtual boost::shared_ptr
< RunAuxiliary
readRunAuxiliary_ () override
 
virtual void reset_ ()
 
virtual void rewind_ () override
 

Private Attributes

bool inputFileTransitionsEachEvent_
 

Additional Inherited Members

- Public Types inherited from edm::InputSource
enum  ItemType {
  IsInvalid, IsStop, IsFile, IsRun,
  IsLumi, IsEvent, IsRepeat
}
 
enum  ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
 
typedef
ProductRegistryHelper::TypeLabelList 
TypeLabelList
 

Detailed Description

Definition at line 19 of file RawInputSource.h.

Constructor & Destructor Documentation

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

Definition at line 15 of file RawInputSource.cc.

References edm::Timestamp::beginOfTime(), and edm::InputSource::setTimestamp().

15  :
16  InputSource(pset, desc),
17  // The default value for the following parameter get defined in at least one derived class
18  // where it has a different default value.
19  inputFileTransitionsEachEvent_(pset.getUntrackedParameter<bool>("inputFileTransitionsEachEvent", false)) {
21  }
void setTimestamp(Timestamp const &theTime)
To set the current time, as seen by the input source.
Definition: InputSource.h:314
bool inputFileTransitionsEachEvent_
static Timestamp const & beginOfTime()
Definition: Timestamp.cc:96
InputSource(ParameterSet const &, InputSourceDescription const &)
Constructor.
Definition: InputSource.cc:55
edm::RawInputSource::~RawInputSource ( )
virtual

Definition at line 23 of file RawInputSource.cc.

23  {
24  }

Member Function Documentation

virtual bool edm::RawInputSource::checkNextEvent ( )
protectedpure virtual
void edm::RawInputSource::fillDescription ( ParameterSetDescription description)
static

Definition at line 110 of file RawInputSource.cc.

References edm::InputSource::fillDescription().

Referenced by edm::RawInputSourceFromFiles::fillDescription(), and edm::StreamerInputSource::fillDescription().

110  {
111  // The default value for "inputFileTransitionsEachEvent" gets defined in the derived class
112  // as it depends on the derived class. So, we cannot redefine it here.
113  InputSource::fillDescription(description);
114  }
static void fillDescription(ParameterSetDescription &desc)
Definition: InputSource.cc:134
InputSource::ItemType edm::RawInputSource::getNextItemType ( )
overrideprivatevirtual

Implements edm::InputSource.

Definition at line 65 of file RawInputSource.cc.

References checkNextEvent(), edm::InputSource::eventCached(), inputFileTransitionsEachEvent_, edm::InputSource::IsEvent, edm::InputSource::IsFile, edm::InputSource::IsInvalid, edm::InputSource::IsLumi, edm::InputSource::IsRun, edm::InputSource::IsStop, edm::InputSource::luminosityBlockAuxiliary(), edm::InputSource::newLumi(), edm::InputSource::newRun(), edm::InputSource::resetLuminosityBlockAuxiliary(), edm::InputSource::resetRunAuxiliary(), edm::InputSource::runAuxiliary(), and edm::InputSource::state().

65  {
66  if(state() == IsInvalid) {
67  return IsFile;
68  }
69  if(newRun() && runAuxiliary()) {
70  return IsRun;
71  }
73  return IsLumi;
74  }
75  if(eventCached()) {
76  return IsEvent;
77  }
81  }
82  bool another = checkNextEvent();
83  if(!another || (!newLumi() && !eventCached())) {
84  return IsStop;
86  return IsFile;
87  }
88  if(newRun()) {
89  return IsRun;
90  } else if(newLumi()) {
91  return IsLumi;
92  }
93  return IsEvent;
94  }
bool newLumi() const
Definition: InputSource.h:344
void resetRunAuxiliary(bool isNewRun=true) const
Definition: InputSource.h:326
boost::shared_ptr< LuminosityBlockAuxiliary > luminosityBlockAuxiliary() const
Called by the framework to merge or insert lumi in principal cache.
Definition: InputSource.h:247
virtual bool checkNextEvent()=0
bool inputFileTransitionsEachEvent_
bool newRun() const
Definition: InputSource.h:341
ItemType state() const
Definition: InputSource.h:317
void resetLuminosityBlockAuxiliary(bool isNewLumi=true) const
Definition: InputSource.h:330
boost::shared_ptr< RunAuxiliary > runAuxiliary() const
Called by the framework to merge or insert run in principal cache.
Definition: InputSource.h:244
bool eventCached() const
Definition: InputSource.h:347
EventPrincipal * edm::RawInputSource::makeEvent ( EventPrincipal eventPrincipal,
EventAuxiliary const &  eventAuxiliary 
)
protected

Definition at line 53 of file RawInputSource.cc.

References edm::EventPrincipal::fillEventPrincipal().

Referenced by edm::DQMHttpSource::read().

53  {
54  EventSourceSentry sentry(*this);
55  eventPrincipal.fillEventPrincipal(eventAuxiliary);
56  return &eventPrincipal;
57  }
void edm::RawInputSource::preForkReleaseResources ( )
overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 60 of file RawInputSource.cc.

References edm::InputSource::closeFile().

60  {
61  closeFile(nullptr, false);
62  }
void closeFile(FileBlock *, bool cleaningUpAfterException)
close current file
Definition: InputSource.cc:270
virtual EventPrincipal* edm::RawInputSource::read ( EventPrincipal eventPrincipal)
protectedpure virtual

Implemented in edm::StreamerInputSource, and edm::DQMHttpSource.

Referenced by readEvent_().

EventPrincipal * edm::RawInputSource::readEvent_ ( EventPrincipal eventPrincipal)
overrideprivatevirtual

Implements edm::InputSource.

Definition at line 44 of file RawInputSource.cc.

References edm::InputSource::eventCached(), edm::InputSource::newLumi(), edm::InputSource::newRun(), read(), and edm::InputSource::resetEventCached().

44  {
45  assert(!newRun());
46  assert(!newLumi());
47  assert(eventCached());
49  return read(eventPrincipal);
50  }
bool newLumi() const
Definition: InputSource.h:344
virtual EventPrincipal * read(EventPrincipal &eventPrincipal)=0
bool newRun() const
Definition: InputSource.h:341
void resetEventCached()
Definition: InputSource.h:350
bool eventCached() const
Definition: InputSource.h:347
boost::shared_ptr< LuminosityBlockAuxiliary > edm::RawInputSource::readLuminosityBlockAuxiliary_ ( )
overrideprivatevirtual

Implements edm::InputSource.

Definition at line 35 of file RawInputSource.cc.

References edm::InputSource::luminosityBlockAuxiliary(), edm::InputSource::newLumi(), edm::InputSource::newRun(), and edm::InputSource::resetNewLumi().

35  {
36  assert(!newRun());
37  assert(newLumi());
38  assert(luminosityBlockAuxiliary());
39  resetNewLumi();
40  return luminosityBlockAuxiliary();
41  }
bool newLumi() const
Definition: InputSource.h:344
boost::shared_ptr< LuminosityBlockAuxiliary > luminosityBlockAuxiliary() const
Called by the framework to merge or insert lumi in principal cache.
Definition: InputSource.h:247
bool newRun() const
Definition: InputSource.h:341
boost::shared_ptr< RunAuxiliary > edm::RawInputSource::readRunAuxiliary_ ( )
overrideprivatevirtual

Implements edm::InputSource.

Definition at line 27 of file RawInputSource.cc.

References edm::InputSource::newRun(), edm::InputSource::resetNewRun(), and edm::InputSource::runAuxiliary().

27  {
28  assert(newRun());
29  assert(runAuxiliary());
30  resetNewRun();
31  return runAuxiliary();
32  }
bool newRun() const
Definition: InputSource.h:341
boost::shared_ptr< RunAuxiliary > runAuxiliary() const
Called by the framework to merge or insert run in principal cache.
Definition: InputSource.h:244
void edm::RawInputSource::reset_ ( )
privatevirtual

Reimplemented in edm::StreamerFileReader.

Definition at line 97 of file RawInputSource.cc.

References edm::hlt::Exception, and edm::errors::LogicError.

Referenced by rewind_().

97  {
99  << "RawInputSource::reset()\n"
100  << "Forking is not implemented for this type of RawInputSource\n"
101  << "Contact a Framework Developer\n";
102  }
void edm::RawInputSource::rewind_ ( )
overrideprivatevirtual

Reimplemented from edm::InputSource.

Definition at line 105 of file RawInputSource.cc.

References reset_().

105  {
106  reset_();
107  }
virtual void reset_()
void edm::RawInputSource::setInputFileTransitionsEachEvent ( )
inlineprotected

Definition at line 29 of file RawInputSource.h.

References inputFileTransitionsEachEvent_.

Member Data Documentation

bool edm::RawInputSource::inputFileTransitionsEachEvent_
private

Definition at line 40 of file RawInputSource.h.

Referenced by getNextItemType(), and setInputFileTransitionsEachEvent().