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

#include <StreamerFileReader.h>

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

Public Member Functions

InitMsgView const * getHeader ()
 
EventMsgView const * getNextEvent ()
 
bool newHeader ()
 
virtual EventPrincipalread ()
 
 StreamerFileReader (ParameterSet const &pset, InputSourceDescription const &desc)
 
virtual ~StreamerFileReader ()
 
- Public Member Functions inherited from edm::StreamerInputSource
void deserializeAndMergeWithRegistry (InitMsgView const &initView, bool subsequent=false)
 
EventPrincipaldeserializeEvent (EventMsgView const &eventView)
 
 StreamerInputSource (ParameterSet const &pset, InputSourceDescription const &desc)
 
virtual ~StreamerInputSource ()
 
- Public Member Functions inherited from edm::InputSource
boost::shared_ptr
< ActivityRegistry
actReg () const
 Accessor for Activity Registry. More...
 
void closeFile (boost::shared_ptr< 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...
 
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 markLumi ()
 Mark lumi as read. More...
 
int markRun ()
 Mark run as read. More...
 
int maxEvents () const
 
int maxLuminosityBlocks () const
 
ModuleDescription const & moduleDescription () const
 Accessor for 'module' description. More...
 
ItemType nextItemType ()
 
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
 
void readAndCacheLumi (bool merge, HistoryAppender &historyAppender)
 Read next luminosity block. More...
 
void readAndCacheRun (bool merge, HistoryAppender &historyAppender)
 Read next run. More...
 
EventPrincipalreadEvent (boost::shared_ptr< LuminosityBlockPrincipal > lbCache)
 
EventPrincipalreadEvent (EventID const &)
 Read a specific event. More...
 
boost::shared_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)
 
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 &, 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::InputSource
static const std::string & baseType ()
 
static void fillDescription (ParameterSetDescription &desc)
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &)
 

Private Attributes

boost::shared_ptr
< EventSkipperByID
eventSkipperByID_
 
int numberOfEventsToSkip_
 
std::vector< std::string > streamerNames_
 
std::auto_ptr< StreamerInputFilestreamReader_
 

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 ()
 
void setEndRun ()
 
- Protected Member Functions inherited from edm::InputSource
void decreaseRemainingEventsBy (int iSkipped)
 
EventPrincipaleventPrincipalCache ()
 
boost::shared_ptr
< LuminosityBlockPrincipal >
const 
luminosityBlockPrincipal () const
 
PrincipalCache const & principalCache () const
 
PrincipalCacheprincipalCache ()
 
ProductRegistryproductRegistryUpdate () const
 
void reset () const
 
void resetLuminosityBlockAuxiliary () const
 
void resetRunAuxiliary () const
 
boost::shared_ptr
< RunPrincipal > const 
runPrincipal () const
 
void setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)
 
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)
 
- Protected Attributes inherited from edm::StreamerInputSource
bool inputFileTransitionsEachEvent_
 

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 13 of file StreamerFileReader.cc.

References validate_alignment_devdb10_cfg::catalog, edm::StreamerInputSource::deserializeAndMergeWithRegistry(), eventSkipperByID_, edm::hlt::Exception, edm::InputFileCatalog::fileNames(), edm::errors::FileReadError, getHeader(), edm::ParameterSet::getUntrackedParameter(), errorMatrix2Lands::header, numberOfEventsToSkip_, streamerNames_, and streamReader_.

13  :
14  StreamerInputSource(pset, desc),
15  streamerNames_(pset.getUntrackedParameter<std::vector<std::string> >("fileNames")),
16  streamReader_(),
18  numberOfEventsToSkip_(pset.getUntrackedParameter<unsigned int>("skipEvents")) {
19  InputFileCatalog catalog(pset.getUntrackedParameter<std::vector<std::string> >("fileNames"), pset.getUntrackedParameter<std::string>("overrideCatalog"));
20  streamerNames_ = catalog.fileNames();
21 
22  if (streamerNames_.size() > 1) {
23  streamReader_ = std::auto_ptr<StreamerInputFile>(new StreamerInputFile(streamerNames_, &numberOfEventsToSkip_, eventSkipperByID_));
24  } else if (streamerNames_.size() == 1) {
25  streamReader_ = std::auto_ptr<StreamerInputFile>(new StreamerInputFile(streamerNames_.at(0), &numberOfEventsToSkip_, eventSkipperByID_));
26  } else {
27  throw Exception(errors::FileReadError, "StreamerFileReader::StreamerFileReader")
28  << "No fileNames were specified\n";
29  }
30  InitMsgView const* header = getHeader();
31  deserializeAndMergeWithRegistry(*header, false);
32  }
StreamerInputSource(ParameterSet const &pset, InputSourceDescription const &desc)
InitMsgView const * getHeader()
boost::shared_ptr< EventSkipperByID > eventSkipperByID_
std::vector< std::string > streamerNames_
std::auto_ptr< StreamerInputFile > streamReader_
static std::auto_ptr< EventSkipperByID > create(ParameterSet const &pset)
void deserializeAndMergeWithRegistry(InitMsgView const &initView, bool subsequent=false)
edm::StreamerFileReader::~StreamerFileReader ( )
virtual

Definition at line 34 of file StreamerFileReader.cc.

34  {
35  }

Member Function Documentation

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

Definition at line 82 of file StreamerFileReader.cc.

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

82  {
84  desc.setComment("Reads events from streamer files.");
85  desc.addUntracked<std::vector<std::string> >("fileNames")
86  ->setComment("Names of files to be processed.");
87  desc.addUntracked<unsigned int>("skipEvents", 0U)
88  ->setComment("Skip the first 'skipEvents' events that otherwise would have been processed.");
89  desc.addUntracked<std::string>("overrideCatalog", std::string());
90  //This next parameter is read in the base class, but its default value depends on the derived class, so it is set here.
91  desc.addUntracked<bool>("inputFileTransitionsEachEvent", false);
94  descriptions.add("source", desc);
95  }
static void fillDescription(ParameterSetDescription &description)
static void fillDescription(ParameterSetDescription &desc)
InitMsgView const * edm::StreamerFileReader::getHeader ( )

Definition at line 61 of file StreamerFileReader.cc.

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

Referenced by read(), and StreamerFileReader().

61  {
62 
63  InitMsgView const* header = streamReader_->startMessage();
64 
65  if(header->code() != Header::INIT) { //INIT Msg
66  throw Exception(errors::FileReadError, "StreamerFileReader::readHeader")
67  << "received wrong message type: expected INIT, got "
68  << header->code() << "\n";
69  }
70  return header;
71  }
uint32 code() const
Definition: InitMessage.h:66
std::auto_ptr< StreamerInputFile > streamReader_
EventMsgView const * edm::StreamerFileReader::getNextEvent ( )

Definition at line 74 of file StreamerFileReader.cc.

References streamReader_.

Referenced by read().

74  {
75  if (!streamReader_->next()) {
76  return 0;
77  }
78  return streamReader_->currentRecord();
79  }
std::auto_ptr< StreamerInputFile > streamReader_
bool edm::StreamerFileReader::newHeader ( )

Definition at line 56 of file StreamerFileReader.cc.

References streamReader_.

Referenced by read().

56  {
57  return streamReader_->newHeader();
58  }
std::auto_ptr< StreamerInputFile > streamReader_
EventPrincipal * edm::StreamerFileReader::read ( )
virtual

Implements edm::StreamerInputSource.

Definition at line 38 of file StreamerFileReader.cc.

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

38  {
39 
40  EventMsgView const* eview = getNextEvent();
41 
42  if (newHeader()) {
43  // FDEBUG(6) << "A new file has been opened and we must compare Headers here !!" << std::endl;
44  // A new file has been opened and we must compare Heraders here !!
45  //Get header/init from reader
46  InitMsgView const* header = getHeader();
47  deserializeAndMergeWithRegistry(*header, true);
48  }
49  if (eview == 0) {
50  return 0;
51  }
52  return(deserializeEvent(*eview));
53  }
InitMsgView const * getHeader()
EventPrincipal * deserializeEvent(EventMsgView const &eventView)
void deserializeAndMergeWithRegistry(InitMsgView const &initView, bool subsequent=false)
EventMsgView const * getNextEvent()

Member Data Documentation

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

Definition at line 36 of file StreamerFileReader.h.

Referenced by StreamerFileReader().

int edm::StreamerFileReader::numberOfEventsToSkip_
private

Definition at line 37 of file StreamerFileReader.h.

Referenced by StreamerFileReader().

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

Definition at line 34 of file StreamerFileReader.h.

Referenced by StreamerFileReader().

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

Definition at line 35 of file StreamerFileReader.h.

Referenced by getHeader(), getNextEvent(), newHeader(), and StreamerFileReader().