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::StreamerFileReader Class Reference

#include <StreamerFileReader.h>

Inheritance diagram for edm::StreamerFileReader:
edm::StreamerInputSource edm::RawInputSource edm::InputSource edm::ProductRegistryHelper

Public Member Functions

InitMsgView const * getHeader ()
 
EventMsgView const * getNextEvent ()
 
bool newHeader ()
 
 StreamerFileReader (ParameterSet const &pset, InputSourceDescription const &desc)
 
virtual ~StreamerFileReader ()
 
- Public Member Functions inherited from edm::StreamerInputSource
void deserializeAndMergeWithRegistry (InitMsgView const &initView, bool subsequent=false)
 
void deserializeEvent (EventMsgView const &eventView)
 
 StreamerInputSource (ParameterSet const &pset, InputSourceDescription const &desc)
 
virtual ~StreamerInputSource ()
 
- Public Member Functions inherited from edm::RawInputSource
 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 fillDescriptions (ConfigurationDescriptions &descriptions)
 
- Static Public Member Functions inherited from edm::StreamerInputSource
static std::auto_ptr
< SendJobHeader
deserializeRegistry (InitMsgView const &initView)
 
static void fillDescription (ParameterSetDescription &description)
 
static void mergeIntoRegistry (SendJobHeader const &header, ProductRegistry &, BranchIDListHelper &, bool subsequent)
 
static unsigned int uncompressBuffer (unsigned char *inputBuffer, unsigned int inputSize, std::vector< unsigned char > &outputBuffer, unsigned int expectedFullSize)
 
- Static Public Member Functions inherited from edm::RawInputSource
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 &)
 

Private Member Functions

virtual bool checkNextEvent ()
 
virtual void closeFile_ ()
 
virtual void reset_ ()
 
virtual void skip (int toSkip)
 

Private Attributes

boost::shared_ptr
< EventSkipperByID
eventSkipperByID_
 
int initialNumberOfEventsToSkip_
 
std::vector< std::string > streamerNames_
 
std::unique_ptr
< StreamerInputFile
streamReader_
 

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
 
- Protected Member Functions inherited from edm::StreamerInputSource
void resetAfterEndRun ()
 
- Protected Member Functions inherited from edm::RawInputSource
EventPrincipalmakeEvent (EventPrincipal &eventPrincipal, EventAuxiliary const &eventAuxiliary)
 
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...
 
ItemType state () const
 
- Static Protected Member Functions inherited from edm::StreamerInputSource
static void buildClassCache (SendDescs const &descs)
 
static void declareStreamers (SendDescs const &descs)
 

Detailed Description

Definition at line 22 of file StreamerFileReader.h.

Constructor & Destructor Documentation

edm::StreamerFileReader::StreamerFileReader ( ParameterSet const &  pset,
InputSourceDescription const &  desc 
)

Definition at line 14 of file StreamerFileReader.cc.

References validate_alignment_devdb10_cfg::catalog, edm::InputFileCatalog::fileNames(), edm::ParameterSet::getUntrackedParameter(), reset_(), streamerNames_, and AlCaHLTBitMon_QueryRunRegistry::string.

14  :
15  StreamerInputSource(pset, desc),
16  streamerNames_(pset.getUntrackedParameter<std::vector<std::string> >("fileNames")),
17  streamReader_(),
19  initialNumberOfEventsToSkip_(pset.getUntrackedParameter<unsigned int>("skipEvents")) {
20  InputFileCatalog catalog(pset.getUntrackedParameter<std::vector<std::string> >("fileNames"), pset.getUntrackedParameter<std::string>("overrideCatalog"));
21  streamerNames_ = catalog.fileNames();
22  reset_();
23 
24  }
StreamerInputSource(ParameterSet const &pset, InputSourceDescription const &desc)
boost::shared_ptr< EventSkipperByID > eventSkipperByID_
std::vector< std::string > streamerNames_
std::unique_ptr< StreamerInputFile > streamReader_
static std::auto_ptr< EventSkipperByID > create(ParameterSet const &pset)
edm::StreamerFileReader::~StreamerFileReader ( )
virtual

Definition at line 26 of file StreamerFileReader.cc.

26  {
27  }

Member Function Documentation

bool edm::StreamerFileReader::checkNextEvent ( )
privatevirtual

Implements edm::RawInputSource.

Definition at line 47 of file StreamerFileReader.cc.

References edm::StreamerInputSource::deserializeAndMergeWithRegistry(), edm::StreamerInputSource::deserializeEvent(), getHeader(), getNextEvent(), and newHeader().

47  {
48  EventMsgView const* eview = getNextEvent();
49 
50  if (newHeader()) {
51  // FDEBUG(6) << "A new file has been opened and we must compare Headers here !!" << std::endl;
52  // A new file has been opened and we must compare Heraders here !!
53  //Get header/init from reader
54  InitMsgView const* header = getHeader();
55  deserializeAndMergeWithRegistry(*header, true);
56  }
57  if (eview == nullptr) {
58  return false;
59  }
60  deserializeEvent(*eview);
61  return true;
62  }
void deserializeEvent(EventMsgView const &eventView)
InitMsgView const * getHeader()
void deserializeAndMergeWithRegistry(InitMsgView const &initView, bool subsequent=false)
EventMsgView const * getNextEvent()
void edm::StreamerFileReader::closeFile_ ( )
privatevirtual

Reimplemented from edm::InputSource.

Definition at line 79 of file StreamerFileReader.cc.

References streamReader_.

79  {
80  if(streamReader_.get() != nullptr) streamReader_->closeStreamerFile();
81  }
std::unique_ptr< StreamerInputFile > streamReader_
void edm::StreamerFileReader::fillDescriptions ( ConfigurationDescriptions descriptions)
static

Definition at line 110 of file StreamerFileReader.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::addUntracked(), edm::EventSkipperByID::fillDescription(), edm::StreamerInputSource::fillDescription(), edm::ParameterSetDescription::setComment(), and AlCaHLTBitMon_QueryRunRegistry::string.

110  {
112  desc.setComment("Reads events from streamer files.");
113  desc.addUntracked<std::vector<std::string> >("fileNames")
114  ->setComment("Names of files to be processed.");
115  desc.addUntracked<unsigned int>("skipEvents", 0U)
116  ->setComment("Skip the first 'skipEvents' events that otherwise would have been processed.");
117  desc.addUntracked<std::string>("overrideCatalog", std::string());
118  //This next parameter is read in the base class, but its default value depends on the derived class, so it is set here.
119  desc.addUntracked<bool>("inputFileTransitionsEachEvent", false);
122  descriptions.add("source", desc);
123  }
static void fillDescription(ParameterSetDescription &description)
static void fillDescription(ParameterSetDescription &desc)
InitMsgView const * edm::StreamerFileReader::getHeader ( )

Definition at line 89 of file StreamerFileReader.cc.

References InitMsgView::code(), edm::hlt::Exception, edm::errors::FileReadError, Header::INIT, and streamReader_.

Referenced by checkNextEvent(), and reset_().

89  {
90 
91  InitMsgView const* header = streamReader_->startMessage();
92 
93  if(header->code() != Header::INIT) { //INIT Msg
94  throw Exception(errors::FileReadError, "StreamerFileReader::readHeader")
95  << "received wrong message type: expected INIT, got "
96  << header->code() << "\n";
97  }
98  return header;
99  }
uint32 code() const
Definition: InitMessage.h:66
std::unique_ptr< StreamerInputFile > streamReader_
EventMsgView const * edm::StreamerFileReader::getNextEvent ( )

Definition at line 102 of file StreamerFileReader.cc.

References streamReader_.

Referenced by checkNextEvent(), and skip().

102  {
103  if (!streamReader_->next()) {
104  return nullptr;
105  }
106  return streamReader_->currentRecord();
107  }
std::unique_ptr< StreamerInputFile > streamReader_
bool edm::StreamerFileReader::newHeader ( )

Definition at line 84 of file StreamerFileReader.cc.

References streamReader_.

Referenced by checkNextEvent().

84  {
85  return streamReader_->newHeader();
86  }
std::unique_ptr< StreamerInputFile > streamReader_
void edm::StreamerFileReader::reset_ ( )
privatevirtual

Reimplemented from edm::RawInputSource.

Definition at line 30 of file StreamerFileReader.cc.

References edm::StreamerInputSource::deserializeAndMergeWithRegistry(), eventSkipperByID_, edm::hlt::Exception, edm::errors::FileReadError, getHeader(), initialNumberOfEventsToSkip_, skip(), streamerNames_, and streamReader_.

Referenced by StreamerFileReader().

30  {
31  if (streamerNames_.size() > 1) {
32  streamReader_ = std::unique_ptr<StreamerInputFile>(new StreamerInputFile(streamerNames_, eventSkipperByID_));
33  } else if (streamerNames_.size() == 1) {
34  streamReader_ = std::unique_ptr<StreamerInputFile>(new StreamerInputFile(streamerNames_.at(0), eventSkipperByID_));
35  } else {
36  throw Exception(errors::FileReadError, "StreamerFileReader::StreamerFileReader")
37  << "No fileNames were specified\n";
38  }
39  InitMsgView const* header = getHeader();
40  deserializeAndMergeWithRegistry(*header, false);
43  }
44  }
InitMsgView const * getHeader()
virtual void skip(int toSkip)
boost::shared_ptr< EventSkipperByID > eventSkipperByID_
std::vector< std::string > streamerNames_
std::unique_ptr< StreamerInputFile > streamReader_
void deserializeAndMergeWithRegistry(InitMsgView const &initView, bool subsequent=false)
void edm::StreamerFileReader::skip ( int  toSkip)
privatevirtual

Reimplemented from edm::InputSource.

Definition at line 65 of file StreamerFileReader.cc.

References EventMsgView::event(), eventSkipperByID_, getNextEvent(), i, EventMsgView::lumi(), and EventMsgView::run().

Referenced by reset_().

65  {
66  for(int i = 0; i != toSkip; ++i) {
67  EventMsgView const* evMsg = getNextEvent();
68  if(evMsg == nullptr) {
69  return;
70  }
71  // If the event would have been skipped anyway, don't count it as a skipped event.
72  if(eventSkipperByID_ && eventSkipperByID_->skipIt(evMsg->run(), evMsg->lumi(), evMsg->event())) {
73  --i;
74  }
75  }
76  }
int i
Definition: DBlmapReader.cc:9
uint32 lumi() const
Definition: EventMessage.cc:85
uint32 run() const
Definition: EventMessage.cc:73
uint32 event() const
Definition: EventMessage.cc:79
boost::shared_ptr< EventSkipperByID > eventSkipperByID_
EventMsgView const * getNextEvent()

Member Data Documentation

boost::shared_ptr<EventSkipperByID> edm::StreamerFileReader::eventSkipperByID_
private

Definition at line 40 of file StreamerFileReader.h.

Referenced by reset_(), and skip().

int edm::StreamerFileReader::initialNumberOfEventsToSkip_
private

Definition at line 41 of file StreamerFileReader.h.

Referenced by reset_().

std::vector<std::string> edm::StreamerFileReader::streamerNames_
private

Definition at line 38 of file StreamerFileReader.h.

Referenced by reset_(), and StreamerFileReader().

std::unique_ptr<StreamerInputFile> edm::StreamerFileReader::streamReader_
private

Definition at line 39 of file StreamerFileReader.h.

Referenced by closeFile_(), getHeader(), getNextEvent(), newHeader(), and reset_().