edm::InputSource Class Reference

#include <InputSource.h>

Inheritance diagram for edm::InputSource:

Classes
class	EventSourceSentry
class	FileCloseSentry
class	FileOpenSentry
class	ItemTypeInfo
class	LumiSourceSentry
class	ProcessBlockSourceSentry
class	RunSourceSentry

Public Types
enum	ItemPosition : char { ItemPosition::Invalid, ItemPosition::LastItemToBeMerged, ItemPosition::NotLastItemToBeMerged }
enum	ItemType : char {   ItemType::IsInvalid, ItemType::IsStop, ItemType::IsFile, ItemType::IsRun,   ItemType::IsLumi, ItemType::IsEvent, ItemType::IsRepeat, ItemType::IsSynchronize }
enum	ProcessingMode { Runs, RunsAndLumis, RunsLumisAndEvents }

Public Member Functions
std::shared_ptr< ActivityRegistry >	actReg () const
	Accessor for Activity Registry. More...
std::shared_ptr< BranchIDListHelper const >	branchIDListHelper () const
	Accessors for branchIDListHelper. More...
std::shared_ptr< BranchIDListHelper > &	branchIDListHelper ()
void	closeFile (FileBlock *, bool cleaningUpAfterException)
	close current file More...
void	doBeginJob ()
	Called by framework at beginning of job. More...
virtual void	doBeginLumi (LuminosityBlockPrincipal &lbp, ProcessContext const *)
	Called by framework at beginning of lumi block. More...
virtual void	doBeginRun (RunPrincipal &rp, ProcessContext const *)
	Called by framework at beginning of run. More...
void	doEndJob ()
	Called by framework at end of job. More...
void	fillProcessBlockHelper ()
	Fill the ProcessBlockHelper with info for the current file. More...
ProcessingController::ForwardState	forwardState () const
bool	goToEvent (EventID const &eventID)
	InputSource (ParameterSet const &, InputSourceDescription const &)
	Constructor. More...
	InputSource (InputSource const &)=delete
void	issueReports (EventID const &eventID, StreamID streamID)
	issue an event report More...
LuminosityBlockNumber_t	luminosityBlock () const
	Accessor for current luminosity block number. More...
std::shared_ptr< LuminosityBlockAuxiliary >	luminosityBlockAuxiliary () const
	Called by the framework to merge or insert lumi in principal cache. More...
int	maxEvents () const
int	maxLuminosityBlocks () const
ModuleDescription const &	moduleDescription () const
	Accessor for 'module' description. More...
ItemTypeInfo	nextItemType ()
	Advances the source to the next item. More...
bool	nextProcessBlock (ProcessBlockPrincipal &)
	Next process block, return false if there is none, sets the processName in the principal. More...
InputSource &	operator= (InputSource const &)=delete
std::shared_ptr< ProcessBlockHelper const >	processBlockHelper () const
	Accessors for processBlockHelper. More...
std::shared_ptr< ProcessBlockHelper > &	processBlockHelper ()
ProcessConfiguration const &	processConfiguration () const
	Accessor for Process Configuration. More...
std::string const &	processGUID () const
	Accessor for global process identifier. More...
ProcessHistoryRegistry const &	processHistoryRegistry () const
	Accessors for process history registry. More...
ProcessHistoryRegistry &	processHistoryRegistry ()
ProcessingMode	processingMode () const
	RunsLumisAndEvents (default), RunsAndLumis, or Runs. More...
std::shared_ptr< ProductRegistry const >	productRegistry () const
	Accessors for product registry. More...
bool	randomAccess () const
void	readAndMergeLumi (LuminosityBlockPrincipal &lbp)
	Read next luminosity block (same as a prior lumi) More...
void	readAndMergeRun (RunPrincipal &rp)
	Read next run (same as a prior run) More...
void	readEvent (EventPrincipal &ep, StreamContext &)
	Read next event. More...
bool	readEvent (EventPrincipal &ep, EventID const &, StreamContext &)
	Read a specific event. More...
std::shared_ptr< FileBlock >	readFile ()
	Read next file. More...
void	readLuminosityBlock (LuminosityBlockPrincipal &lumiPrincipal, HistoryAppender &historyAppender)
	Read next luminosity block (new lumi) More...
std::shared_ptr< LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary ()
	Read next luminosity block Auxilary. More...
void	readProcessBlock (ProcessBlockPrincipal &)
	Read next process block. More...
void	readRun (RunPrincipal &runPrincipal, HistoryAppender &historyAppender)
	Read next run (new run) More...
std::shared_ptr< RunAuxiliary >	readRunAuxiliary ()
	Read next run Auxiliary. More...
ProcessHistoryID const &	reducedProcessHistoryID () const
virtual 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...
std::pair< SharedResourcesAcquirer *, std::recursive_mutex * >	resourceSharedWithDelayedReader ()
	Returns nullptr if no resource shared between the Source and a DelayedReader. More...
ProcessingController::ReverseState	reverseState () const
void	rewind ()
	Begin again at the first event. More...
RunNumber_t	run () const
	Accessor for current run number. More...
std::shared_ptr< RunAuxiliary >	runAuxiliary () 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)
void	switchTo (std::shared_ptr< ProductRegistry > iOther)
	switch to a different ProductRegistry. More...
std::shared_ptr< ThinnedAssociationsHelper const >	thinnedAssociationsHelper () const
	Accessors for thinnedAssociationsHelper. More...
std::shared_ptr< ThinnedAssociationsHelper > &	thinnedAssociationsHelper ()
Timestamp const &	timestamp () const
	Accessor for the current time, as seen by the input source. More...
virtual	~InputSource () noexcept(false)
	Destructor. More...

Static Public Member Functions
static const std::string &	baseType ()
static void	fillDescription (ParameterSetDescription &desc)
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &)

Public Attributes
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	postEventReadFromSourceSignal_
signalslot::Signal< void(StreamContext const &, ModuleCallingContext const &)>	preEventReadFromSourceSignal_

Protected Member Functions
virtual void	beginJob ()
	Begin protected makes it easier to do template programming. More...
void	decreaseRemainingEventsBy (int iSkipped)
bool	eventCached () const
bool	newLumi () const
bool	newRun () const
ProcessHistoryRegistry &	processHistoryRegistryForUpdate ()
ProductRegistry &	productRegistryUpdate ()
void	reset () const
void	resetEventCached ()
void	resetLuminosityBlockAuxiliary (bool isNewLumi=true) const
void	resetNewLumi ()
void	resetNewRun ()
void	resetRunAuxiliary (bool isNewRun=true) const
void	setEventCached ()
	Called by the framework to merge or ached() const {return eventCached_;}. More...
void	setLuminosityBlockAuxiliary (LuminosityBlockAuxiliary *lbp)
void	setNewLumi ()
void	setNewRun ()
void	setRunAuxiliary (RunAuxiliary *rp)
void	setTimestamp (Timestamp const &theTime)
	To set the current time, as seen by the input source. More...
virtual void	skip (int offset)
ItemTypeInfo	state () const

Private Member Functions
virtual void	closeFile_ ()
virtual void	endJob ()
bool	eventLimitReached () const
virtual void	fillProcessBlockHelper_ ()
virtual ProcessingController::ForwardState	forwardState_ () const
virtual ItemTypeInfo	getNextItemType ()=0
virtual bool	goToEvent_ (EventID const &eventID)
bool	limitReached () const
bool	lumiLimitReached () const
ItemTypeInfo	nextItemType_ ()
virtual bool	nextProcessBlock_ (ProcessBlockPrincipal &)
virtual bool	randomAccess_ () const
virtual void	readEvent_ (EventPrincipal &eventPrincipal)=0
virtual std::shared_ptr< FileBlock >	readFile_ ()
virtual bool	readIt (EventID const &id, EventPrincipal &eventPrincipal, StreamContext &streamContext)
virtual void	readLuminosityBlock_ (LuminosityBlockPrincipal &lumiPrincipal)
virtual std::shared_ptr< LuminosityBlockAuxiliary >	readLuminosityBlockAuxiliary_ ()=0
virtual void	readProcessBlock_ (ProcessBlockPrincipal &)
virtual void	readRun_ (RunPrincipal &runPrincipal)
virtual std::shared_ptr< RunAuxiliary >	readRunAuxiliary_ ()=0
virtual std::pair< SharedResourcesAcquirer *, std::recursive_mutex * >	resourceSharedWithDelayedReader_ ()
virtual ProcessingController::ReverseState	reverseState_ () const
virtual void	rewind_ ()
virtual void	setLumi (LuminosityBlockNumber_t lb)
virtual void	setRun (RunNumber_t r)

Private Attributes
std::shared_ptr< ActivityRegistry >	actReg_
edm::propagate_const< std::shared_ptr< BranchIDListHelper > >	branchIDListHelper_
bool	eventCached_
std::shared_ptr< LuminosityBlockAuxiliary >	lumiAuxiliary_
int	maxEvents_
int	maxLumis_
int	maxSecondsUntilRampdown_
ModuleDescription const	moduleDescription_
bool	newLumi_
bool	newRun_
unsigned int	numberOfEventsBeforeBigSkip_
edm::propagate_const< std::shared_ptr< ProcessBlockHelper > >	processBlockHelper_
std::string	processGUID_
edm::propagate_const< std::unique_ptr< ProcessHistoryRegistry > >	processHistoryRegistry_
ProcessingMode	processingMode_
std::chrono::time_point< std::chrono::steady_clock >	processingStart_
edm::propagate_const< std::shared_ptr< ProductRegistry > >	productRegistry_
int	readCount_
int	remainingEvents_
int	remainingLumis_
std::shared_ptr< RunAuxiliary >	runAuxiliary_
ItemTypeInfo	state_
std::string	statusFileName_
edm::propagate_const< std::shared_ptr< ThinnedAssociationsHelper > >	thinnedAssociationsHelper_
Timestamp	time_

Detailed Description

Definition at line 52 of file InputSource.h.

Member Enumeration Documentation

ItemPosition

enum edm::InputSource::ItemPosition : char

strong

Enumerator
Invalid
LastItemToBeMerged
NotLastItemToBeMerged

Definition at line 55 of file InputSource.h.

: char { Invalid, LastItemToBeMerged, NotLastItemToBeMerged };

ItemType

enum edm::InputSource::ItemType : char

strong

Enumerator
IsInvalid
IsStop
IsFile
IsRun
IsLumi
IsEvent
IsRepeat
IsSynchronize

Definition at line 54 of file InputSource.h.

: char { IsInvalid, IsStop, IsFile, IsRun, IsLumi, IsEvent, IsRepeat, IsSynchronize };

ProcessingMode

enum edm::InputSource::ProcessingMode

Enumerator
Runs
RunsAndLumis
RunsLumisAndEvents

Definition at line 85 of file InputSource.h.

{ Runs, RunsAndLumis, RunsLumisAndEvents };

Constructor & Destructor Documentation

InputSource() [1/2]

InputSource::InputSource ( ParameterSet const &  pset, InputSourceDescription const &  desc  )

explicit

Constructor.

Definition at line 47 of file InputSource.cc.

References edm::errors::Configuration, Exception, maxSecondsUntilRampdown_, submitPVValidationJobs::now, processingMode(), processingMode_, processingStart_, muonDTDigis_cfi::pset, TopDecaySubset_cfi::runMode, Runs, RunsAndLumis, statusFileName_, and AlCaHLTBitMon_QueryRunRegistry::string.

      : actReg_(desc.actReg_),
        maxEvents_(desc.maxEvents_),
        remainingEvents_(maxEvents_),
        maxLumis_(desc.maxLumis_),
        remainingLumis_(maxLumis_),
        readCount_(0),
        maxSecondsUntilRampdown_(desc.maxSecondsUntilRampdown_),
        processingMode_(RunsLumisAndEvents),
        moduleDescription_(desc.moduleDescription_),
        productRegistry_(desc.productRegistry_),
        processHistoryRegistry_(new ProcessHistoryRegistry),
        branchIDListHelper_(desc.branchIDListHelper_),
        processBlockHelper_(desc.processBlockHelper_),
        thinnedAssociationsHelper_(desc.thinnedAssociationsHelper_),
        processGUID_(edm::processGUID().toBinary()),
        time_(),
        newRun_(true),
        newLumi_(true),
        eventCached_(false),
        state_(),
        runAuxiliary_(),
        lumiAuxiliary_(),
        statusFileName_(),
        numberOfEventsBeforeBigSkip_(0) {
    if (pset.getUntrackedParameter<bool>("writeStatusFile", false)) {
      std::ostringstream statusfilename;
      statusfilename << "source_" << getpid();
      statusFileName_ = statusfilename.str();
    }
    if (maxSecondsUntilRampdown_ > 0) {
      processingStart_ = std::chrono::steady_clock::now();
    }

    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::~InputSource ( )

virtualnoexcept

Destructor.

Definition at line 103 of file InputSource.cc.

{}

InputSource() [2/2]

edm::InputSource::InputSource ( InputSource const &  )

delete

Member Function Documentation

actReg()

std::shared_ptr<ActivityRegistry> edm::InputSource::actReg ( ) const

inline

Accessor for Activity Registry.

Definition at line 258 of file InputSource.h.

References actReg_.

Referenced by edm::InputSource::LumiSourceSentry::LumiSourceSentry(), edm::InputSource::ProcessBlockSourceSentry::ProcessBlockSourceSentry(), and edm::InputSource::RunSourceSentry::RunSourceSentry().

{ return actReg_; }

baseType()

std::string const & InputSource::baseType ( )

static

Definition at line 115 of file InputSource.cc.

References edm::kBaseType().

{ return kBaseType; }

beginJob()

void InputSource::beginJob ( void  )

protectedvirtual

Begin protected makes it easier to do template programming.

Reimplemented in edm::RepeatingCachedRootSource, edm::IDGeneratorSourceBase< InputSource >, edm::IDGeneratorSourceBase< PuttableSourceBase >, edm::PuttableSourceBase, and edm::ThrowingSource.

Definition at line 439 of file InputSource.cc.

Referenced by doBeginJob().

{}

branchIDListHelper() [1/2]

std::shared_ptr<BranchIDListHelper const> edm::InputSource::branchIDListHelper ( ) const

inline

Accessors for branchIDListHelper.

Definition at line 172 of file InputSource.h.

References branchIDListHelper_, and edm::get_underlying_safe().

Referenced by edm::RepeatingCachedRootSource::beginJob(), edm::DelayedReaderThrowingSource::DelayedReaderThrowingSource(), edm::StreamerInputSource::deserializeAndMergeWithRegistry(), edm::RootSecondaryFileSequence::makeRootFile(), edm::RootPrimaryFileSequence::makeRootFile(), edm::RepeatingCachedRootSource::makeRootFile(), edm::StreamerInputSource::mergeIntoRegistry(), edm::StreamerInputSource::read(), and edm::DelayedReaderThrowingSource::readEvent_().

                                                                       {
      return get_underlying_safe(branchIDListHelper_);
    }

branchIDListHelper() [2/2]

std::shared_ptr<BranchIDListHelper>& edm::InputSource::branchIDListHelper ( )

inline

Definition at line 175 of file InputSource.h.

References branchIDListHelper_, and edm::get_underlying_safe().

{ return get_underlying_safe(branchIDListHelper_); }

closeFile()

void InputSource::closeFile	(	FileBlock *	fb,
		bool	cleaningUpAfterException
	)

close current file

Definition at line 230 of file InputSource.cc.

References edm::FileBlock::close(), and closeFile_().

                                                                          {
    if (fb != nullptr)
      fb->close();
    callWithTryCatchAndPrint<void>(
        [this]() { closeFile_(); }, "Calling InputSource::closeFile_", cleaningUpAfterException);
    return;
  }

closeFile_()

virtual void edm::InputSource::closeFile_ ( )

inlineprivatevirtual

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

Definition at line 430 of file InputSource.h.

Referenced by closeFile().

{}

decreaseRemainingEventsBy()

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 410 of file InputSource.cc.

References remainingEvents_.

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

doBeginJob()

void InputSource::doBeginJob

(

)

Called by framework at beginning of job.

Definition at line 208 of file InputSource.cc.

References beginJob().

{ this->beginJob(); }

doBeginLumi()

void InputSource::doBeginLumi ( LuminosityBlockPrincipal &  lbp, ProcessContext const *    )

virtual

Called by framework at beginning of lumi block.

Reimplemented in edm::PuttableSourceBase.

Definition at line 423 of file InputSource.cc.

{}

doBeginRun()

void InputSource::doBeginRun ( RunPrincipal &  rp, ProcessContext const *    )

virtual

Called by framework at beginning of run.

Reimplemented in edm::PuttableSourceBase.

Definition at line 421 of file InputSource.cc.

{}

doEndJob()

void InputSource::doEndJob

(

)

Called by framework at end of job.

Definition at line 210 of file InputSource.cc.

References endJob().

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

{ endJob(); }

endJob()

void InputSource::endJob ( void  )

privatevirtual

Reimplemented in edm::PoolSource, LH5Source, LHESource, and edm::ThrowingSource.

Definition at line 441 of file InputSource.cc.

Referenced by doEndJob().

{}

eventCached()

bool edm::InputSource::eventCached ( ) const

inlineprotected

Definition at line 389 of file InputSource.h.

References eventCached_.

Referenced by edm::RawInputSource::getNextItemType(), edm::ThrowingSource::readEvent_(), edm::RawInputSource::readEvent_(), LH5Source::readEvent_(), LHESource::readEvent_(), and edm::StreamerInputSource::resetAfterEndRun().

{ return eventCached_; }

eventLimitReached()

bool edm::InputSource::eventLimitReached ( ) const

inlineprivate

Definition at line 402 of file InputSource.h.

References remainingEvents_.

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

{ return remainingEvents_ == 0; }

fillDescription()

void InputSource::fillDescription ( ParameterSetDescription &  desc )

static

Definition at line 117 of file InputSource.cc.

References submitPVResolutionJobs::desc, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by edm::RawInputSource::fillDescription(), edm::PoolSource::fillDescriptions(), and edm::RepeatingCachedRootSource::fillDescriptions().

                                                                 {
    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.");
  }

fillDescriptions()

void InputSource::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 105 of file InputSource.cc.

References edm::ConfigurationDescriptions::addDefault(), and submitPVResolutionJobs::desc.

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

fillProcessBlockHelper()

void InputSource::fillProcessBlockHelper

(

)

Fill the ProcessBlockHelper with info for the current file.

Definition at line 272 of file InputSource.cc.

References fillProcessBlockHelper_().

{ fillProcessBlockHelper_(); }

fillProcessBlockHelper_()

void InputSource::fillProcessBlockHelper_ ( )

privatevirtual

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

Definition at line 284 of file InputSource.cc.

Referenced by fillProcessBlockHelper().

{}

forwardState()

ProcessingController::ForwardState InputSource::forwardState

(

)

const

Definition at line 429 of file InputSource.cc.

References forwardState_().

                                                                   {
    return callWithTryCatchAndPrint<ProcessingController::ForwardState>([this]() { return forwardState_(); },
                                                                        "Calling InputSource::forwardState_");
  }

forwardState_()

ProcessingController::ForwardState InputSource::forwardState_ ( ) const

privatevirtual

Reimplemented in edm::PoolSource.

Definition at line 445 of file InputSource.cc.

References edm::ProcessingController::kUnknownForward.

Referenced by forwardState().

                                                                    {
    return ProcessingController::kUnknownForward;
  }

getNextItemType()

virtual ItemTypeInfo edm::InputSource::getNextItemType ( )

privatepure virtual

Implemented in DQMRootSource, edm::RepeatingCachedRootSource, edm::IDGeneratorSourceBase< InputSource >, edm::IDGeneratorSourceBase< PuttableSourceBase >, edmtest::SourceWithWaits, edm::PoolSource, edm::RawInputSource, edmtest::PutOrMergeTestSource, dqmservices::DQMProtobufReader, edm::TestSource, and edm::OneLumiPoolSource.

Referenced by nextItemType_().

goToEvent()

bool InputSource::goToEvent

(

EventID const &

eventID

)

Definition at line 343 of file InputSource.cc.

References goToEvent_().

                                                    {
    return callWithTryCatchAndPrint<bool>([this, &eventID]() { return goToEvent_(eventID); },
                                          "Calling InputSource::goToEvent_");
  }

goToEvent_()

bool InputSource::goToEvent_ ( EventID const &  eventID )

privatevirtual

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

Definition at line 397 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;
  }

issueReports()

void InputSource::issueReports	(	EventID const &	eventID,
		StreamID	streamID
	)

issue an event report

Definition at line 357 of file InputSource.cc.

References edm::EventID::event(), edm::isFwkInfoEnabled(), edm::EventID::luminosityBlock(), readCount_, edm::EventID::run(), statusFileName_, makePlotsFromDump::suffix, and edm::StreamID::value().

Referenced by readEvent().

                                                                          {
    if (isFwkInfoEnabled()) {
      LogFwkVerbatim("FwkReport") << "Begin processing the " << readCount_ << suffix(readCount_) << " record. Run "
                                  << eventID.run() << ", Event " << eventID.event() << ", LumiSection "
                                  << eventID.luminosityBlock() << " on stream " << streamID.value() << " 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
  }

limitReached()

bool edm::InputSource::limitReached ( ) const

inlineprivate

Definition at line 417 of file InputSource.h.

References eventLimitReached(), and lumiLimitReached().

Referenced by readEvent(), and readFile().

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

lumiLimitReached()

bool edm::InputSource::lumiLimitReached ( ) const

inlineprivate

Definition at line 403 of file InputSource.h.

References submitPVResolutionJobs::count, maxSecondsUntilRampdown_, submitPVValidationJobs::now, processingStart_, and remainingLumis_.

Referenced by limitReached(), and nextItemType().

                                  {
      if (remainingLumis_ == 0) {
        return true;
      }
      if (maxSecondsUntilRampdown_ <= 0) {
        return false;
      }
      auto end = std::chrono::steady_clock::now();
      auto elapsed = end - processingStart_;
      if (std::chrono::duration_cast<std::chrono::seconds>(elapsed).count() > maxSecondsUntilRampdown_) {
        return true;
      }
      return false;
    }

luminosityBlock()

LuminosityBlockNumber_t InputSource::luminosityBlock

(

)

const

Accessor for current luminosity block number.

Definition at line 463 of file InputSource.cc.

References cms::cuda::assert(), and luminosityBlockAuxiliary().

Referenced by Types.EventID::cppID(), Types.LuminosityBlockID::cppID(), edm::StreamerInputSource::deserializeEvent(), FedRawDataInputSource::maybeOpenNewLumiSection(), DAQSource::maybeOpenNewLumiSection(), and edm::PoolSource::readIt().

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

luminosityBlockAuxiliary()

std::shared_ptr<LuminosityBlockAuxiliary> edm::InputSource::luminosityBlockAuxiliary ( ) const

inline

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

Definition at line 264 of file InputSource.h.

References lumiAuxiliary_.

Referenced by edm::StreamerInputSource::deserializeEvent(), edm::RawInputSource::getNextItemType(), luminosityBlock(), FedRawDataInputSource::maybeOpenNewLumiSection(), DAQSource::maybeOpenNewLumiSection(), LHESource::readLuminosityBlock_(), LH5Source::readLuminosityBlock_(), and edm::RawInputSource::readLuminosityBlockAuxiliary_().

{ return lumiAuxiliary_; }

maxEvents()

int edm::InputSource::maxEvents ( ) const

inline

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

Definition at line 205 of file InputSource.h.

References maxEvents_.

{ return maxEvents_; }

maxLuminosityBlocks()

int edm::InputSource::maxLuminosityBlocks ( ) const

inline

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

Definition at line 213 of file InputSource.h.

References maxLumis_.

{ return maxLumis_; }

moduleDescription()

ModuleDescription const& edm::InputSource::moduleDescription ( ) const

inline

Accessor for 'module' description.

Definition at line 220 of file InputSource.h.

References moduleDescription_.

Referenced by edm::PuttableSourceBase::beginJob(), edm::PuttableSourceBase::doBeginLumi(), edm::PuttableSourceBase::doBeginRun(), processConfiguration(), edm::ProducerSourceBase::readEvent_(), and edm::PuttableSourceBase::registerProducts().

{ return moduleDescription_; }

newLumi()

bool edm::InputSource::newLumi ( ) const

inlineprotected

Definition at line 386 of file InputSource.h.

References newLumi_.

Referenced by edm::RawInputSource::getNextItemType(), edm::RawInputSource::readEvent_(), and edm::RawInputSource::readLuminosityBlockAuxiliary_().

{ return newLumi_; }

newRun()

bool edm::InputSource::newRun ( ) const

inlineprotected

Definition at line 383 of file InputSource.h.

References newRun_.

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

{ return newRun_; }

nextItemType()

InputSource::ItemTypeInfo InputSource::nextItemType

(

)

Advances the source to the next item.

Definition at line 151 of file InputSource.cc.

References cms::cuda::assert(), eventLimitReached(), IsEvent, IsFile, IsInvalid, IsLumi, IsRun, IsStop, IsSynchronize, edm::InputSource::ItemTypeInfo::itemType(), lumiAuxiliary_, lumiLimitReached(), nextItemType_(), processingMode(), readLuminosityBlockAuxiliary(), readRunAuxiliary(), runAuxiliary_, Runs, RunsLumisAndEvents, and state_.

                                                    {
    ItemType oldType = state_.itemType();
    if (eventLimitReached()) {
      // If the maximum event limit has been reached, stop.
      state_ = ItemType::IsStop;
    } else if (lumiLimitReached()) {
      // If the maximum lumi limit has been reached, stop
      // when reaching a new file, run, or lumi.
      if (oldType == ItemType::IsInvalid || oldType == ItemType::IsFile || oldType == ItemType::IsRun ||
          processingMode() != RunsLumisAndEvents) {
        state_ = ItemType::IsStop;
      } else {
        ItemTypeInfo newState = nextItemType_();
        if (newState == ItemType::IsEvent) {
          assert(processingMode() == RunsLumisAndEvents);
          state_ = ItemType::IsEvent;
        } else {
          state_ = ItemType::IsStop;
        }
      }
    } else {
      ItemTypeInfo newState = nextItemType_();
      if (newState == ItemType::IsStop) {
        state_ = ItemType::IsStop;
      } else if (newState == ItemType::IsSynchronize) {
        state_ = ItemType::IsSynchronize;
      } else if (newState == ItemType::IsFile || oldType == ItemType::IsInvalid) {
        state_ = ItemType::IsFile;
      } else if (newState == ItemType::IsRun || oldType == ItemType::IsFile) {
        runAuxiliary_ = readRunAuxiliary();
        state_ = (newState == ItemType::IsRun) ? newState : ItemTypeInfo(ItemType::IsRun);
      } else if (newState == ItemType::IsLumi || oldType == ItemType::IsRun) {
        assert(processingMode() != Runs);
        lumiAuxiliary_ = readLuminosityBlockAuxiliary();
        state_ = (newState == ItemType::IsLumi) ? newState : ItemTypeInfo(ItemType::IsLumi);
      } else {
        assert(processingMode() == RunsLumisAndEvents);
        state_ = ItemType::IsEvent;
      }
    }
    if (state_ == ItemType::IsStop) {
      lumiAuxiliary_.reset();
      runAuxiliary_.reset();
    }
    return state_;
  }

nextItemType_()

InputSource::ItemTypeInfo InputSource::nextItemType_ ( )

private

Definition at line 136 of file InputSource.cc.

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

Referenced by nextItemType().

                                                     {
    ItemTypeInfo itemTypeInfo = callWithTryCatchAndPrint<ItemTypeInfo>([this]() { return getNextItemType(); },
                                                                       "Calling InputSource::getNextItemType");

    if (itemTypeInfo == ItemType::IsEvent && processingMode() != RunsLumisAndEvents) {
      skipEvents(1);
      return nextItemType_();
    }
    if (itemTypeInfo == ItemType::IsLumi && processingMode() == Runs) {
      // QQQ skipLuminosityBlock_();
      return nextItemType_();
    }
    return itemTypeInfo;
  }

nextProcessBlock()

bool InputSource::nextProcessBlock

(

ProcessBlockPrincipal &

processBlockPrincipal

)

Next process block, return false if there is none, sets the processName in the principal.

Definition at line 274 of file InputSource.cc.

References nextProcessBlock_().

                                                                                 {
    return nextProcessBlock_(processBlockPrincipal);
  }

nextProcessBlock_()

bool InputSource::nextProcessBlock_ ( ProcessBlockPrincipal &  )

privatevirtual

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

Definition at line 286 of file InputSource.cc.

Referenced by nextProcessBlock().

{ return false; }

operator=()

InputSource& edm::InputSource::operator= ( InputSource const &  )

delete

prevalidate()

void InputSource::prevalidate ( ConfigurationDescriptions &  )

static

Definition at line 111 of file InputSource.cc.

{}

processBlockHelper() [1/2]

std::shared_ptr<ProcessBlockHelper const> edm::InputSource::processBlockHelper ( ) const

inline

Accessors for processBlockHelper.

Definition at line 178 of file InputSource.h.

References edm::get_underlying_safe(), and processBlockHelper_.

Referenced by edm::RootPrimaryFileSequence::makeRootFile(), and edm::RepeatingCachedRootSource::makeRootFile().

                                                                       {
      return get_underlying_safe(processBlockHelper_);
    }

processBlockHelper() [2/2]

std::shared_ptr<ProcessBlockHelper>& edm::InputSource::processBlockHelper ( )

inline

Definition at line 181 of file InputSource.h.

References edm::get_underlying_safe(), and processBlockHelper_.

{ return get_underlying_safe(processBlockHelper_); }

processConfiguration()

ProcessConfiguration const& edm::InputSource::processConfiguration ( ) const

inline

Accessor for Process Configuration.

Definition at line 223 of file InputSource.h.

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

Referenced by edm::RepeatingCachedRootSource::beginJob(), edm::RootSecondaryFileSequence::makeRootFile(), edm::RootPrimaryFileSequence::makeRootFile(), edm::RepeatingCachedRootSource::makeRootFile(), edm::PoolSource::PoolSource(), edm::PoolSource::readLuminosityBlock_(), and edm::PoolSource::readRun_().

{ return moduleDescription().processConfiguration(); }

processGUID()

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

inline

Accessor for global process identifier.

Definition at line 226 of file InputSource.h.

References processGUID_.

Referenced by FedRawDataInputSource::read(), DataModeFRD::readEvent(), DataModeScoutingRun3::readEvent(), DataModeFRDStriped::readEvent(), edm::TestSource::readEvent_(), edm::ThrowingSource::readEvent_(), LHESource::readEvent_(), LH5Source::readEvent_(), and edmtest::SourceWithWaits::readEvent_().

{ return processGUID_; }

processHistoryRegistry() [1/2]

ProcessHistoryRegistry const& edm::InputSource::processHistoryRegistry ( ) const

inline

Accessors for process history registry.

Definition at line 168 of file InputSource.h.

References processHistoryRegistry_.

Referenced by edm::DelayedReaderThrowingSource::DelayedReaderThrowingSource(), edm::RawInputSource::makeEvent(), edm::StreamerInputSource::read(), edm::TestSource::readEvent_(), edm::ThrowingSource::readEvent_(), LH5Source::readEvent_(), LHESource::readEvent_(), edmtest::SourceWithWaits::readEvent_(), edm::RepeatingCachedRootSource::readEvent_(), dqmservices::DQMProtobufReader::readLuminosityBlock_(), LHESource::readLuminosityBlock_(), LH5Source::readLuminosityBlock_(), DQMRootSource::readLuminosityBlock_(), readLuminosityBlock_(), edmtest::PutOrMergeTestSource::readRun_(), and readRun_().

{ return *processHistoryRegistry_; }

processHistoryRegistry() [2/2]

ProcessHistoryRegistry& edm::InputSource::processHistoryRegistry ( )

inline

Definition at line 169 of file InputSource.h.

References processHistoryRegistry_.

{ return *processHistoryRegistry_; }

processHistoryRegistryForUpdate()

ProcessHistoryRegistry& edm::InputSource::processHistoryRegistryForUpdate ( )

inlineprotected

Definition at line 360 of file InputSource.h.

References processHistoryRegistry_.

Referenced by DAQSource::DAQSource(), edm::StreamerInputSource::deserializeEvent(), FedRawDataInputSource::FedRawDataInputSource(), LH5Source::LH5Source(), LHESource::LHESource(), edm::RepeatingCachedRootSource::makeRootFile(), LHESource::nextEvent(), LH5Source::nextEvent(), dqmservices::DQMProtobufReader::readRun_(), LH5Source::readRun_(), LHESource::readRun_(), and DQMRootSource::readRun_().

{ return *processHistoryRegistry_; }

processingMode()

ProcessingMode edm::InputSource::processingMode ( ) const

inline

RunsLumisAndEvents (default), RunsAndLumis, or Runs.

Definition at line 255 of file InputSource.h.

References processingMode_.

Referenced by InputSource(), edm::RootSecondaryFileSequence::makeRootFile(), edm::RootPrimaryFileSequence::makeRootFile(), edm::RepeatingCachedRootSource::makeRootFile(), nextItemType(), nextItemType_(), edm::ThrowingSource::readEvent_(), LHESource::readEvent_(), LH5Source::readEvent_(), edm::ThrowingSource::readLuminosityBlockAuxiliary_(), LHESource::readLuminosityBlockAuxiliary_(), and LH5Source::readLuminosityBlockAuxiliary_().

{ return processingMode_; }

productRegistry()

std::shared_ptr<ProductRegistry const> edm::InputSource::productRegistry ( ) const

inline

Accessors for product registry.

Definition at line 165 of file InputSource.h.

References edm::get_underlying_safe(), and productRegistry_.

Referenced by edm::PuttableSourceBase::beginJob(), edm::RepeatingCachedRootSource::beginJob(), and edm::StreamerInputSource::read().

{ return get_underlying_safe(productRegistry_); }

productRegistryUpdate()

ProductRegistry& edm::InputSource::productRegistryUpdate ( )

inlineprotected

Definition at line 359 of file InputSource.h.

References productRegistry_.

Referenced by DAQSource::DAQSource(), edm::DelayedReaderThrowingSource::DelayedReaderThrowingSource(), edm::StreamerInputSource::deserializeAndMergeWithRegistry(), FedRawDataInputSource::FedRawDataInputSource(), edm::PoolSource::PoolSource(), edmtest::PutOrMergeTestSource::registerProducts(), edm::PuttableSourceBase::registerProducts(), and edm::RepeatingCachedRootSource::RepeatingCachedRootSource().

{ return *productRegistry_; }

randomAccess()

bool InputSource::randomAccess

(

)

const

Definition at line 425 of file InputSource.cc.

References randomAccess_().

                                       {
    return callWithTryCatchAndPrint<bool>([this]() { return randomAccess_(); }, "Calling InputSource::randomAccess_");
  }

randomAccess_()

bool InputSource::randomAccess_ ( ) const

privatevirtual

Reimplemented in edm::PoolSource.

Definition at line 443 of file InputSource.cc.

Referenced by randomAccess().

{ return false; }

readAndMergeLumi()

void InputSource::readAndMergeLumi

(

LuminosityBlockPrincipal &

lbp

)

Read next luminosity block (same as a prior lumi)

Definition at line 263 of file InputSource.cc.

References edm::LuminosityBlockPrincipal::index(), readLuminosityBlock_(), and remainingLumis_.

                                                                  {
    LumiSourceSentry sentry(*this, lbp.index());
    callWithTryCatchAndPrint<void>([this, &lbp]() { readLuminosityBlock_(lbp); },
                                   "Calling InputSource::readLuminosityBlock_");
    if (remainingLumis_ > 0) {
      --remainingLumis_;
    }
  }

readAndMergeRun()

void InputSource::readAndMergeRun

(

RunPrincipal &

rp

)

Read next run (same as a prior run)

Definition at line 249 of file InputSource.cc.

References edm::RunPrincipal::index(), and readRun_().

                                                    {
    RunSourceSentry sentry(*this, rp.index());
    callWithTryCatchAndPrint<void>([this, &rp]() { readRun_(rp); }, "Calling InputSource::readRun_");
  }

readEvent() [1/2]

void InputSource::readEvent	(	EventPrincipal &	ep,
		StreamContext &	streamContext
	)

Read next event.

Definition at line 302 of file InputSource.cc.

References cms::cuda::assert(), SiStripBadComponentsDQMServiceTemplate_cfg::ep, eventLimitReached(), IsEvent, issueReports(), readCount_, readEvent_(), remainingEvents_, setTimestamp(), and state_.

                                                                              {
    assert(state_ == ItemType::IsEvent);
    assert(!eventLimitReached());
    {
      // block scope, in order to issue the PostSourceEvent signal before calling postRead and issueReports
      EventSourceSentry sentry(*this, streamContext);

      callWithTryCatchAndPrint<void>([this, &ep]() { readEvent_(ep); }, "Calling InputSource::readEvent_");
    }

    if (remainingEvents_ > 0)
      --remainingEvents_;
    ++readCount_;
    setTimestamp(ep.time());
    issueReports(ep.id(), ep.streamID());
  }

readEvent() [2/2]

bool InputSource::readEvent	(	EventPrincipal &	ep,
		EventID const &	eventID,
		StreamContext &	streamContext
	)

Read a specific event.

Definition at line 319 of file InputSource.cc.

References SiStripBadComponentsDQMServiceTemplate_cfg::ep, issueReports(), limitReached(), readCount_, readIt(), remainingEvents_, and mps_fire::result.

                                                                                                      {
    bool result = false;

    if (not limitReached()) {
      // the Pre/PostSourceEvent signals should be generated only if the event is actually found.
      // this should be taken care of by an EventSourceSentry in the implementaion of readIt()

      //result = callWithTryCatchAndPrint<bool>( [this,&eventID,&ep](){ return readIt(eventID, ep); }, "Calling InputSource::readIt" );
      result = readIt(eventID, ep, streamContext);

      if (result) {
        if (remainingEvents_ > 0)
          --remainingEvents_;
        ++readCount_;
        issueReports(ep.id(), ep.streamID());
      }
    }
    return result;
  }

readEvent_()

virtual void edm::InputSource::readEvent_ ( EventPrincipal &  eventPrincipal )

privatepure virtual

Implemented in DQMRootSource, edm::RepeatingCachedRootSource, edmtest::SourceWithWaits, edm::DelayedReaderThrowingSource, edm::PoolSource, LH5Source, LHESource, edmtest::PutOrMergeTestSource, edm::RawInputSource, edm::ProducerSourceBase, dqmservices::DQMProtobufReader, edm::ThrowingSource, edm::TestSource, edm::OneLumiPoolSource, and edm::EmptySource.

Referenced by readEvent().

readFile()

std::shared_ptr< FileBlock > InputSource::readFile

(

)

Read next file.

Definition at line 223 of file InputSource.cc.

References cms::cuda::assert(), IsFile, limitReached(), readFile_(), and state_.

                                                 {
    assert(state_ == ItemType::IsFile);
    assert(!limitReached());
    return callWithTryCatchAndPrint<std::shared_ptr<FileBlock> >([this]() { return readFile_(); },
                                                                 "Calling InputSource::readFile_");
  }

readFile_()

std::shared_ptr< FileBlock > InputSource::readFile_ ( )

privatevirtual

Reimplemented in DQMRootSource, edm::PoolSource, edm::RawInputSource, edmtest::PutOrMergeTestSource, and edm::ThrowingSource.

Definition at line 241 of file InputSource.cc.

Referenced by readFile().

{ return std::make_shared<FileBlock>(); }

readIt()

bool InputSource::readIt ( EventID const &  id, EventPrincipal &  eventPrincipal, StreamContext &  streamContext  )

privatevirtual

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

Definition at line 373 of file InputSource.cc.

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

Referenced by readEvent().

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

readLuminosityBlock()

void InputSource::readLuminosityBlock	(	LuminosityBlockPrincipal &	lumiPrincipal,
		HistoryAppender &	historyAppender
	)

Read next luminosity block (new lumi)

Definition at line 254 of file InputSource.cc.

References edm::LuminosityBlockPrincipal::index(), readLuminosityBlock_(), and remainingLumis_.

                                                                                                 {
    LumiSourceSentry sentry(*this, lumiPrincipal.index());
    callWithTryCatchAndPrint<void>([this, &lumiPrincipal]() { readLuminosityBlock_(lumiPrincipal); },
                                   "Calling InputSource::readLuminosityBlock_");
    if (remainingLumis_ > 0) {
      --remainingLumis_;
    }
  }

readLuminosityBlock_()

void InputSource::readLuminosityBlock_ ( LuminosityBlockPrincipal &  lumiPrincipal )

privatevirtual

Reimplemented in DQMRootSource, edm::RepeatingCachedRootSource, edm::PoolSource, LH5Source, LHESource, and dqmservices::DQMProtobufReader.

Definition at line 297 of file InputSource.cc.

References edm::LuminosityBlockPrincipal::aux(), edm::LuminosityBlockPrincipal::fillLuminosityBlockPrincipal(), edm::ProcessHistoryRegistry::getMapped(), edm::LuminosityBlockAuxiliary::processHistoryID(), and processHistoryRegistry().

Referenced by readAndMergeLumi(), and readLuminosityBlock().

                                                                                {
    auto history = processHistoryRegistry().getMapped(lumiPrincipal.aux().processHistoryID());
    lumiPrincipal.fillLuminosityBlockPrincipal(history);
  }

readLuminosityBlockAuxiliary()

std::shared_ptr< LuminosityBlockAuxiliary > InputSource::readLuminosityBlockAuxiliary

(

)

Read next luminosity block Auxilary.

Definition at line 198 of file InputSource.cc.

References readLuminosityBlockAuxiliary_().

Referenced by nextItemType().

                                                                                    {
    return callWithTryCatchAndPrint<std::shared_ptr<LuminosityBlockAuxiliary> >(
        [this]() { return readLuminosityBlockAuxiliary_(); }, "Calling InputSource::readLuminosityBlockAuxiliary_");
  }

readLuminosityBlockAuxiliary_()

virtual std::shared_ptr<LuminosityBlockAuxiliary> edm::InputSource::readLuminosityBlockAuxiliary_ ( )

privatepure virtual

Implemented in DQMRootSource, edm::RepeatingCachedRootSource, edm::IDGeneratorSourceBase< InputSource >, edm::IDGeneratorSourceBase< PuttableSourceBase >, edmtest::SourceWithWaits, edm::PoolSource, LH5Source, LHESource, edmtest::PutOrMergeTestSource, edm::RawInputSource, dqmservices::DQMProtobufReader, edm::ThrowingSource, edm::TestSource, and edm::OneLumiPoolSource.

Referenced by readLuminosityBlockAuxiliary().

readProcessBlock()

void InputSource::readProcessBlock

(

ProcessBlockPrincipal &

processBlockPrincipal

)

Read next process block.

Definition at line 278 of file InputSource.cc.

References edm::ProcessBlockPrincipal::processName(), and readProcessBlock_().

                                                                                 {
    ProcessBlockSourceSentry sentry(*this, processBlockPrincipal.processName());
    callWithTryCatchAndPrint<void>([this, &processBlockPrincipal]() { readProcessBlock_(processBlockPrincipal); },
                                   "Calling InputSource::readProcessBlock_");
  }

readProcessBlock_()

void InputSource::readProcessBlock_ ( ProcessBlockPrincipal &  )

privatevirtual

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

Definition at line 288 of file InputSource.cc.

Referenced by readProcessBlock().

{}

readRun()

void InputSource::readRun	(	RunPrincipal &	runPrincipal,
		HistoryAppender &	historyAppender
	)

Read next run (new run)

Definition at line 243 of file InputSource.cc.

References edm::RunPrincipal::index(), and readRun_().

                                                                        {
    RunSourceSentry sentry(*this, runPrincipal.index());
    callWithTryCatchAndPrint<void>([this, &runPrincipal]() { readRun_(runPrincipal); },
                                   "Calling InputSource::readRun_");
  }

readRun_()

void InputSource::readRun_ ( RunPrincipal &  runPrincipal )

privatevirtual

Reimplemented in DQMRootSource, edm::RepeatingCachedRootSource, edm::PoolSource, LH5Source, LHESource, edmtest::PutOrMergeTestSource, and dqmservices::DQMProtobufReader.

Definition at line 290 of file InputSource.cc.

References edm::RunPrincipal::fillRunPrincipal(), and processHistoryRegistry().

Referenced by readAndMergeRun(), and readRun().

                                                       {
    // 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())
    runPrincipal.fillRunPrincipal(processHistoryRegistry());
  }

readRunAuxiliary()

std::shared_ptr< RunAuxiliary > InputSource::readRunAuxiliary

(

)

Read next run Auxiliary.

Definition at line 203 of file InputSource.cc.

References readRunAuxiliary_().

Referenced by nextItemType().

                                                            {
    return callWithTryCatchAndPrint<std::shared_ptr<RunAuxiliary> >([this]() { return readRunAuxiliary_(); },
                                                                    "Calling InputSource::readRunAuxiliary_");
  }

readRunAuxiliary_()

virtual std::shared_ptr<RunAuxiliary> edm::InputSource::readRunAuxiliary_ ( )

privatepure virtual

Implemented in DQMRootSource, edm::RepeatingCachedRootSource, edm::IDGeneratorSourceBase< InputSource >, edm::IDGeneratorSourceBase< PuttableSourceBase >, edmtest::SourceWithWaits, edm::PoolSource, LH5Source, LHESource, edm::RawInputSource, edmtest::PutOrMergeTestSource, dqmservices::DQMProtobufReader, edm::ThrowingSource, and edm::TestSource.

Referenced by readRunAuxiliary().

reducedProcessHistoryID()

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 453 of file InputSource.cc.

References cms::cuda::assert(), processHistoryRegistry_, and runAuxiliary().

                                                                     {
    assert(runAuxiliary());
    return processHistoryRegistry_->reducedProcessHistoryID(runAuxiliary()->processHistoryID());
  }

registerProducts()

void InputSource::registerProducts ( )

virtual

Register any produced products.

Reimplemented in edm::PuttableSourceBase, and edmtest::PutOrMergeTestSource.

Definition at line 220 of file InputSource.cc.

{}

remainingEvents()

int edm::InputSource::remainingEvents ( ) const

inline

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

Definition at line 209 of file InputSource.h.

References remainingEvents_.

Referenced by edm::RepeatingCachedRootSource::makeRootFile(), and edm::RootPrimaryFileSequence::remainingEvents().

{ return remainingEvents_; }

remainingLuminosityBlocks()

int edm::InputSource::remainingLuminosityBlocks ( ) const

inline

Accessor for remaining number of lumis to be read. -1 is used for unlimited.

Definition at line 217 of file InputSource.h.

References remainingLumis_.

Referenced by edm::RepeatingCachedRootSource::makeRootFile(), and edm::RootPrimaryFileSequence::remainingLuminosityBlocks().

{ return remainingLumis_; }

repeat()

void edm::InputSource::repeat ( )

inline

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

Definition at line 192 of file InputSource.h.

References maxEvents_, maxLumis_, remainingEvents_, and remainingLumis_.

                  {
      remainingEvents_ = maxEvents_;
      remainingLumis_ = maxLumis_;
    }

reset()

void edm::InputSource::reset ( void  ) const

inlineprotected

Definition at line 378 of file InputSource.h.

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

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

                       {
      resetLuminosityBlockAuxiliary();
      resetRunAuxiliary();
      state_ = ItemTypeInfo();
    }

resetEventCached()

void edm::InputSource::resetEventCached ( )

inlineprotected

Definition at line 392 of file InputSource.h.

References eventCached_.

Referenced by edm::RawInputSource::getNextItemType(), edm::RawInputSource::readEvent_(), LH5Source::readEvent_(), LHESource::readEvent_(), and rewind().

{ eventCached_ = false; }

resetLuminosityBlockAuxiliary()

void edm::InputSource::resetLuminosityBlockAuxiliary ( bool  isNewLumi = true ) const

inlineprotected

Definition at line 374 of file InputSource.h.

References lumiAuxiliary_, and newLumi_.

Referenced by FedRawDataInputSource::checkNext(), DAQSource::checkNext(), edm::StreamerInputSource::deserializeEvent(), edm::RawInputSource::getNextItemType(), FedRawDataInputSource::maybeOpenNewLumiSection(), DAQSource::maybeOpenNewLumiSection(), reset(), and edm::StreamerInputSource::resetAfterEndRun().

                                                                    {
      lumiAuxiliary_.reset();
      newLumi_ = isNewLumi;
    }

resetNewLumi()

void edm::InputSource::resetNewLumi ( )

inlineprotected

Definition at line 388 of file InputSource.h.

References newLumi_.

Referenced by edm::ThrowingSource::readLuminosityBlockAuxiliary_(), edm::RawInputSource::readLuminosityBlockAuxiliary_(), LH5Source::readLuminosityBlockAuxiliary_(), and LHESource::readLuminosityBlockAuxiliary_().

{ newLumi_ = false; }

resetNewRun()

void edm::InputSource::resetNewRun ( )

inlineprotected

Definition at line 385 of file InputSource.h.

References newRun_.

Referenced by edm::ThrowingSource::readRunAuxiliary_(), edm::RawInputSource::readRunAuxiliary_(), LH5Source::readRunAuxiliary_(), and LHESource::readRunAuxiliary_().

{ newRun_ = false; }

resetRunAuxiliary()

void edm::InputSource::resetRunAuxiliary ( bool  isNewRun = true ) const

inlineprotected

Definition at line 370 of file InputSource.h.

References newLumi_, newRun_, and runAuxiliary_.

Referenced by edm::RawInputSource::getNextItemType(), LHESource::nextEvent(), LH5Source::nextEvent(), reset(), and edm::StreamerInputSource::resetAfterEndRun().

                                                       {
      runAuxiliary_.reset();
      newRun_ = newLumi_ = isNewRun;
    }

resourceSharedWithDelayedReader()

std::pair< SharedResourcesAcquirer *, std::recursive_mutex * > InputSource::resourceSharedWithDelayedReader

(

)

Returns nullptr if no resource shared between the Source and a DelayedReader.

Definition at line 212 of file InputSource.cc.

References resourceSharedWithDelayedReader_().

                                                                                                      {
    return resourceSharedWithDelayedReader_();
  }

resourceSharedWithDelayedReader_()

std::pair< SharedResourcesAcquirer *, std::recursive_mutex * > InputSource::resourceSharedWithDelayedReader_ ( )

privatevirtual

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

Definition at line 216 of file InputSource.cc.

Referenced by resourceSharedWithDelayedReader().

                                                                                                       {
    return std::pair<SharedResourcesAcquirer*, std::recursive_mutex*>(nullptr, nullptr);
  }

reverseState()

ProcessingController::ReverseState InputSource::reverseState

(

)

const

Definition at line 434 of file InputSource.cc.

References reverseState_().

                                                                   {
    return callWithTryCatchAndPrint<ProcessingController::ReverseState>([this]() { return reverseState_(); },
                                                                        "Calling InputSource::reverseState__");
  }

reverseState_()

ProcessingController::ReverseState InputSource::reverseState_ ( ) const

privatevirtual

Reimplemented in edm::PoolSource.

Definition at line 449 of file InputSource.cc.

References edm::ProcessingController::kUnknownReverse.

Referenced by reverseState().

                                                                    {
    return ProcessingController::kUnknownReverse;
  }

rewind()

void InputSource::rewind

(

)

Begin again at the first event.

Definition at line 348 of file InputSource.cc.

References maxEvents_, remainingEvents_, resetEventCached(), rewind_(), setNewLumi(), setNewRun(), and state_.

                           {
    state_ = ItemTypeInfo();
    remainingEvents_ = maxEvents_;
    setNewRun();
    setNewLumi();
    resetEventCached();
    callWithTryCatchAndPrint<void>([this]() { rewind_(); }, "Calling InputSource::rewind_");
  }

rewind_()

void InputSource::rewind_ ( )

privatevirtual

Reimplemented in edm::IDGeneratorSourceBase< InputSource >, edm::IDGeneratorSourceBase< PuttableSourceBase >, edm::PoolSource, DAQSource, FedRawDataInputSource, and edm::RawInputSource.

Definition at line 404 of file InputSource.cc.

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

Referenced by rewind().

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

run()

RunNumber_t InputSource::run

(

)

const

Accessor for current run number.

Definition at line 458 of file InputSource.cc.

References cms::cuda::assert(), and runAuxiliary().

Referenced by edm::RepeatingCachedRootSource::beginJob(), DQMRootSource::beginRun(), Types.EventID::cppID(), Types.LuminosityBlockID::cppID(), edm::StreamerInputSource::deserializeEvent(), edm::PuttableSourceBase::doBeginRun(), edm::PoolSource::getNextItemType(), DQMRootSource::keepIt(), FedRawDataInputSource::maybeOpenNewLumiSection(), DAQSource::maybeOpenNewLumiSection(), DQMRootSource::readFile_(), and edm::PoolSource::readIt().

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

runAuxiliary()

std::shared_ptr<RunAuxiliary> edm::InputSource::runAuxiliary ( ) const

inline

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

Definition at line 261 of file InputSource.h.

References runAuxiliary_.

Referenced by DAQSource::DAQSource(), edm::StreamerInputSource::deserializeEvent(), FedRawDataInputSource::FedRawDataInputSource(), edm::RawInputSource::getNextItemType(), FedRawDataInputSource::maybeOpenNewLumiSection(), DAQSource::maybeOpenNewLumiSection(), edmtest::PutOrMergeTestSource::readRun_(), LH5Source::readRun_(), LHESource::readRun_(), edm::RawInputSource::readRunAuxiliary_(), reducedProcessHistoryID(), and run().

{ return runAuxiliary_; }

setEventCached()

void edm::InputSource::setEventCached ( )

inlineprotected

Called by the framework to merge or ached() const {return eventCached_;}.

Definition at line 391 of file InputSource.h.

References eventCached_.

Referenced by FedRawDataInputSource::checkNext(), DAQSource::checkNext(), and edm::StreamerInputSource::deserializeEvent().

{ eventCached_ = true; }

setLumi()

void InputSource::setLumi ( LuminosityBlockNumber_t  lb )

privatevirtual

Definition at line 385 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";
  }

setLuminosityBlockAuxiliary()

void edm::InputSource::setLuminosityBlockAuxiliary ( LuminosityBlockAuxiliary *  lbp )

inlineprotected

Definition at line 366 of file InputSource.h.

References lumiAuxiliary_, and newLumi_.

Referenced by edm::StreamerInputSource::deserializeEvent(), FedRawDataInputSource::maybeOpenNewLumiSection(), and DAQSource::maybeOpenNewLumiSection().

                                                                    {
      lumiAuxiliary_.reset(lbp);
      newLumi_ = true;
    }

setLuminosityBlockNumber_t()

void edm::InputSource::setLuminosityBlockNumber_t ( LuminosityBlockNumber_t  lb )

inline

Set the luminosity block ID.

Definition at line 156 of file InputSource.h.

References setLumi().

{ setLumi(lb); }

setNewLumi()

void edm::InputSource::setNewLumi ( )

inlineprotected

Definition at line 387 of file InputSource.h.

References newLumi_.

Referenced by edm::RawInputSource::getNextItemType(), and rewind().

{ newLumi_ = true; }

setNewRun()

void edm::InputSource::setNewRun ( )

inlineprotected

Definition at line 384 of file InputSource.h.

References newRun_.

Referenced by DAQSource::DAQSource(), FedRawDataInputSource::FedRawDataInputSource(), edm::RawInputSource::getNextItemType(), and rewind().

{ newRun_ = true; }

setRun()

void InputSource::setRun ( RunNumber_t  r )

privatevirtual

Reimplemented in edm::StreamerInputSource.

Definition at line 379 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";
  }

setRunAuxiliary()

void edm::InputSource::setRunAuxiliary ( RunAuxiliary *  rp )

inlineprotected

Definition at line 362 of file InputSource.h.

References newLumi_, newRun_, and runAuxiliary_.

Referenced by DAQSource::DAQSource(), edm::StreamerInputSource::deserializeEvent(), and FedRawDataInputSource::FedRawDataInputSource().

                                           {
      runAuxiliary_.reset(rp);
      newRun_ = newLumi_ = true;
    }

setRunNumber()

void edm::InputSource::setRunNumber ( RunNumber_t  r )

inline

Set the run number.

Definition at line 153 of file InputSource.h.

References setRun().

{ setRun(r); }

setTimestamp()

void edm::InputSource::setTimestamp ( Timestamp const &  theTime )

inlineprotected

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

Definition at line 357 of file InputSource.h.

References time_.

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

{ time_ = theTime; }

skip()

void InputSource::skip ( int  offset )

protectedvirtual

Reimplemented in edm::RepeatingCachedRootSource, edm::IDGeneratorSourceBase< InputSource >, edm::IDGeneratorSourceBase< PuttableSourceBase >, edm::PoolSource, edm::StreamerFileReader, and dqmservices::DQMStreamerReader.

Definition at line 391 of file InputSource.cc.

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

Referenced by skipEvents().

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

skipEvents()

void InputSource::skipEvents

(

int

offset

)

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

Definition at line 339 of file InputSource.cc.

References hltrates_dqm_sourceclient-live_cfg::offset, and skip().

Referenced by nextItemType_().

                                         {
    callWithTryCatchAndPrint<void>([this, &offset]() { skip(offset); }, "Calling InputSource::skip");
  }

state()

ItemTypeInfo edm::InputSource::state ( ) const

inlineprotected

Definition at line 361 of file InputSource.h.

References state_.

Referenced by edm::RawInputSource::getNextItemType(), edm::PoolSource::getNextItemType(), FedRawDataInputSource::setMonState(), DAQSource::setMonState(), FedRawDataInputSource::setMonStateSup(), and DAQSource::setMonStateSup().

{ return state_; }

switchTo()

void edm::InputSource::switchTo ( std::shared_ptr< ProductRegistry >  iOther )

inline

switch to a different ProductRegistry.

Definition at line 201 of file InputSource.h.

References productRegistry_.

{ productRegistry_ = iOther; }

thinnedAssociationsHelper() [1/2]

std::shared_ptr<ThinnedAssociationsHelper const> edm::InputSource::thinnedAssociationsHelper ( ) const

inline

Accessors for thinnedAssociationsHelper.

Definition at line 184 of file InputSource.h.

References edm::get_underlying_safe(), and thinnedAssociationsHelper_.

Referenced by edm::StreamerInputSource::deserializeAndMergeWithRegistry(), edm::RootSecondaryFileSequence::makeRootFile(), edm::RootPrimaryFileSequence::makeRootFile(), and edm::RepeatingCachedRootSource::makeRootFile().

                                                                                     {
      return get_underlying_safe(thinnedAssociationsHelper_);
    }

thinnedAssociationsHelper() [2/2]

std::shared_ptr<ThinnedAssociationsHelper>& edm::InputSource::thinnedAssociationsHelper ( )

inline

Definition at line 187 of file InputSource.h.

References edm::get_underlying_safe(), and thinnedAssociationsHelper_.

                                                                          {
      return get_underlying_safe(thinnedAssociationsHelper_);
    }

timestamp()

Timestamp const& edm::InputSource::timestamp ( ) const

inline

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

Definition at line 241 of file InputSource.h.

References time_.

{ return time_; }

Member Data Documentation

actReg_

std::shared_ptr<ActivityRegistry> edm::InputSource::actReg_

private

Definition at line 443 of file InputSource.h.

Referenced by actReg().

branchIDListHelper_

edm::propagate_const<std::shared_ptr<BranchIDListHelper> > edm::InputSource::branchIDListHelper_

private

Definition at line 455 of file InputSource.h.

Referenced by branchIDListHelper().

eventCached_

bool edm::InputSource::eventCached_

private

Definition at line 462 of file InputSource.h.

Referenced by eventCached(), resetEventCached(), and setEventCached().

lumiAuxiliary_

std::shared_ptr<LuminosityBlockAuxiliary> edm::InputSource::lumiAuxiliary_

mutableprivate

Definition at line 465 of file InputSource.h.

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

maxEvents_

int edm::InputSource::maxEvents_

private

Definition at line 444 of file InputSource.h.

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

maxLumis_

int edm::InputSource::maxLumis_

private

Definition at line 446 of file InputSource.h.

Referenced by maxLuminosityBlocks(), and repeat().

maxSecondsUntilRampdown_

int edm::InputSource::maxSecondsUntilRampdown_

private

Definition at line 449 of file InputSource.h.

Referenced by InputSource(), and lumiLimitReached().

moduleDescription_

ModuleDescription const edm::InputSource::moduleDescription_

private

Definition at line 452 of file InputSource.h.

Referenced by moduleDescription().

newLumi_

bool edm::InputSource::newLumi_

mutableprivate

Definition at line 461 of file InputSource.h.

Referenced by newLumi(), resetLuminosityBlockAuxiliary(), resetNewLumi(), resetRunAuxiliary(), setLuminosityBlockAuxiliary(), setNewLumi(), and setRunAuxiliary().

newRun_

bool edm::InputSource::newRun_

mutableprivate

Definition at line 460 of file InputSource.h.

Referenced by newRun(), resetNewRun(), resetRunAuxiliary(), setNewRun(), and setRunAuxiliary().

numberOfEventsBeforeBigSkip_

unsigned int edm::InputSource::numberOfEventsBeforeBigSkip_

private

Definition at line 468 of file InputSource.h.

postEventReadFromSourceSignal_

signalslot::Signal<void(StreamContext const&, ModuleCallingContext const&)> edm::InputSource::postEventReadFromSourceSignal_

Definition at line 351 of file InputSource.h.

preEventReadFromSourceSignal_

signalslot::Signal<void(StreamContext const&, ModuleCallingContext const&)> edm::InputSource::preEventReadFromSourceSignal_

Definition at line 350 of file InputSource.h.

processBlockHelper_

edm::propagate_const<std::shared_ptr<ProcessBlockHelper> > edm::InputSource::processBlockHelper_

private

Definition at line 456 of file InputSource.h.

Referenced by processBlockHelper().

processGUID_

std::string edm::InputSource::processGUID_

private

Definition at line 458 of file InputSource.h.

Referenced by processGUID().

processHistoryRegistry_

edm::propagate_const<std::unique_ptr<ProcessHistoryRegistry> > edm::InputSource::processHistoryRegistry_

private

Definition at line 454 of file InputSource.h.

Referenced by processHistoryRegistry(), processHistoryRegistryForUpdate(), and reducedProcessHistoryID().

processingMode_

ProcessingMode edm::InputSource::processingMode_

private

Definition at line 451 of file InputSource.h.

Referenced by InputSource(), and processingMode().

processingStart_

std::chrono::time_point<std::chrono::steady_clock> edm::InputSource::processingStart_

private

Definition at line 450 of file InputSource.h.

Referenced by InputSource(), and lumiLimitReached().

productRegistry_

edm::propagate_const<std::shared_ptr<ProductRegistry> > edm::InputSource::productRegistry_

private

Definition at line 453 of file InputSource.h.

Referenced by productRegistry(), productRegistryUpdate(), and switchTo().

readCount_

int edm::InputSource::readCount_

private

Definition at line 448 of file InputSource.h.

Referenced by issueReports(), and readEvent().

remainingEvents_

int edm::InputSource::remainingEvents_

private

Definition at line 445 of file InputSource.h.

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

remainingLumis_

int edm::InputSource::remainingLumis_

private

Definition at line 447 of file InputSource.h.

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

runAuxiliary_

std::shared_ptr<RunAuxiliary> edm::InputSource::runAuxiliary_

mutableprivate

Definition at line 464 of file InputSource.h.

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

state_

ItemTypeInfo edm::InputSource::state_

mutableprivate

Definition at line 463 of file InputSource.h.

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

statusFileName_

std::string edm::InputSource::statusFileName_

private

Definition at line 466 of file InputSource.h.

Referenced by InputSource(), and issueReports().

thinnedAssociationsHelper_

edm::propagate_const<std::shared_ptr<ThinnedAssociationsHelper> > edm::InputSource::thinnedAssociationsHelper_

private

Definition at line 457 of file InputSource.h.

Referenced by thinnedAssociationsHelper().

time_

Timestamp edm::InputSource::time_

private

Definition at line 459 of file InputSource.h.

Referenced by setTimestamp(), and timestamp().