---

edm::InputSource Class Reference

#include <FWCore/Framework/interface/InputSource.h>

Inheritance diagram for edm::InputSource:

List of all members.

Public Types
enum	ItemType {   IsInvalid, IsStop, IsFile, IsRun,   IsLumi, IsEvent, IsRepeat }
enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Member Functions
boost::shared_ptr < ActivityRegistry >	actReg () const
	Accessor for Activity Registry.
void	closeFile ()
	close current file
void	doBeginJob (EventSetup const &)
	Called by framework at beginning of job.
void	doEndJob ()
	Called by framework at end of job.
void	doEndLumi (LuminosityBlockPrincipal &lbp)
	Called by framework when events are exhausted.
void	doEndRun (RunPrincipal &rp)
	InputSource (ParameterSet const &, InputSourceDescription const &)
	Constructor.
void	issueReports (EventID const &eventID, LuminosityBlockNumber_t const &lumi)
	issue an event report
LuminosityBlockNumber_t	luminosityBlock () const
	Accessor for current luminosity block number.
int	maxEvents () const
	Accessor for maximum number of events to be read.
int	maxLuminosityBlocks () const
	Accessor for maximum number of lumis to be read.
ModuleDescription const &	moduleDescription () const
	Accessor for 'module' description.
ItemType	nextItemType ()
bool const	primary () const
	Accessor for primary input source flag.
ProcessConfiguration const &	processConfiguration () const
	Accessor for Process Configuration.
std::string const &	processGUID () const
	Accessor for global process identifier.
ProcessingMode	processingMode () const
	RunsLumisAndEvents (default), RunsAndLumis, or Runs.
boost::shared_ptr < ProductRegistry const >	productRegistry () const
	Accessor for product registry.
std::auto_ptr< EventPrincipal >	readEvent (EventID const &)
	Read a specific event.
std::auto_ptr< EventPrincipal >	readEvent (boost::shared_ptr< LuminosityBlockPrincipal > lbp)
	Read next event Indicate inability to get a new event by returning a null auto_ptr.
boost::shared_ptr< FileBlock >	readFile ()
	Read next file.
boost::shared_ptr < LuminosityBlockPrincipal >	readLuminosityBlock (boost::shared_ptr< RunPrincipal > rp)
	Read next luminosity block.
boost::shared_ptr< RunPrincipal >	readRun ()
	Read next run.
void	registerProducts ()
	Register any produced products.
int	remainingEvents () const
	Accessor for remaining number of events to be read.
int	remainingLuminosityBlocks () const
	Accessor for remaining number of lumis to be read.
void	repeat ()
	Reset the remaining number of events/lumis to the maximum number.
void	rewind ()
	Begin again at the first event.
RunNumber_t	run () const
	Accessor for current run number.
void	setLuminosityBlockNumber_t (LuminosityBlockNumber_t lb)
	Set the luminosity block ID.
void	setRunNumber (RunNumber_t r)
	Set the run number.
void	skipEvents (int offset)
	Skip the number of events specified.
Timestamp const &	timestamp () const
	Accessor for the current time, as seen by the input source.
void	wakeUp ()
	Wake up the input source.
virtual	~InputSource ()
	Destructor.
Protected Member Functions
boost::shared_ptr < LuminosityBlockPrincipal >	luminosityBlockPrincipal () const
ProductRegistry &	productRegistryUpdate () const
void	reset () const
void	resetLuminosityBlockPrincipal ()
void	resetRunPrincipal ()
boost::shared_ptr< RunPrincipal >	runPrincipal () const
void	setLuminosityBlockPrincipal (boost::shared_ptr< LuminosityBlockPrincipal > lbp)
void	setRunPrincipal (boost::shared_ptr< RunPrincipal > rp)
void	setTimestamp (Timestamp const &theTime)
	To set the current time, as seen by the input source.
ItemType	state () const
Private Member Functions
virtual void	beginJob (EventSetup const &)
virtual void	closeFile_ ()
virtual void	endJob ()
virtual void	endLuminosityBlock (LuminosityBlock &)
virtual void	endRun (Run &)
bool	eventLimitReached () const
virtual ItemType	getNextItemType ()=0
bool	limitReached () const
bool	lumiLimitReached () const
ItemType	nextItemType_ ()
void	postRead (Event &event)
void	preRead ()
virtual std::auto_ptr < EventPrincipal >	readEvent_ ()=0
virtual boost::shared_ptr < FileBlock >	readFile_ ()
virtual std::auto_ptr < EventPrincipal >	readIt (EventID const &)
virtual boost::shared_ptr < LuminosityBlockPrincipal >	readLuminosityBlock_ ()=0
virtual boost::shared_ptr < RunPrincipal >	readRun_ ()=0
virtual void	rewind_ ()
virtual void	setLumi (LuminosityBlockNumber_t lb)
virtual void	setRun (RunNumber_t r)
virtual void	skip (int)
virtual void	wakeUp_ ()
Private Attributes
boost::shared_ptr < ActivityRegistry >	actReg_
bool	doneReadAhead_
boost::shared_ptr < LuminosityBlockPrincipal >	lumiPrincipal_
int	maxEvents_
int	maxLumis_
ModuleDescription const	moduleDescription_
bool const	primary_
std::string	processGUID_
ProcessingMode	processingMode_
boost::shared_ptr < ProductRegistry const >	productRegistry_
int	readCount_
int	remainingEvents_
int	remainingLumis_
boost::shared_ptr< RunPrincipal >	runPrincipal_
ItemType	state_
Timestamp	time_
Classes
class	EventSourceSentry
class	FileCloseSentry
class	FileOpenSentry
class	LumiSourceSentry
class	RunSourceSentry
class	SourceSentry

---

Detailed Description

Definition at line 63 of file InputSource.h.

---

Member Typedef Documentation

typedef ProductRegistryHelper::TypeLabelList edm::InputSource::TypeLabelList

Reimplemented from edm::ProductRegistryHelper.

Definition at line 81 of file InputSource.h.

---

Member Enumeration Documentation

enum edm::InputSource::ItemType

Enumerator:

IsInvalid
IsStop
IsFile
IsRun
IsLumi
IsEvent
IsRepeat

Definition at line 65 of file InputSource.h.

                  {
        IsInvalid,
        IsStop,
        IsFile,
        IsRun,
        IsLumi,
        IsEvent,
        IsRepeat
    };

enum edm::InputSource::ProcessingMode

Enumerator:

Runs
RunsAndLumis
RunsLumisAndEvents

Definition at line 75 of file InputSource.h.

                        {
        Runs,
        RunsAndLumis,
        RunsLumisAndEvents
    };

---

Constructor & Destructor Documentation

edm::InputSource::InputSource	(	ParameterSet const &	pset,
		InputSourceDescription const &	desc
	)			[explicit]

Constructor.

Definition at line 48 of file InputSource.cc.

References edm::errors::Configuration, edm::ParameterSet::getUntrackedParameter(), edm::improbable, primary_, processingMode(), processingMode_, edm::InputSourceDescription::productRegistry_, Runs, and RunsAndLumis.

                                                                                       :
      ProductRegistryHelper(),
      actReg_(desc.actReg_),
      maxEvents_(desc.maxEvents_),
      remainingEvents_(maxEvents_),
      maxLumis_(desc.maxLumis_),
      remainingLumis_(maxLumis_),
      readCount_(0),
      processingMode_(RunsLumisAndEvents),
      moduleDescription_(desc.moduleDescription_),
      productRegistry_(createSharedPtrToStatic<ProductRegistry const>(desc.productRegistry_)),
      primary_(pset.getParameter<std::string>("@module_label") == std::string("@main_input")),
      processGUID_(primary_ ? createGlobalIdentifier() : std::string()),
      time_(),
      doneReadAhead_(false),
      state_(IsInvalid),
      runPrincipal_(),
      lumiPrincipal_() {
    // Secondary input sources currently do not have a product registry.
    if (primary_) {
      assert(desc.productRegistry_ != 0);
    }
    int maxEventsOldStyle = pset.getUntrackedParameter<int>("maxEvents", improbable);
    if (maxEventsOldStyle != improbable) {
      throw edm::Exception(edm::errors::Configuration)
        << "InputSource::InputSource()\n"
        << "The 'maxEvents' parameter for sources is no longer supported.\n"
        << "Please use instead the process level parameter set\n"
        << "'untracked PSet maxEvents = {untracked int32 input = " << maxEventsOldStyle << "}'\n";
    }
    std::string const defaultMode("RunsLumisAndEvents");
    std::string const runMode("Runs");
    std::string const runLumiMode("RunsAndLumis");
    std::string processingMode = pset.getUntrackedParameter<std::string>("processingMode", defaultMode);
    if (processingMode == runMode) {
      processingMode_ = Runs;
    } else if (processingMode == runLumiMode) {
      processingMode_ = RunsAndLumis;
    } else if (processingMode != defaultMode) {
      throw edm::Exception(edm::errors::Configuration)
        << "InputSource::InputSource()\n"
        << "The 'processingMode' parameter for sources has an illegal value '" << processingMode << "'\n"
        << "Legal values are '" << defaultMode << "', '" << runLumiMode << "', or '" << runMode << "'.\n";
    }
  }

edm::InputSource::~InputSource

(

)

[virtual]

Destructor.

Definition at line 94 of file InputSource.cc.

{}

---

Member Function Documentation

boost::shared_ptr<ActivityRegistry> edm::InputSource::actReg

(

)

const [inline]

Accessor for Activity Registry.

Definition at line 196 of file InputSource.h.

References actReg_.

{return actReg_;}

void edm::InputSource::beginJob

(

EventSetup const &

)

[private, virtual]

Reimplemented in edm::BaseFlatGunSource, HcalPatternSource, and EcalSimpleSource.

Definition at line 386 of file InputSource.cc.

Referenced by doBeginJob().

{}

void edm::InputSource::closeFile

(

)

close current file

Definition at line 197 of file InputSource.cc.

References closeFile_().

                         {
    return closeFile_();
  }

virtual void edm::InputSource::closeFile_

(

)

[inline, private, virtual]

Reimplemented in edm::PoolSource.

Definition at line 273 of file InputSource.h.

Referenced by closeFile().

{}

void edm::InputSource::doBeginJob

(

EventSetup const &

c

)

Called by framework at beginning of job.

Definition at line 170 of file InputSource.cc.

References beginJob().

                                             {
    beginJob(c);
  }

void edm::InputSource::doEndJob

(

)

Called by framework at end of job.

Definition at line 175 of file InputSource.cc.

References endJob().

Referenced by edm::PileUp::endJob(), and edm::EventProcessor::endJob().

                        {
    endJob();
  }

void edm::InputSource::doEndLumi

(

LuminosityBlockPrincipal &

lbp

)

Called by framework when events are exhausted.

Definition at line 369 of file InputSource.cc.

References edm::LuminosityBlock::commit_(), endLuminosityBlock(), moduleDescription(), edm::LuminosityBlockPrincipal::setEndTime(), and time_.

                                                       {
    lbp.setEndTime(time_);
    LuminosityBlock lb(lbp, moduleDescription());
    endLuminosityBlock(lb);
    lb.commit_();
  }

void edm::InputSource::doEndRun

(

RunPrincipal &

rp

)

Definition at line 361 of file InputSource.cc.

References edm::Run::commit_(), endRun(), moduleDescription(), run(), edm::RunPrincipal::setEndTime(), and time_.

                                        {
    rp.setEndTime(time_);
    Run run(rp, moduleDescription());
    endRun(run);
    run.commit_();
  }

void edm::InputSource::endJob

(

void

)

[private, virtual]

Reimplemented in LHESource, and edm::PoolSource.

Definition at line 389 of file InputSource.cc.

Referenced by doEndJob().

{}

void edm::InputSource::endLuminosityBlock

(

LuminosityBlock &

)

[private, virtual]

Reimplemented in ErrorStreamSource, and edm::ConfigurableInputSource.

Definition at line 380 of file InputSource.cc.

Referenced by doEndLumi().

{}

void edm::InputSource::endRun

(

Run &

)

[private, virtual]

Reimplemented in ErrorStreamSource, edm::ConfigurableInputSource, edm::ExhumeSource, edm::Herwig6Source, edm::MadGraphSource, edm::MCatNLOSource, edm::PomwigSource, edm::PythiaSource, edm::Pythia8Source, and ThePEGSource.

Definition at line 383 of file InputSource.cc.

Referenced by doEndRun().

{}

bool edm::InputSource::eventLimitReached

(

)

const [inline, private]

Definition at line 263 of file InputSource.h.

References remainingEvents_.

Referenced by limitReached(), nextItemType(), and readEvent().

{return remainingEvents_ == 0;}

virtual ItemType edm::InputSource::getNextItemType

(

)

[private, pure virtual]

Implemented in edm::ConfigurableInputSource, edm::RawInputSource, edm::PoolSource, edm::StreamerInputSource, and edm::DaqSource.

Referenced by nextItemType_().

void edm::InputSource::issueReports	(	EventID const &	eventID,
		LuminosityBlockNumber_t const &	lumi
	)

issue an event report

Definition at line 287 of file InputSource.cc.

References edm::EventID::event(), readCount_, edm::EventID::run(), edm::suffix(), and t.

Referenced by readEvent().

                                                                                       {
    time_t t = time(0);
    char ts[] = "dd-Mon-yyyy hh:mm:ss TZN     ";
    strftime( ts, strlen(ts)+1, "%d-%b-%Y %H:%M:%S %Z", localtime(&t) );
    LogVerbatim("FwkReport") << "Begin processing the " << readCount_
                         << suffix(readCount_) << " record. Run " << eventID.run()
                         << ", Event " << eventID.event()
                                   << ", LumiSection " << lumi<< " at " << ts;
      // At some point we may want to initiate checkpointing here
  }

bool edm::InputSource::limitReached

(

)

const [inline, private]

Definition at line 265 of file InputSource.h.

References eventLimitReached(), and lumiLimitReached().

Referenced by readEvent(), readFile(), readLuminosityBlock(), and readRun().

{return eventLimitReached() || lumiLimitReached();}

bool edm::InputSource::lumiLimitReached

(

)

const [inline, private]

Definition at line 264 of file InputSource.h.

References remainingLumis_.

Referenced by limitReached(), and nextItemType().

{return remainingLumis_ == 0;}

LuminosityBlockNumber_t edm::InputSource::luminosityBlock

(

)

const

Accessor for current luminosity block number.

Reimplemented in edm::ConfigurableInputSource.

Definition at line 398 of file InputSource.cc.

References luminosityBlockPrincipal().

Referenced by edm::StreamerInputSource::deserializeEvent().

                                     {
    assert(luminosityBlockPrincipal());
    return luminosityBlockPrincipal()->luminosityBlock();
  }

boost::shared_ptr<LuminosityBlockPrincipal> edm::InputSource::luminosityBlockPrincipal

(

)

const [inline, protected]

Definition at line 252 of file InputSource.h.

References lumiPrincipal_.

Referenced by edm::StreamerInputSource::deserializeEvent(), edm::StreamerInputSource::getNextItemType(), luminosityBlock(), and edm::StreamerInputSource::readLuminosityBlock_().

{return lumiPrincipal_;}

int edm::InputSource::maxEvents

(

)

const [inline]

Accessor for maximum number of events to be read.

-1 is used for unlimited.

Definition at line 147 of file InputSource.h.

References maxEvents_.

Referenced by edm::AlpgenSource::AlpgenSource(), edm::H2RootNtplSource::H2RootNtplSource(), edm::Herwig6Source::Herwig6Source(), edm::MadGraphSource::MadGraphSource(), and edm::PomwigSource::PomwigSource().

{return maxEvents_;}

int edm::InputSource::maxLuminosityBlocks

(

)

const [inline]

Accessor for maximum number of lumis to be read.

-1 is used for unlimited.

Definition at line 155 of file InputSource.h.

References maxLumis_.

{return maxLumis_;}

ModuleDescription const& edm::InputSource::moduleDescription

(

)

const [inline]

Accessor for 'module' description.

Definition at line 162 of file InputSource.h.

References moduleDescription_.

Referenced by doEndLumi(), doEndRun(), edm::RawInputSource::makeEvent(), processConfiguration(), readEvent(), edm::ConfigurableInputSource::readLuminosityBlock_(), edm::ConfigurableInputSource::readRun_(), edm::ConfigurableInputSource::reallyReadEvent(), and registerProducts().

{return moduleDescription_;}

InputSource::ItemType edm::InputSource::nextItemType

(

)

Definition at line 119 of file InputSource.cc.

References doneReadAhead_, eventLimitReached(), IsEvent, IsFile, IsInvalid, IsLumi, IsRun, IsStop, lumiLimitReached(), lumiPrincipal_, nextItemType_(), processingMode(), readLuminosityBlock_(), readRun_(), runPrincipal_, Runs, RunsLumisAndEvents, setLuminosityBlockPrincipal(), setRunPrincipal(), and state_.

                            {
    if (doneReadAhead_) {
      return state_;
    }
    doneReadAhead_ = true;
    ItemType oldState = state_;
    if (eventLimitReached()) {
      // If the maximum event limit has been reached, stop.
      state_ = IsStop;
    } else if (lumiLimitReached()) {
      // If the maximum lumi limit has been reached, stop
      // when reaching a new file, run, or lumi.
      if (oldState == IsInvalid || oldState == IsFile || oldState == IsRun || processingMode() != RunsLumisAndEvents) {
        state_ = IsStop;
      } else {
        ItemType newState = nextItemType_();
        if (newState == IsEvent) {
          assert (processingMode() == RunsLumisAndEvents);
          state_ = IsEvent;
        } else {
          state_ = IsStop;
        }
      }
    } else {
      ItemType newState = nextItemType_();
      if (newState == IsStop) {
        state_ = IsStop;
      } else if (newState == IsFile || oldState == IsInvalid) {
        state_ = IsFile;
      } else if (newState == IsRun || oldState == IsFile) {
        RunSourceSentry(*this);
        setRunPrincipal(readRun_());
        state_ = IsRun;
      } else if (newState == IsLumi || oldState == IsRun) {
        assert (processingMode() != Runs);
        LumiSourceSentry(*this);
        setLuminosityBlockPrincipal(readLuminosityBlock_());
        state_ = IsLumi;
      } else {
        assert (processingMode() == RunsLumisAndEvents);
        state_ = IsEvent;
      }
    }
    if (state_ == IsStop) {
      lumiPrincipal_.reset();
      runPrincipal_.reset();
    }
    return state_;
  }

InputSource::ItemType edm::InputSource::nextItemType_

(

)

[private]

Definition at line 105 of file InputSource.cc.

References getNextItemType(), IsEvent, IsLumi, processingMode(), readEvent_(), readLuminosityBlock_(), Runs, and RunsLumisAndEvents.

Referenced by nextItemType().

                             {
    ItemType itemType = getNextItemType();
    if (itemType == IsEvent && processingMode() != RunsLumisAndEvents) {
      readEvent_();
      return nextItemType_();
    }
    if (itemType == IsLumi && processingMode() == Runs) {
      readLuminosityBlock_();
      return nextItemType_();
    }
    return itemType;
  }

void edm::InputSource::postRead

(

Event &

event

)

[private]

Definition at line 350 of file InputSource.cc.

References edm::Service< T >::isAvailable(), and primary().

Referenced by readEvent().

                                    {

    if (primary()) {
      Service<RandomNumberGenerator> rng;
      if (rng.isAvailable()) {
        rng->restoreState(event);
      }
    }
  }

void edm::InputSource::preRead

(

)

[private]

Definition at line 339 of file InputSource.cc.

References edm::Service< T >::isAvailable(), and primary().

Referenced by readEvent().

                       {

    if (primary()) {
      Service<RandomNumberGenerator> rng;
      if (rng.isAvailable()) {
        rng->snapShot();
      }
    }
  }

bool const edm::InputSource::primary

(

)

const [inline]

Accessor for primary input source flag.

Definition at line 168 of file InputSource.h.

References primary_.

Referenced by edm::PoolSource::dropUnwantedBranches_(), edm::PoolSource::PoolSource(), postRead(), preRead(), edm::RootInputFileSequence::primary(), and readFile_().

{return primary_;}

ProcessConfiguration const& edm::InputSource::processConfiguration

(

)

const [inline]

Accessor for Process Configuration.

Definition at line 165 of file InputSource.h.

References moduleDescription(), and edm::ModuleDescription::processConfiguration().

Referenced by edm::StreamerInputSource::deserializeEvent(), edm::RawInputSource::makeEvent(), edm::RootInputFileSequence::processConfiguration(), edm::RawInputSource::readLuminosityBlock_(), edm::ConfigurableInputSource::readLuminosityBlock_(), edm::RawInputSource::readRun_(), edm::ConfigurableInputSource::readRun_(), and edm::ConfigurableInputSource::reallyReadEvent().

{return moduleDescription().processConfiguration();}

std::string const& edm::InputSource::processGUID

(

)

const [inline]

Accessor for global process identifier.

Definition at line 171 of file InputSource.h.

References processGUID_.

Referenced by edm::RawInputSource::makeEvent(), and edm::ConfigurableInputSource::reallyReadEvent().

{return processGUID_;}

ProcessingMode edm::InputSource::processingMode

(

)

const [inline]

RunsLumisAndEvents (default), RunsAndLumis, or Runs.

Definition at line 193 of file InputSource.h.

References processingMode_.

Referenced by edm::ConfigurableInputSource::getNextItemType(), edm::RootInputFileSequence::initFile(), InputSource(), nextItemType(), nextItemType_(), edm::ConfigurableInputSource::readEvent_(), edm::ConfigurableInputSource::readLuminosityBlock_(), and edm::ConfigurableInputSource::reallyReadEvent().

{return processingMode_;}

boost::shared_ptr<ProductRegistry const> edm::InputSource::productRegistry

(

)

const [inline]

Accessor for product registry.

Definition at line 136 of file InputSource.h.

References productRegistry_.

Referenced by edm::StreamerInputSource::deserializeEvent(), edm::RawInputSource::makeEvent(), edm::RootInputFileSequence::productRegistry(), edm::StreamerInputSource::readFile_(), edm::RawInputSource::readLuminosityBlock_(), edm::ConfigurableInputSource::readLuminosityBlock_(), edm::RawInputSource::readRun_(), edm::ConfigurableInputSource::readRun_(), and edm::ConfigurableInputSource::reallyReadEvent().

{return productRegistry_;}

ProductRegistry& edm::InputSource::productRegistryUpdate

(

)

const [inline, protected]

Definition at line 249 of file InputSource.h.

Referenced by edm::StreamerInputSource::deserializeAndMergeWithRegistry(), edm::StreamerInputSource::deserializeEvent(), edm::RootInputFileSequence::productRegistryUpdate(), readFile_(), edm::StreamerInputSource::readFile_(), and registerProducts().

{return const_cast<ProductRegistry &>(*productRegistry_);}

std::auto_ptr< EventPrincipal > edm::InputSource::readEvent

(

EventID const &

eventID

)

Read a specific event.

Definition at line 263 of file InputSource.cc.

References edm::event, issueReports(), limitReached(), moduleDescription(), postRead(), preRead(), readCount_, readIt(), remainingEvents_, and HLT_VtxMuL3::result.

                                               {

    std::auto_ptr<EventPrincipal> result(0);

    if (!limitReached()) {
      preRead();
      result = readIt(eventID);
      if (result.get() != 0) {
        Event event(*result, moduleDescription());
        postRead(event);
        if (remainingEvents_ > 0) --remainingEvents_;
        ++readCount_;
        issueReports(result->id(), result->luminosityBlock());
      }
    }
    return result;
  }

std::auto_ptr< EventPrincipal > edm::InputSource::readEvent

(

boost::shared_ptr< LuminosityBlockPrincipal >

lbp

)

Read next event Indicate inability to get a new event by returning a null auto_ptr.

Definition at line 240 of file InputSource.cc.

References doneReadAhead_, edm::event, eventLimitReached(), IsEvent, issueReports(), moduleDescription(), postRead(), preRead(), readCount_, readEvent_(), remainingEvents_, HLT_VtxMuL3::result, setTimestamp(), and state_.

                                                                      {
    assert(doneReadAhead_);
    assert(state_ == IsEvent);
    assert(!eventLimitReached());
    doneReadAhead_ = false;

    preRead();
    std::auto_ptr<EventPrincipal> result = readEvent_();
    assert(lbp->run() == result->run());
    assert(lbp->luminosityBlock() == result->luminosityBlock());
    result->setLuminosityBlockPrincipal(lbp);
    if (result.get() != 0) {
      Event event(*result, moduleDescription());
      postRead(event);
      if (remainingEvents_ > 0) --remainingEvents_;
      ++readCount_;
      setTimestamp(result->time());
      issueReports(result->id(), result->luminosityBlock());
    }
    return result;
  }

virtual std::auto_ptr<EventPrincipal> edm::InputSource::readEvent_

(

)

[private, pure virtual]

Implemented in edm::ConfigurableInputSource, edm::RawInputSource, edm::PoolSource, edm::StreamerInputSource, and edm::DaqSource.

Referenced by nextItemType_(), and readEvent().

boost::shared_ptr< FileBlock > edm::InputSource::readFile

(

)

Read next file.

Definition at line 188 of file InputSource.cc.

References doneReadAhead_, IsFile, limitReached(), readFile_(), and state_.

                        {
    assert(doneReadAhead_);
    assert(state_ == IsFile);
    assert(!limitReached());
    doneReadAhead_ = false;
    return readFile_();
  }

boost::shared_ptr< FileBlock > edm::InputSource::readFile_

(

)

[private, virtual]

Reimplemented in edm::PoolSource, and edm::StreamerInputSource.

Definition at line 205 of file InputSource.cc.

References primary(), productRegistryUpdate(), and edm::ProductRegistry::setProductIDs().

Referenced by readFile().

                         {
    if (primary()) {
      productRegistryUpdate().setProductIDs(1U);
    }
    return boost::shared_ptr<FileBlock>(new FileBlock);
  }

std::auto_ptr< EventPrincipal > edm::InputSource::readIt

(

EventID const &

)

[private, virtual]

Reimplemented in edm::RawInputSource, edm::PoolSource, and edm::DaqSource.

Definition at line 299 of file InputSource.cc.

References edm::errors::LogicError.

Referenced by readEvent().

                                    {
      throw edm::Exception(edm::errors::LogicError)
        << "InputSource::readIt()\n"
        << "Random access is not implemented for this type of Input Source\n"
        << "Contact a Framework Developer\n";
  }

boost::shared_ptr< LuminosityBlockPrincipal > edm::InputSource::readLuminosityBlock

(

boost::shared_ptr< RunPrincipal >

rp

)

Read next luminosity block.

Definition at line 225 of file InputSource.cc.

References doneReadAhead_, IsLumi, limitReached(), lumiPrincipal_, remainingLumis_, and state_.

                                                                   {
    // Note: For the moment, we do not support saving and restoring the state of the
    // random number generator if random numbers are generated during processing of lumi blocks
    // (e.g. beginLuminosityBlock(), endLuminosityBlock())
    assert(doneReadAhead_);
    assert(state_ == IsLumi);
    assert(!limitReached());
    doneReadAhead_ = false;
    --remainingLumis_;
    assert(lumiPrincipal_->run() == rp->run());
    lumiPrincipal_->setRunPrincipal(rp);
    return lumiPrincipal_;
  }

virtual boost::shared_ptr<LuminosityBlockPrincipal> edm::InputSource::readLuminosityBlock_

(

)

[private, pure virtual]

Implemented in edm::ConfigurableInputSource, edm::RawInputSource, edm::PoolSource, edm::StreamerInputSource, and edm::DaqSource.

Referenced by nextItemType(), and nextItemType_().

boost::shared_ptr< RunPrincipal > edm::InputSource::readRun

(

)

Read next run.

Definition at line 213 of file InputSource.cc.

References doneReadAhead_, IsRun, limitReached(), runPrincipal_, and state_.

                       {
    // Note: For the moment, we do not support saving and restoring the state of the
    // random number generator if random numbers are generated during processing of runs
    // (e.g. beginRun(), endRun())
    assert(doneReadAhead_);
    assert(state_ == IsRun);
    assert(!limitReached());
    doneReadAhead_ = false;
    return runPrincipal_;
  }

virtual boost::shared_ptr<RunPrincipal> edm::InputSource::readRun_

(

)

[private, pure virtual]

Implemented in edm::ConfigurableInputSource, edm::RawInputSource, edm::PoolSource, edm::StreamerInputSource, and edm::DaqSource.

Referenced by nextItemType().

void edm::InputSource::registerProducts

(

)

Register any produced products.

Definition at line 180 of file InputSource.cc.

References edm::ProductRegistryHelper::addToRegistry(), begin, empty, end, moduleDescription(), productRegistryUpdate(), and edm::ProductRegistryHelper::typeLabelList().

                                {
    if (!typeLabelList().empty()) {
      addToRegistry(typeLabelList().begin(), typeLabelList().end(), moduleDescription(), productRegistryUpdate());
    }
  }

int edm::InputSource::remainingEvents

(

)

const [inline]

Accessor for remaining number of events to be read.

-1 is used for unlimited.

Definition at line 151 of file InputSource.h.

References remainingEvents_.

Referenced by edm::FlatRandomEGunSource::FlatRandomEGunSource(), edm::AlpgenSource::produce(), ThePEGSource::produce(), edm::ToprexSource::produce(), edm::Herwig6Source::produce(), edm::MCatNLOSource::produce(), edm::ExhumeSource::produce(), edm::PythiaMuEnrichSource::produce(), edm::PythiaSource::produce(), edm::Pythia8Source::produce(), edm::ComphepSource::produce(), edm::PomwigSource::produce(), edm::MadGraphSource::produce(), edm::HydjetSource::produce(), edm::PyquenSource::produce(), and edm::RootInputFileSequence::remainingEvents().

{return remainingEvents_;}

int edm::InputSource::remainingLuminosityBlocks

(

)

const [inline]

Accessor for remaining number of lumis to be read.

-1 is used for unlimited.

Definition at line 159 of file InputSource.h.

References remainingLumis_.

Referenced by edm::RootInputFileSequence::remainingLuminosityBlocks().

{return remainingLumis_;}

void edm::InputSource::repeat

(

)

[inline]

Reset the remaining number of events/lumis to the maximum number.

Definition at line 139 of file InputSource.h.

References doneReadAhead_, maxEvents_, maxLumis_, remainingEvents_, and remainingLumis_.

                  {
      remainingEvents_ = maxEvents_;
      remainingLumis_ = maxLumis_;
      doneReadAhead_ = false;
    }

void edm::InputSource::reset

(

void

)

const [inline, protected]

Definition at line 257 of file InputSource.h.

References doneReadAhead_, IsInvalid, and state_.

Referenced by edm::StreamerInputSource::resetAfterEndRun().

                       {
      doneReadAhead_ = false;
      state_ = IsInvalid;
    }

void edm::InputSource::resetLuminosityBlockPrincipal

(

)

[inline, protected]

Definition at line 256 of file InputSource.h.

References lumiPrincipal_.

Referenced by edm::StreamerInputSource::deserializeEvent(), edm::StreamerInputSource::getNextItemType(), edm::RawInputSource::getNextItemType(), edm::ConfigurableInputSource::getNextItemType(), edm::ConfigurableInputSource::rewind_(), edm::ConfigurableInputSource::setLumi(), edm::ConfigurableInputSource::setRun(), and edm::OnlineHttpReader::setRun().

{lumiPrincipal_.reset();}

void edm::InputSource::resetRunPrincipal

(

)

[inline, protected]

Definition at line 255 of file InputSource.h.

References runPrincipal_.

Referenced by edm::StreamerInputSource::getNextItemType(), edm::RawInputSource::getNextItemType(), edm::ConfigurableInputSource::getNextItemType(), edm::ConfigurableInputSource::rewind_(), edm::ConfigurableInputSource::setRun(), and edm::OnlineHttpReader::setRun().

{runPrincipal_.reset();}

void edm::InputSource::rewind

(

)

[inline]

Begin again at the first event.

Definition at line 114 of file InputSource.h.

References doneReadAhead_, IsInvalid, rewind_(), and state_.

                  {
      doneReadAhead_ = false;
      state_ = IsInvalid;
      rewind_();
    }

void edm::InputSource::rewind_

(

)

[private, virtual]

Reimplemented in edm::ConfigurableInputSource, and edm::PoolSource.

Definition at line 331 of file InputSource.cc.

References edm::errors::LogicError.

Referenced by rewind().

                       {
      throw edm::Exception(edm::errors::LogicError)
        << "InputSource::rewind()\n"
        << "Rewind is not implemented for this type of Input Source\n"
        << "Contact a Framework Developer\n";
  }

RunNumber_t edm::InputSource::run

(

void

)

const

Accessor for current run number.

Reimplemented in edm::ConfigurableInputSource.

Definition at line 392 of file InputSource.cc.

References runPrincipal().

Referenced by edm::StreamerInputSource::deserializeEvent(), and doEndRun().

                         {
    assert(runPrincipal());
    return runPrincipal()->run();
  }

boost::shared_ptr<RunPrincipal> edm::InputSource::runPrincipal

(

)

const [inline, protected]

Definition at line 251 of file InputSource.h.

References runPrincipal_.

Referenced by edm::StreamerInputSource::deserializeEvent(), edm::StreamerInputSource::getNextItemType(), edm::ConfigurableInputSource::readLuminosityBlock_(), edm::StreamerInputSource::readRun_(), edm::ConfigurableInputSource::readRun_(), run(), and edm::RootInputFileSequence::runPrincipal().

{return runPrincipal_;}

void edm::InputSource::setLumi

(

LuminosityBlockNumber_t

lb

)

[private, virtual]

Reimplemented in edm::ConfigurableInputSource, edm::EDInputSource, and edm::DaqSource.

Definition at line 315 of file InputSource.cc.

References edm::errors::LogicError.

Referenced by setLuminosityBlockNumber_t().

                                              {
      throw edm::Exception(edm::errors::LogicError)
        << "InputSource::setLumi()\n"
        << "Luminosity Block ID  cannot be modified for this type of Input Source\n"
        << "Contact a Framework Developer\n";
  }

void edm::InputSource::setLuminosityBlockNumber_t

(

LuminosityBlockNumber_t

lb

)

[inline]

Set the luminosity block ID.

Definition at line 127 of file InputSource.h.

References setLumi().

{setLumi(lb);}

void edm::InputSource::setLuminosityBlockPrincipal

(

boost::shared_ptr< LuminosityBlockPrincipal >

lbp

)

[inline, protected]

Definition at line 254 of file InputSource.h.

References lumiPrincipal_.

Referenced by edm::StreamerInputSource::deserializeEvent(), and nextItemType().

{lumiPrincipal_ = lbp;}

void edm::InputSource::setRun

(

RunNumber_t

r

)

[private, virtual]

Reimplemented in edm::OnlineHttpReader, edm::ConfigurableInputSource, edm::EDInputSource, edm::StreamerInputSource, and edm::DaqSource.

Definition at line 307 of file InputSource.cc.

References edm::errors::LogicError.

Referenced by setRunNumber().

                                 {
      throw edm::Exception(edm::errors::LogicError)
        << "InputSource::setRun()\n"
        << "Run number cannot be modified for this type of Input Source\n"
        << "Contact a Framework Developer\n";
  }

void edm::InputSource::setRunNumber

(

RunNumber_t

r

)

[inline]

Set the run number.

Definition at line 124 of file InputSource.h.

References setRun().

Referenced by PixelSLinkDataInputSource::PixelSLinkDataInputSource(), HcalTBSource::setRunAndEventInfo(), L1MuGMTHWFileReader::setRunAndEventInfo(), ErrorStreamSource::setRunAndEventInfo(), TBRUInputSource::setRunAndEventInfo(), RPCFileReader::setRunAndEventInfo(), LinkDataXMLReader::setRunAndEventInfo(), DAQEcalTBInputService::setRunAndEventInfo(), and Ecal2004TBSource::setRunAndEventInfo().

{setRun(r);}

void edm::InputSource::setRunPrincipal

(

boost::shared_ptr< RunPrincipal >

rp

)

[inline, protected]

Definition at line 253 of file InputSource.h.

References runPrincipal_.

Referenced by edm::StreamerInputSource::deserializeEvent(), and nextItemType().

{runPrincipal_ = rp;}

void edm::InputSource::setTimestamp

(

Timestamp const &

theTime

)

[inline, protected]

To set the current time, as seen by the input source.

Definition at line 247 of file InputSource.h.

References time_.

Referenced by edm::ConfigurableInputSource::ConfigurableInputSource(), edm::DaqSource::DaqSource(), edm::RawInputSource::RawInputSource(), and readEvent().

{time_ = theTime;}

void edm::InputSource::skip

(

int

)

[private, virtual]

Reimplemented in edm::ConfigurableInputSource, edm::RawInputSource, edm::PoolSource, and edm::DaqSource.

Definition at line 323 of file InputSource.cc.

References edm::errors::LogicError.

Referenced by skipEvents().

                       {
      throw edm::Exception(edm::errors::LogicError)
        << "InputSource::skip()\n"
        << "Random access is not implemented for this type of Input Source\n"
        << "Contact a Framework Developer\n";
  }

void edm::InputSource::skipEvents

(

int

offset

)

Skip the number of events specified.

Offset may be negative.

Definition at line 282 of file InputSource.cc.

References skip().

                                    {
    this->skip(offset);
  }

ItemType edm::InputSource::state

(

)

const [inline, protected]

Definition at line 250 of file InputSource.h.

References state_.

Referenced by edm::RawInputSource::getNextItemType().

{return state_;}

Timestamp const& edm::InputSource::timestamp

(

)

const [inline]

Accessor for the current time, as seen by the input source.

Definition at line 184 of file InputSource.h.

References time_.

Referenced by edm::RawInputSource::readLuminosityBlock_(), and edm::RawInputSource::readRun_().

{return time_;}

void edm::InputSource::wakeUp

(

)

[inline]

Wake up the input source.

Definition at line 121 of file InputSource.h.

References wakeUp_().

{wakeUp_();}

void edm::InputSource::wakeUp_

(

)

[private, virtual]

Definition at line 377 of file InputSource.cc.

Referenced by wakeUp().

{}

---

Member Data Documentation

boost::shared_ptr<ActivityRegistry> edm::InputSource::actReg_ [private]

Definition at line 288 of file InputSource.h.

Referenced by actReg().

bool edm::InputSource::doneReadAhead_ [mutable, private]

Definition at line 300 of file InputSource.h.

Referenced by nextItemType(), readEvent(), readFile(), readLuminosityBlock(), readRun(), repeat(), reset(), and rewind().

boost::shared_ptr<LuminosityBlockPrincipal> edm::InputSource::lumiPrincipal_ [mutable, private]

Definition at line 303 of file InputSource.h.

Referenced by luminosityBlockPrincipal(), nextItemType(), readLuminosityBlock(), resetLuminosityBlockPrincipal(), and setLuminosityBlockPrincipal().

int edm::InputSource::maxEvents_ [private]

Definition at line 289 of file InputSource.h.

Referenced by maxEvents(), and repeat().

int edm::InputSource::maxLumis_ [private]

Definition at line 291 of file InputSource.h.

Referenced by maxLuminosityBlocks(), and repeat().

ModuleDescription const edm::InputSource::moduleDescription_ [private]

Definition at line 295 of file InputSource.h.

Referenced by moduleDescription().

bool const edm::InputSource::primary_ [private]

Definition at line 297 of file InputSource.h.

Referenced by InputSource(), and primary().

std::string edm::InputSource::processGUID_ [private]

Definition at line 298 of file InputSource.h.

Referenced by processGUID().

ProcessingMode edm::InputSource::processingMode_ [private]

Definition at line 294 of file InputSource.h.

Referenced by InputSource(), and processingMode().

boost::shared_ptr<ProductRegistry const> edm::InputSource::productRegistry_ [private]

Definition at line 296 of file InputSource.h.

Referenced by productRegistry().

int edm::InputSource::readCount_ [private]

Definition at line 293 of file InputSource.h.

Referenced by issueReports(), and readEvent().

int edm::InputSource::remainingEvents_ [private]

Definition at line 290 of file InputSource.h.

Referenced by eventLimitReached(), readEvent(), remainingEvents(), and repeat().

int edm::InputSource::remainingLumis_ [private]

Definition at line 292 of file InputSource.h.

Referenced by lumiLimitReached(), readLuminosityBlock(), remainingLuminosityBlocks(), and repeat().

boost::shared_ptr<RunPrincipal> edm::InputSource::runPrincipal_ [mutable, private]

Definition at line 302 of file InputSource.h.

Referenced by nextItemType(), readRun(), resetRunPrincipal(), runPrincipal(), and setRunPrincipal().

ItemType edm::InputSource::state_ [mutable, private]

Definition at line 301 of file InputSource.h.

Referenced by nextItemType(), readEvent(), readFile(), readLuminosityBlock(), readRun(), reset(), rewind(), and state().

Timestamp edm::InputSource::time_ [private]

Definition at line 299 of file InputSource.h.

Referenced by doEndLumi(), doEndRun(), setTimestamp(), and timestamp().

---

The documentation for this class was generated from the following files:

• FWCore/Framework/interface/InputSource.h
• FWCore/Framework/src/InputSource.cc

---