#include <InputSource.h>

Inheritance diagram for edm::InputSource:

Classes
class	EventSourceSentry
class	FileCloseSentry
class	FileOpenSentry
class	LumiSourceSentry
class	RunSourceSentry
class	SourceSentry
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 (boost::shared_ptr< FileBlock >)
	close current file
void	doBeginJob ()
	Called by framework at beginning of job.
void	doBeginLumi (LuminosityBlockPrincipal &lbp)
	Called by framework at beginning of lumi block.
void	doBeginRun (RunPrincipal &rp)
	Called by framework at beginning of run.
void	doEndJob ()
	Called by framework at end of job.
void	doEndLumi (LuminosityBlockPrincipal &lbp)
	Called by framework at end of lumi block.
void	doEndRun (RunPrincipal &rp)
	Called by framework at end of run.
void	doPostForkReacquireResources (boost::shared_ptr< multicore::MessageReceiverForSource >)
void	doPreForkReleaseResources ()
	Called by the framework before forking the process.
ProcessingController::ForwardState	forwardState () const
bool	goToEvent (EventID const &eventID)
	InputSource (ParameterSet const &, InputSourceDescription const &)
	Constructor.
void	issueReports (EventID const &eventID)
	issue an event report
LuminosityBlockNumber_t	luminosityBlock () const
	Accessor for current luminosity block number.
boost::shared_ptr < LuminosityBlockAuxiliary >	luminosityBlockAuxiliary () const
	Called by the framework to merge or insert lumi in principal cache.
int	markLumi ()
	Mark lumi as read.
int	markRun ()
	Mark run as read.
int	maxEvents () const
int	maxLuminosityBlocks () const
ModuleDescription const &	moduleDescription () const
	Accessor for 'module' description.
ItemType	nextItemType ()
bool	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.
bool	randomAccess () const
void	readAndCacheLumi (bool merge, HistoryAppender &historyAppender)
	Read next luminosity block.
void	readAndCacheRun (bool merge, HistoryAppender &historyAppender)
	Read next run.
EventPrincipal *	readEvent (boost::shared_ptr< LuminosityBlockPrincipal > lbCache)
EventPrincipal *	readEvent (EventID const &)
	Read a specific event.
boost::shared_ptr< FileBlock >	readFile ()
	Read next file.
boost::shared_ptr < LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary ()
	Read next luminosity block Auxilary.
boost::shared_ptr< RunAuxiliary >	readRunAuxiliary ()
	Read next run Auxiliary.
ProcessHistoryID const &	reducedProcessHistoryID () const
void	registerProducts ()
	Register any produced products.
int	remainingEvents () const
int	remainingLuminosityBlocks () const
void	repeat ()
	Reset the remaining number of events/lumis to the maximum number.
ProcessingController::ReverseState	reverseState () const
void	rewind ()
	Begin again at the first event.
RunNumber_t	run () const
	Accessor for current run number.
boost::shared_ptr< RunAuxiliary >	runAuxiliary () const
	Called by the framework to merge or insert run in principal cache.
void	setLuminosityBlockNumber_t (LuminosityBlockNumber_t lb)
	Set the luminosity block ID.
void	setRunNumber (RunNumber_t r)
	Set the run number.
void	skipEvents (int offset)
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.
Static Public Member Functions
static const std::string &	baseType ()
static void	fillDescription (ParameterSetDescription &desc)
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)
Protected Member Functions
void	decreaseRemainingEventsBy (int iSkipped)
EventPrincipal *	eventPrincipalCache ()
boost::shared_ptr < LuminosityBlockPrincipal > const	luminosityBlockPrincipal () const
PrincipalCache const &	principalCache () const
PrincipalCache &	principalCache ()
ProductRegistry &	productRegistryUpdate () 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.
ItemType	state () const
Private Member Functions
virtual void	beginJob ()
virtual void	beginLuminosityBlock (LuminosityBlock &)
virtual void	beginRun (Run &)
virtual void	closeFile_ ()
virtual void	endJob ()
virtual void	endLuminosityBlock (LuminosityBlock &)
virtual void	endRun (Run &)
bool	eventLimitReached () const
virtual ProcessingController::ForwardState	forwardState_ () const
virtual ItemType	getNextItemType ()=0
virtual bool	goToEvent_ (EventID const &eventID)
bool	limitReached () const
bool	lumiLimitReached () const
ItemType	nextItemType_ ()
virtual void	postForkReacquireResources (boost::shared_ptr< multicore::MessageReceiverForSource >)
void	postRead (Event &event)
virtual void	preForkReleaseResources ()
virtual bool	randomAccess_ () const
virtual EventPrincipal *	readEvent_ ()=0
virtual boost::shared_ptr < FileBlock >	readFile_ ()
virtual EventPrincipal *	readIt (EventID const &)
virtual boost::shared_ptr < LuminosityBlockPrincipal >	readLuminosityBlock_ (boost::shared_ptr< LuminosityBlockPrincipal > lbCache)
virtual boost::shared_ptr < LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary_ ()=0
virtual boost::shared_ptr < RunPrincipal >	readRun_ (boost::shared_ptr< RunPrincipal > rpCache)
virtual boost::shared_ptr < RunAuxiliary >	readRunAuxiliary_ ()=0
virtual ProcessingController::ReverseState	reverseState_ () const
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 < LuminosityBlockAuxiliary >	lumiAuxiliary_
int	maxEvents_
int	maxLumis_
ModuleDescription const	moduleDescription_
bool const	primary_
PrincipalCache *	principalCache_
std::string	processGUID_
ProcessingMode	processingMode_
boost::shared_ptr < ProductRegistry const >	productRegistry_
int	readCount_
int	remainingEvents_
int	remainingLumis_
boost::shared_ptr< RunAuxiliary >	runAuxiliary_
ItemType	state_
std::string	statusFileName_
Timestamp	time_

Detailed Description

Definition at line 68 of file InputSource.h.

Member Typedef Documentation

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

Reimplemented from edm::ProductRegistryHelper.

Definition at line 86 of file InputSource.h.

Member Enumeration Documentation

enum edm::InputSource::ItemType

Enumerator:

IsInvalid
IsStop
IsFile
IsRun
IsLumi
IsEvent
IsRepeat

Definition at line 70 of file InputSource.h.

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

enum edm::InputSource::ProcessingMode

Enumerator:

Runs
RunsAndLumis
RunsLumisAndEvents

Definition at line 80 of file InputSource.h.

                        {
      Runs,
      RunsAndLumis,
      RunsLumisAndEvents
    };

Constructor & Destructor Documentation

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

Constructor.

Definition at line 53 of file InputSource.cc.

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

                                                                                       :
      ProductRegistryHelper(),
      actReg_(desc.actReg_),
      principalCache_(desc.principalCache_),
      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),
      runAuxiliary_(),
      lumiAuxiliary_(),
      statusFileName_() {

    if(pset.getUntrackedParameter<bool>("writeStatusFile", false)) {
      std::ostringstream statusfilename;
      statusfilename << "source_" << getpid();
      statusFileName_ = statusfilename.str();
    }

    // Secondary input sources currently do not have a product registry.
    if(primary_) {
      assert(desc.productRegistry_ != 0);
    }
    std::string const defaultMode("RunsLumisAndEvents");
    std::string const runMode("Runs");
    std::string const runLumiMode("RunsAndLumis");

    // The default value provided as the second argument to the getUntrackedParameter function call
    // is not used when the ParameterSet has been validated and the parameters are not optional
    // in the description.  As soon as all primary input sources and all modules with a secondary
    // input sources have defined descriptions, the defaults in the getUntrackedParameterSet function
    // calls can and should be deleted from the code.
    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 Exception(errors::Configuration)
        << "InputSource::InputSource()\n"
        << "The 'processingMode' parameter for sources has an illegal value '" << processingMode << "'\n"
        << "Legal values are '" << defaultMode << "', '" << runLumiMode << "', or '" << runMode << "'.\n";
    }
  }

InputSource::~InputSource ( ) [virtual]

Destructor.

Definition at line 106 of file InputSource.cc.

{}

Member Function Documentation

boost::shared_ptr<ActivityRegistry> edm::InputSource::actReg ( ) const [inline]

Accessor for Activity Registry.

Definition at line 242 of file InputSource.h.

References actReg_.

{return actReg_;}

std::string const & InputSource::baseType ( ) [static]

Definition at line 123 of file InputSource.cc.

References edm::kBaseType().

                        {
    return kBaseType;
  }

void InputSource::beginJob ( void ) [private, virtual]

Reimplemented in EcalSimpleSource.

Definition at line 524 of file InputSource.cc.

Referenced by doBeginJob().

{}

void InputSource::beginLuminosityBlock ( LuminosityBlock & ) [private, virtual]

Reimplemented in ErrorStreamSource, and edm::ConfigurableInputSource.

Definition at line 512 of file InputSource.cc.

Referenced by doBeginLumi().

{}

void InputSource::beginRun ( Run & ) [private, virtual]

Reimplemented in ErrorStreamSource, edm::ConfigurableInputSource, AlpgenSource, LHESource, and MCatNLOSource.

Definition at line 518 of file InputSource.cc.

Referenced by doBeginRun().

{}

void InputSource::closeFile ( boost::shared_ptr< FileBlock > fb )

close current file

Definition at line 242 of file InputSource.cc.

References closeFile_().

                                                      {
    fb->close();
    closeFile_();
    return;
  }

virtual void edm::InputSource::closeFile_ ( ) [inline, private, virtual]

Reimplemented in DQMRootSource, and edm::PoolSource.

Definition at line 345 of file InputSource.h.

Referenced by closeFile().

{}

void InputSource::decreaseRemainingEventsBy ( int iSkipped ) [protected]

Called by inheriting classes when running multicore when the receiver has told them to skip some events.

Definition at line 449 of file InputSource.cc.

References remainingEvents_.

Referenced by edm::PoolSource::getNextItemType(), edm::ConfigurableInputSource::rewind_(), and edm::ConfigurableInputSource::setRunAndEventInfo().

                                                     {
    if(-1 == remainingEvents_) {
      return;
    }
    if(iSkipped < remainingEvents_) {
      remainingEvents_ -= iSkipped;
    } else {
      remainingEvents_ = 0;
    }
  }

void InputSource::doBeginJob ( )

Called by framework at beginning of job.

Definition at line 214 of file InputSource.cc.

References beginJob().

                          {
    this->beginJob();
  }

void InputSource::doBeginLumi ( LuminosityBlockPrincipal & lbp )

Called by framework at beginning of lumi block.

Definition at line 484 of file InputSource.cc.

References beginLuminosityBlock(), edm::LuminosityBlock::commit_(), and moduleDescription().

                                                        {
    LuminosityBlock lb(lbp, moduleDescription());
    beginLuminosityBlock(lb);
    lb.commit_();
  }

void InputSource::doBeginRun ( RunPrincipal & rp )

Called by framework at beginning of run.

Definition at line 469 of file InputSource.cc.

References beginRun(), edm::Run::commit_(), moduleDescription(), and run().

                                          {
    Run run(rp, moduleDescription());
    beginRun(run);
    run.commit_();
  }

void InputSource::doEndJob ( )

Called by framework at end of job.

Definition at line 219 of file InputSource.cc.

References endJob().

Referenced by edm::PileUp::endJob().

                        {
    endJob();
  }

void InputSource::doEndLumi ( LuminosityBlockPrincipal & lbp )

Called by framework at end of lumi block.

Definition at line 491 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 InputSource::doEndRun ( RunPrincipal & rp )

Called by framework at end of run.

Definition at line 476 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 InputSource::doPostForkReacquireResources ( boost::shared_ptr< multicore::MessageReceiverForSource > iReceiver )

Definition at line 504 of file InputSource.cc.

References postForkReacquireResources().

                                                                                                        {
    postForkReacquireResources(iReceiver);
  }

void InputSource::doPreForkReleaseResources ( )

Called by the framework before forking the process.

Definition at line 499 of file InputSource.cc.

References preForkReleaseResources().

                                         {
    preForkReleaseResources();
  }

void InputSource::endJob ( void ) [private, virtual]

Reimplemented in LHESource, MCatNLOSource, and edm::PoolSource.

Definition at line 527 of file InputSource.cc.

Referenced by doEndJob().

{}

void InputSource::endLuminosityBlock ( LuminosityBlock & ) [private, virtual]

Reimplemented in DQMRootSource, ErrorStreamSource, and edm::ConfigurableInputSource.

Definition at line 515 of file InputSource.cc.

Referenced by doEndLumi().

{}

void InputSource::endRun ( Run & ) [private, virtual]

Reimplemented in DQMRootSource, ErrorStreamSource, edm::ConfigurableInputSource, edm::CosMuoGenSource, and LHESource.

Definition at line 521 of file InputSource.cc.

Referenced by doEndRun().

{}

bool edm::InputSource::eventLimitReached ( ) const [inline, private]

Definition at line 332 of file InputSource.h.

References remainingEvents_.

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

{return remainingEvents_ == 0;}

EventPrincipal * InputSource::eventPrincipalCache ( ) [protected]

Definition at line 138 of file InputSource.cc.

References edm::PrincipalCache::eventPrincipal(), and principalCache().

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

                                   {
    return &principalCache().eventPrincipal();
  }

void InputSource::fillDescription ( ParameterSetDescription & desc ) [static]

Reimplemented in edm::ConfigurableInputSource, edm::EDInputSource, edm::ExternalInputSource, and edm::StreamerInputSource.

Definition at line 128 of file InputSource.cc.

References edm::ParameterSetDescription::addUntracked().

                                                            {
    std::string defaultString("RunsLumisAndEvents");
    desc.addUntracked<std::string>("processingMode", defaultString)->setComment(
    "'RunsLumisAndEvents': process runs, lumis, and events.\n"
    "'RunsAndLumis':       process runs and lumis (not events).\n"
    "'Runs':               process runs (not lumis or events).");
    desc.addUntracked<bool>("writeStatusFile", false)->setComment("Write a status file. Intended for use by workflow management.");
  }

void InputSource::fillDescriptions ( ConfigurationDescriptions & descriptions ) [static]

Reimplemented in DQMRootSource, edm::EmptySource, edm::PoolSource, and edm::StreamerFileReader.

Definition at line 109 of file InputSource.cc.

References edm::ConfigurationDescriptions::addDefault(), and edm::ParameterSetDescription::setUnknown().

                                                                       {
    ParameterSetDescription desc;
    desc.setUnknown();
    descriptions.addDefault(desc);
  }

ProcessingController::ForwardState edm::InputSource::forwardState ( ) const [inline]

Definition at line 251 of file InputSource.h.

References forwardState_().

{ return forwardState_(); }

ProcessingController::ForwardState InputSource::forwardState_ ( ) const [private, virtual]

Reimplemented in edm::PoolSource.

Definition at line 541 of file InputSource.cc.

References edm::ProcessingController::kUnknownForward.

Referenced by forwardState().

                                   {
    return ProcessingController::kUnknownForward;
  }

virtual ItemType edm::InputSource::getNextItemType ( ) [private, pure virtual]

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

Referenced by nextItemType_().

bool InputSource::goToEvent ( EventID const & eventID )

Definition at line 376 of file InputSource.cc.

References doneReadAhead_, and goToEvent_().

                                               {
    doneReadAhead_ = false;
    return this->goToEvent_(eventID);
  }

bool InputSource::goToEvent_ ( EventID const & eventID ) [private, virtual]

Reimplemented in edm::PoolSource.

Definition at line 432 of file InputSource.cc.

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

Referenced by goToEvent().

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

void InputSource::issueReports ( EventID const & eventID )

issue an event report

Definition at line 382 of file InputSource.cc.

References edm::EventID::event(), edm::isInfoEnabled(), edm::EventID::luminosityBlock(), readCount_, edm::EventID::run(), statusFileName_, and createPayload::suffix.

Referenced by readEvent().

                                                  {
    if(isInfoEnabled()) {
      LogVerbatim("FwkReport") << "Begin processing the " << readCount_
                               << suffix(readCount_) << " record. Run " << eventID.run()
                               << ", Event " << eventID.event()
                               << ", LumiSection " << eventID.luminosityBlock()
                               << " at " << std::setprecision(3) << TimeOfDay();
    }
    if(!statusFileName_.empty()) {
      std::ofstream statusFile(statusFileName_.c_str());
      statusFile << eventID << " time: " << std::setprecision(3) << TimeOfDay() << '\n';
      statusFile.close();
    }

    // At some point we may want to initiate checkpointing here
  }

bool edm::InputSource::limitReached ( ) const [inline, private]

Definition at line 334 of file InputSource.h.

References eventLimitReached(), and lumiLimitReached().

Referenced by markLumi(), markRun(), readEvent(), and readFile().

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

bool edm::InputSource::lumiLimitReached ( ) const [inline, private]

Definition at line 333 of file InputSource.h.

References remainingLumis_.

Referenced by limitReached(), and nextItemType().

{return remainingLumis_ == 0;}

LuminosityBlockNumber_t InputSource::luminosityBlock ( ) const

Accessor for current luminosity block number.

Reimplemented in edm::ConfigurableInputSource.

Definition at line 563 of file InputSource.cc.

References luminosityBlockAuxiliary().

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

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

boost::shared_ptr<LuminosityBlockAuxiliary> edm::InputSource::luminosityBlockAuxiliary ( ) const [inline]

Called by the framework to merge or insert lumi in principal cache.

Definition at line 248 of file InputSource.h.

References lumiAuxiliary_.

Referenced by edm::StreamerInputSource::deserializeEvent(), edm::StreamerInputSource::getNextItemType(), luminosityBlock(), edm::RawInputSource::makeEvent(), markLumi(), readAndCacheLumi(), and edm::StreamerInputSource::readLuminosityBlockAuxiliary_().

{return lumiAuxiliary_;}

boost::shared_ptr< LuminosityBlockPrincipal > const InputSource::luminosityBlockPrincipal ( ) const [protected]

Definition at line 262 of file InputSource.cc.

References edm::PrincipalCache::lumiPrincipalPtr(), and principalCache_.

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

                                              {
    return principalCache_->lumiPrincipalPtr();
  }

int InputSource::markLumi ( )

Mark lumi as read.

Definition at line 305 of file InputSource.cc.

References doneReadAhead_, IsLumi, limitReached(), edm::LuminosityBlockPrincipal::luminosityBlock(), luminosityBlockAuxiliary(), edm::PrincipalCache::lumiPrincipal(), principalCache_, remainingLumis_, and state_.

                        {
    assert(doneReadAhead_);
    assert(state_ == IsLumi);
    assert(!limitReached());
    doneReadAhead_ = false;
    --remainingLumis_;
    assert(principalCache_->lumiPrincipal().luminosityBlock() == luminosityBlockAuxiliary()->luminosityBlock());
    return principalCache_->lumiPrincipal().luminosityBlock();
  }

int InputSource::markRun ( )

Mark run as read.

Definition at line 279 of file InputSource.cc.

References doneReadAhead_, IsRun, limitReached(), principalCache_, edm::RunPrincipal::run(), edm::PrincipalCache::runPrincipal(), and state_.

                       {
    assert(doneReadAhead_);
    assert(state_ == IsRun);
    assert(!limitReached());
    doneReadAhead_ = false;
    return principalCache_->runPrincipal().run();
  }

int edm::InputSource::maxEvents ( ) const [inline]

Accessor for maximum number of events to be read. -1 is used for unlimited.

Definition at line 176 of file InputSource.h.

References maxEvents_.

Referenced by edm::H2RootNtplSource::H2RootNtplSource().

{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 184 of file InputSource.h.

References maxLumis_.

{return maxLumis_;}

ModuleDescription const& edm::InputSource::moduleDescription ( ) const [inline]

Accessor for 'module' description.

Definition at line 191 of file InputSource.h.

References moduleDescription_.

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

{return moduleDescription_;}

InputSource::ItemType InputSource::nextItemType ( )

Definition at line 165 of file InputSource.cc.

References doneReadAhead_, eventLimitReached(), IsEvent, IsFile, IsInvalid, IsLumi, IsRun, IsStop, lumiAuxiliary_, lumiLimitReached(), nextItemType_(), processingMode(), readLuminosityBlockAuxiliary(), readRunAuxiliary(), runAuxiliary_, Runs, RunsLumisAndEvents, 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) {
        runAuxiliary_ = readRunAuxiliary();
        state_ = IsRun;
      } else if(newState == IsLumi || oldState == IsRun) {
        assert (processingMode() != Runs);
        lumiAuxiliary_ = readLuminosityBlockAuxiliary();
        state_ = IsLumi;
      } else {
        assert (processingMode() == RunsLumisAndEvents);
        state_ = IsEvent;
      }
    }
    if(state_ == IsStop) {
      lumiAuxiliary_.reset();
      runAuxiliary_.reset();
    }
    return state_;
  }

InputSource::ItemType InputSource::nextItemType_ ( ) [private]

Definition at line 151 of file InputSource.cc.

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

Referenced by nextItemType().

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

void InputSource::postForkReacquireResources ( boost::shared_ptr< multicore::MessageReceiverForSource > ) [private, virtual]

Definition at line 533 of file InputSource.cc.

Referenced by doPostForkReacquireResources().

{}

void InputSource::postRead ( Event & event ) [private]

Definition at line 461 of file InputSource.cc.

References edm::Service< T >::isAvailable().

Referenced by readEvent().

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

void InputSource::preForkReleaseResources ( ) [private, virtual]

Reimplemented in edm::PoolSource.

Definition at line 530 of file InputSource.cc.

Referenced by doPreForkReleaseResources().

{}

void InputSource::prevalidate ( ConfigurationDescriptions & ) [static]

Definition at line 116 of file InputSource.cc.

                                                      {
  }

bool edm::InputSource::primary ( ) const [inline]

Accessor for primary input source flag.

Definition at line 197 of file InputSource.h.

References primary_.

{return primary_;}

PrincipalCache& edm::InputSource::principalCache ( ) [inline, protected]

Definition at line 323 of file InputSource.h.

References principalCache_.

{return *principalCache_;}

PrincipalCache const& edm::InputSource::principalCache ( ) const [inline, protected]

Definition at line 322 of file InputSource.h.

References principalCache_.

Referenced by edm::StreamerInputSource::deserializeAndMergeWithRegistry(), eventPrincipalCache(), edm::PoolSource::getNextItemType(), and edm::PoolSource::rewind_().

{return *principalCache_;}

ProcessConfiguration const& edm::InputSource::processConfiguration ( ) const [inline]

Accessor for Process Configuration.

Definition at line 194 of file InputSource.h.

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

Referenced by edm::RootInputFileSequence::processConfiguration(), readAndCacheLumi(), readAndCacheRun(), edm::PoolSource::readLuminosityBlock_(), and edm::PoolSource::readRun_().

{return moduleDescription().processConfiguration();}

std::string const& edm::InputSource::processGUID ( ) const [inline]

Accessor for global process identifier.

Definition at line 200 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 239 of file InputSource.h.

References processingMode_.

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

{return processingMode_;}

boost::shared_ptr<ProductRegistry const> edm::InputSource::productRegistry ( ) const [inline]

Accessor for product registry.

Definition at line 165 of file InputSource.h.

References productRegistry_.

Referenced by edm::StreamerInputSource::deserializeAndMergeWithRegistry(), and edm::RootInputFileSequence::productRegistry().

{return productRegistry_;}

ProductRegistry& edm::InputSource::productRegistryUpdate ( ) const [inline, protected]

Definition at line 305 of file InputSource.h.

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

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

bool edm::InputSource::randomAccess ( ) const [inline]

Definition at line 250 of file InputSource.h.

References randomAccess_().

{ return randomAccess_(); }

bool InputSource::randomAccess_ ( ) const [private, virtual]

Reimplemented in edm::PoolSource.

Definition at line 536 of file InputSource.cc.

Referenced by randomAccess().

                                   {
    return false;
  }

void InputSource::readAndCacheLumi	(	bool	merge,
		HistoryAppender &	historyAppender
	)

Read next run Auxiliary.

Definition at line 115 of file InputSource.h.

References readRunAuxiliary_().

Referenced by nextItemType().

{return readRunAuxiliary_();}

virtual boost::shared_ptr<RunAuxiliary> edm::InputSource::readRunAuxiliary_ ( ) [private, pure virtual]

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

Referenced by readRunAuxiliary().

ProcessHistoryID const & InputSource::reducedProcessHistoryID ( ) const

Accessor for the reduced process history ID of the current run. This is the ID of the input process history which does not include the current process.

Definition at line 551 of file InputSource.cc.

References instance, and runAuxiliary().

                                             {
    assert(runAuxiliary());
    return ProcessHistoryRegistry::instance()->extra().reduceProcessHistoryID(runAuxiliary()->processHistoryID());
  }

void InputSource::registerProducts ( )

Register any produced products.

Definition at line 224 of file InputSource.cc.

References edm::ProductRegistryHelper::addToRegistry(), begin, relativeConstraints::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 180 of file InputSource.h.

References remainingEvents_.

Referenced by edm::FlatRandomEGunSource::FlatRandomEGunSource(), edm::FlatRandomEThetaGunSource::FlatRandomEThetaGunSource(), edm::FlatRandomPtThetaGunSource::FlatRandomPtThetaGunSource(), edm::PoolSource::getNextItemType(), edm::RootInputFileSequence::remainingEvents(), and edm::ConfigurableInputSource::setRunAndEventInfo().

{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 188 of file InputSource.h.

References remainingLumis_.

Referenced by edm::RootInputFileSequence::remainingLuminosityBlocks(), and edm::ConfigurableInputSource::setRunAndEventInfo().

{return remainingLumis_;}

void edm::InputSource::repeat ( ) [inline]

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

Definition at line 168 of file InputSource.h.

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

Referenced by edm::ConfigurableInputSource::postForkReacquireResources().

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

void edm::InputSource::reset ( void ) const [inline, protected]

Definition at line 315 of file InputSource.h.

References doneReadAhead_, IsInvalid, resetLuminosityBlockAuxiliary(), resetRunAuxiliary(), and state_.

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

                       {
      resetLuminosityBlockAuxiliary();
      resetRunAuxiliary();
      doneReadAhead_ = false;
      state_ = IsInvalid;
    }

void edm::InputSource::resetLuminosityBlockAuxiliary ( ) const [inline, protected]

Definition at line 312 of file InputSource.h.

References lumiAuxiliary_.

Referenced by edm::StreamerInputSource::deserializeEvent(), edm::StreamerInputSource::getNextItemType(), reset(), and edm::StreamerInputSource::resetAfterEndRun().

                                               {
      lumiAuxiliary_.reset();
    }

void edm::InputSource::resetRunAuxiliary ( ) const [inline, protected]

Definition at line 309 of file InputSource.h.

References runAuxiliary_.

Referenced by edm::StreamerInputSource::getNextItemType(), reset(), and edm::StreamerInputSource::resetAfterEndRun().

                                   {
      runAuxiliary_.reset();
    }

ProcessingController::ReverseState edm::InputSource::reverseState ( ) const [inline]

Definition at line 252 of file InputSource.h.

References reverseState_().

{ return reverseState_(); }

ProcessingController::ReverseState InputSource::reverseState_ ( ) const [private, virtual]

Reimplemented in edm::PoolSource.

Definition at line 546 of file InputSource.cc.

References edm::ProcessingController::kUnknownReverse.

Referenced by reverseState().

                                   {
    return ProcessingController::kUnknownReverse;
  }

void edm::InputSource::rewind ( ) [inline]

Begin again at the first event.

Definition at line 142 of file InputSource.h.

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

Referenced by edm::ConfigurableInputSource::postForkReacquireResources().

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

void InputSource::rewind_ ( ) [private, virtual]

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

Definition at line 441 of file InputSource.cc.

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

Referenced by rewind().

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

RunNumber_t InputSource::run ( void ) const

Accessor for current run number.

Reimplemented in edm::ConfigurableInputSource.

Definition at line 557 of file InputSource.cc.

References runAuxiliary().

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

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

boost::shared_ptr<RunAuxiliary> edm::InputSource::runAuxiliary ( ) const [inline]

Called by the framework to merge or insert run in principal cache.

Definition at line 245 of file InputSource.h.

References runAuxiliary_.

Referenced by edm::StreamerInputSource::deserializeEvent(), edm::StreamerInputSource::getNextItemType(), edm::RawInputSource::makeEvent(), readAndCacheRun(), edm::StreamerInputSource::readRunAuxiliary_(), reducedProcessHistoryID(), and run().

{return runAuxiliary_;}

boost::shared_ptr< RunPrincipal > const InputSource::runPrincipal ( ) const [protected]

Definition at line 257 of file InputSource.cc.

References principalCache_, and edm::PrincipalCache::runPrincipalPtr().

                                  {
    return principalCache_->runPrincipalPtr();
  }

void InputSource::setLumi ( LuminosityBlockNumber_t lb ) [private, virtual]

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

Definition at line 416 of file InputSource.cc.

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

Referenced by setLuminosityBlockNumber_t().

                                              {
    throw Exception(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::setLuminosityBlockAuxiliary ( LuminosityBlockAuxiliary * lbp ) [inline, protected]

Definition at line 308 of file InputSource.h.

References lumiAuxiliary_.

Referenced by edm::StreamerInputSource::deserializeEvent(), and edm::RawInputSource::makeEvent().

{lumiAuxiliary_.reset(lbp);}

void edm::InputSource::setLuminosityBlockNumber_t ( LuminosityBlockNumber_t lb ) [inline]

Set the luminosity block ID.

Definition at line 156 of file InputSource.h.

References setLumi().

Referenced by cond::EmptyIOVSource::setRunAndEventInfo(), and LmfSource::setRunAndEventInfo().

{setLumi(lb);}

void InputSource::setRun ( RunNumber_t r ) [private, virtual]

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

Definition at line 408 of file InputSource.cc.

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

Referenced by setRunNumber().

                                 {
    throw Exception(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::setRunAuxiliary ( RunAuxiliary * rp ) [inline, protected]

Definition at line 307 of file InputSource.h.

References runAuxiliary_.

Referenced by edm::StreamerInputSource::deserializeEvent(), and edm::RawInputSource::makeEvent().

{runAuxiliary_.reset(rp);}

void edm::InputSource::setRunNumber ( RunNumber_t r ) [inline]

Set the run number.

Definition at line 153 of file InputSource.h.

References setRun().

Referenced by PixelSLinkDataInputSource::PixelSLinkDataInputSource(), HcalTBSource::setRunAndEventInfo(), L1MuGMTHWFileReader::setRunAndEventInfo(), cond::EmptyIOVSource::setRunAndEventInfo(), ErrorStreamSource::setRunAndEventInfo(), and LmfSource::setRunAndEventInfo().

{setRun(r);}

void edm::InputSource::setTimestamp ( Timestamp const & theTime ) [inline, protected]

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

Definition at line 303 of file InputSource.h.

References time_.

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

{time_ = theTime;}

void InputSource::skip ( int ) [private, virtual]

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

Definition at line 424 of file InputSource.cc.

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

Referenced by skipEvents().

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

void InputSource::skipEvents ( int offset )

Skip the number of events specified. Offset may be negative.

Definition at line 370 of file InputSource.cc.

References doneReadAhead_, and skip().

                                    {
    doneReadAhead_ = false;
    this->skip(offset);
  }

ItemType edm::InputSource::state ( ) const [inline, protected]

Definition at line 306 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 225 of file InputSource.h.

References time_.

Referenced by edm::RawInputSource::readLuminosityBlockAuxiliary_(), and edm::RawInputSource::readRunAuxiliary_().

{return time_;}

void edm::InputSource::wakeUp ( ) [inline]

Wake up the input source.

Definition at line 150 of file InputSource.h.

References wakeUp_().

{wakeUp_();}

void InputSource::wakeUp_ ( ) [private, virtual]

Definition at line 509 of file InputSource.cc.

Referenced by wakeUp().

{}

Member Data Documentation

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

Definition at line 367 of file InputSource.h.

Referenced by actReg().

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

Definition at line 380 of file InputSource.h.

Referenced by goToEvent(), markLumi(), markRun(), nextItemType(), readEvent(), readFile(), repeat(), reset(), rewind(), and skipEvents().

boost::shared_ptr<LuminosityBlockAuxiliary> edm::InputSource::lumiAuxiliary_ [mutable, private]

Definition at line 383 of file InputSource.h.

Referenced by luminosityBlockAuxiliary(), nextItemType(), resetLuminosityBlockAuxiliary(), and setLuminosityBlockAuxiliary().

int edm::InputSource::maxEvents_ [private]

Reimplemented in LmfSource.

Definition at line 369 of file InputSource.h.

Referenced by maxEvents(), repeat(), and rewind().

int edm::InputSource::maxLumis_ [private]

Definition at line 371 of file InputSource.h.

Referenced by maxLuminosityBlocks(), and repeat().

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

Definition at line 375 of file InputSource.h.

Referenced by moduleDescription().

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

Definition at line 377 of file InputSource.h.

Referenced by InputSource(), and primary().

PrincipalCache* edm::InputSource::principalCache_ [private]

Definition at line 368 of file InputSource.h.

Referenced by luminosityBlockPrincipal(), markLumi(), markRun(), principalCache(), readAndCacheLumi(), readAndCacheRun(), and runPrincipal().

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

Definition at line 378 of file InputSource.h.

Referenced by processGUID().

ProcessingMode edm::InputSource::processingMode_ [private]

Definition at line 374 of file InputSource.h.

Referenced by InputSource(), and processingMode().

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

Definition at line 376 of file InputSource.h.

Referenced by productRegistry(), readAndCacheLumi(), and readAndCacheRun().

int edm::InputSource::readCount_ [private]

Definition at line 373 of file InputSource.h.

Referenced by issueReports(), and readEvent().

int edm::InputSource::remainingEvents_ [private]

Definition at line 370 of file InputSource.h.

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

int edm::InputSource::remainingLumis_ [private]

Definition at line 372 of file InputSource.h.

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

boost::shared_ptr<RunAuxiliary> edm::InputSource::runAuxiliary_ [mutable, private]

Definition at line 382 of file InputSource.h.

Referenced by nextItemType(), resetRunAuxiliary(), runAuxiliary(), and setRunAuxiliary().

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

Definition at line 381 of file InputSource.h.

Referenced by markLumi(), markRun(), nextItemType(), readEvent(), readFile(), reset(), rewind(), and state().

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

Definition at line 384 of file InputSource.h.

Referenced by InputSource(), and issueReports().

Timestamp edm::InputSource::time_ [private]

Definition at line 379 of file InputSource.h.

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

void InputSource::readAndCacheRun	(	bool	merge,
		HistoryAppender &	historyAppender
	)

edm::InputSource Class Reference

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation