edm::EDLooperBase Class Reference

#include <EDLooperBase.h>

Inheritance diagram for edm::EDLooperBase:

Public Types
enum	Status { kContinue, kStop }

Public Member Functions
virtual void	attachTo (ActivityRegistry &)
	Override this method if you need to monitor the state of the processing. More...
virtual void	beginOfJob ()
virtual void	beginOfJob (EventSetup const &)
void	beginOfJob (EventSetupImpl const &)
void	copyInfo (ScheduleInfo const &)
void	doBeginLuminosityBlock (LuminosityBlockPrincipal &, EventSetupImpl const &, ProcessContext *)
void	doBeginRun (RunPrincipal &, EventSetupImpl const &, ProcessContext *)
Status	doDuringLoop (EventPrincipal &eventPrincipal, EventSetupImpl const &es, ProcessingController &, StreamContext *)
void	doEndLuminosityBlock (LuminosityBlockPrincipal &, EventSetupImpl const &, ProcessContext *)
Status	doEndOfLoop (EventSetupImpl const &es)
void	doEndRun (RunPrincipal &, EventSetupImpl const &, ProcessContext *)
void	doStartingNewLoop ()
	EDLooperBase ()
	EDLooperBase (EDLooperBase const &)=delete
virtual void	endOfJob ()
virtual std::set< eventsetup::EventSetupRecordKey >	modifyingRecords () const
EDLooperBase &	operator= (EDLooperBase const &)=delete
void	prepareForNextLoop (eventsetup::EventSetupProvider *esp)
void	setActionTable (ExceptionToActionTable const *actionTable)
void	setModuleChanger (ModuleChanger *)
virtual	~EDLooperBase () noexcept(false)

Protected Member Functions
ModuleChanger *	moduleChanger ()
	This only returns a non-zero value during the call to endOfLoop. More...
ScheduleInfo const *	scheduleInfo () const
	This returns a non-zero value after the constructor has been called. More...

Private Member Functions
virtual void	beginLuminosityBlock (LuminosityBlock const &, EventSetup const &)
	Called after all event modules have processed the begin of a LuminosityBlock. More...
virtual void	beginRun (Run const &, EventSetup const &)
	Called after all event modules have processed the begin of a Run. More...
virtual Status	duringLoop (Event const &, EventSetup const &, ProcessingController &)=0
virtual void	endLuminosityBlock (LuminosityBlock const &, EventSetup const &)
	Called after all event modules have processed the end of a LuminosityBlock. More...
virtual Status	endOfLoop (EventSetup const &, unsigned int iCounter)=0
virtual void	endRun (Run const &, EventSetup const &)
	Called after all event modules have processed the end of a Run. More...
virtual void	startingNewLoop (unsigned int)=0

Private Attributes
ExceptionToActionTable const *	act_table_
unsigned int	iCounter_
ModuleCallingContext	moduleCallingContext_
edm::propagate_const< ModuleChanger * >	moduleChanger_
ModuleDescription	moduleDescription_
edm::propagate_const< std::unique_ptr< ScheduleInfo > >	scheduleInfo_

Detailed Description

Definition at line 77 of file EDLooperBase.h.

Member Enumeration Documentation

Status

enum edm::EDLooperBase::Status

Enumerator
kContinue
kStop

Definition at line 79 of file EDLooperBase.h.

{ kContinue, kStop };

Constructor & Destructor Documentation

EDLooperBase() [1/2]

EDLooperBase::EDLooperBase

(

)

Definition at line 32 of file EDLooperBase.cc.

      : iCounter_(0),
        act_table_(nullptr),
        moduleChanger_(nullptr),
        moduleDescription_("Looper", "looper"),
        moduleCallingContext_(&moduleDescription_) {}

~EDLooperBase()

EDLooperBase::~EDLooperBase ( )

virtualnoexcept

Definition at line 38 of file EDLooperBase.cc.

{}

EDLooperBase() [2/2]

edm::EDLooperBase::EDLooperBase ( EDLooperBase const &  )

delete

Member Function Documentation

attachTo()

void EDLooperBase::attachTo ( ActivityRegistry &  )

virtual

Override this method if you need to monitor the state of the processing.

Reimplemented in FWFFLooper.

Definition at line 155 of file EDLooperBase.cc.

{}

beginLuminosityBlock()

void EDLooperBase::beginLuminosityBlock ( LuminosityBlock const &  , EventSetup const &    )

privatevirtual

Called after all event modules have processed the begin of a LuminosityBlock.

Reimplemented in AlignmentProducer.

Definition at line 152 of file EDLooperBase.cc.

{}

Referenced by doBeginLuminosityBlock().

beginOfJob() [1/3]

void EDLooperBase::beginOfJob ( )

virtual

Reimplemented in ZeeCalibration, Pi0FixedMassWindowCalibration, __class__< T >, EcalEleCalibLooper, and InvRingCalib.

Definition at line 88 of file EDLooperBase.cc.

{}

Referenced by beginOfJob().

beginOfJob() [2/3]

void EDLooperBase::beginOfJob ( EventSetup const &  )

virtual

Reimplemented in AlignmentProducer.

Definition at line 87 of file EDLooperBase.cc.

{ beginOfJob(); }

References beginOfJob().

beginOfJob() [3/3]

void EDLooperBase::beginOfJob

(

EventSetupImpl const &

iImpl

)

Definition at line 84 of file EDLooperBase.cc.

                                                              {
    beginOfJob(EventSetup{iImpl, static_cast<unsigned int>(Transition::BeginRun), nullptr, false});
  }

References beginOfJob(), and edm::BeginRun.

beginRun()

void EDLooperBase::beginRun ( Run const &  , EventSetup const &    )

privatevirtual

Called after all event modules have processed the begin of a Run.

Reimplemented in FWFFLooper, and AlignmentProducer.

Definition at line 150 of file EDLooperBase.cc.

{}

Referenced by doBeginRun().

copyInfo()

void EDLooperBase::copyInfo

(

ScheduleInfo const &

iInfo

)

Definition at line 161 of file EDLooperBase.cc.

{ scheduleInfo_ = std::make_unique<ScheduleInfo>(iInfo); }

References scheduleInfo_.

doBeginLuminosityBlock()

void EDLooperBase::doBeginLuminosityBlock	(	LuminosityBlockPrincipal &	iLB,
		EventSetupImpl const &	iES,
		ProcessContext *	processContext
	)

Definition at line 119 of file EDLooperBase.cc.

                                                                            {
    GlobalContext globalContext(GlobalContext::Transition::kBeginLuminosityBlock,
                                iLB.id(),
                                iLB.runPrincipal().index(),
                                iLB.index(),
                                iLB.beginTime(),
                                processContext);
    ParentContext parentContext(&globalContext);
    ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
    LuminosityBlock luminosityBlock(iLB, moduleDescription_, &moduleCallingContext_, false);
    const EventSetup es{iES, static_cast<unsigned int>(Transition::BeginLuminosityBlock), nullptr, false};
    beginLuminosityBlock(luminosityBlock, es);
  }

References edm::BeginLuminosityBlock, beginLuminosityBlock(), edm::LuminosityBlockPrincipal::beginTime(), edm::LuminosityBlockPrincipal::id(), edm::LuminosityBlockPrincipal::index(), edm::RunPrincipal::index(), edm::GlobalContext::kBeginLuminosityBlock, moduleCallingContext_, moduleDescription_, and edm::LuminosityBlockPrincipal::runPrincipal().

doBeginRun()

void EDLooperBase::doBeginRun	(	RunPrincipal &	iRP,
		EventSetupImpl const &	iES,
		ProcessContext *	processContext
	)

Definition at line 92 of file EDLooperBase.cc.

                                                                                                            {
    GlobalContext globalContext(GlobalContext::Transition::kBeginRun,
                                LuminosityBlockID(iRP.run(), 0),
                                iRP.index(),
                                LuminosityBlockIndex::invalidLuminosityBlockIndex(),
                                iRP.beginTime(),
                                processContext);
    ParentContext parentContext(&globalContext);
    ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
    Run run(iRP, moduleDescription_, &moduleCallingContext_, false);
    const EventSetup es{iES, static_cast<unsigned int>(Transition::BeginRun), nullptr, false};
    beginRun(run, es);
  }

References edm::BeginRun, beginRun(), edm::RunPrincipal::beginTime(), edm::RunPrincipal::index(), edm::LuminosityBlockIndex::invalidLuminosityBlockIndex(), edm::GlobalContext::kBeginRun, moduleCallingContext_, moduleDescription_, writedatasetfile::run, and edm::RunPrincipal::run().

doDuringLoop()

EDLooperBase::Status EDLooperBase::doDuringLoop	(	edm::EventPrincipal &	eventPrincipal,
		EventSetupImpl const &	es,
		edm::ProcessingController &	ioController,
		StreamContext *	streamContext
	)

Definition at line 42 of file EDLooperBase.cc.

                                                                                {
    streamContext->setTransition(StreamContext::Transition::kEvent);
    streamContext->setEventID(eventPrincipal.id());
    streamContext->setRunIndex(eventPrincipal.luminosityBlockPrincipal().runPrincipal().index());
    streamContext->setLuminosityBlockIndex(eventPrincipal.luminosityBlockPrincipal().index());
    streamContext->setTimestamp(eventPrincipal.time());
    ParentContext parentContext(streamContext);
    ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
    Event event(eventPrincipal, moduleDescription_, &moduleCallingContext_);
 
    Status status = kContinue;
    try {
      const EventSetup es{esi, static_cast<unsigned int>(Transition::Event), nullptr, false};
      status = duringLoop(event, es, ioController);
    } catch (cms::Exception& e) {
      e.addContext("Calling the 'duringLoop' method of a looper");
      exception_actions::ActionCodes action = (act_table_->find(e.category()));
      if (action != exception_actions::Rethrow) {
        edm::printCmsExceptionWarning("SkipEvent", e);
      } else {
        throw;
      }
    }
    return status;
  }

References act_table_, writedatasetfile::action, duringLoop(), MillePedeFileConverter_cfg::e, edm::Event, edmPickEvents::event, edm::ExceptionToActionTable::find(), edm::EventPrincipal::id(), edm::LuminosityBlockPrincipal::index(), edm::RunPrincipal::index(), kContinue, edm::StreamContext::kEvent, edm::EventPrincipal::luminosityBlockPrincipal(), moduleCallingContext_, moduleDescription_, edm::printCmsExceptionWarning(), edm::exception_actions::Rethrow, edm::LuminosityBlockPrincipal::runPrincipal(), edm::StreamContext::setEventID(), edm::StreamContext::setLuminosityBlockIndex(), edm::StreamContext::setRunIndex(), edm::StreamContext::setTimestamp(), edm::StreamContext::setTransition(), mps_update::status, and edm::EventPrincipal::time().

doEndLuminosityBlock()

void EDLooperBase::doEndLuminosityBlock	(	LuminosityBlockPrincipal &	iLB,
		EventSetupImpl const &	iES,
		ProcessContext *	processContext
	)

Definition at line 134 of file EDLooperBase.cc.

                                                                          {
    GlobalContext globalContext(GlobalContext::Transition::kEndLuminosityBlock,
                                iLB.id(),
                                iLB.runPrincipal().index(),
                                iLB.index(),
                                iLB.beginTime(),
                                processContext);
    ParentContext parentContext(&globalContext);
    ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
    LuminosityBlock luminosityBlock(iLB, moduleDescription_, &moduleCallingContext_, true);
    const EventSetup es{iES, static_cast<unsigned int>(Transition::EndLuminosityBlock), nullptr, false};
    endLuminosityBlock(luminosityBlock, es);
  }

References edm::LuminosityBlockPrincipal::beginTime(), edm::EndLuminosityBlock, endLuminosityBlock(), edm::LuminosityBlockPrincipal::id(), edm::LuminosityBlockPrincipal::index(), edm::RunPrincipal::index(), edm::GlobalContext::kEndLuminosityBlock, moduleCallingContext_, moduleDescription_, and edm::LuminosityBlockPrincipal::runPrincipal().

doEndOfLoop()

EDLooperBase::Status EDLooperBase::doEndOfLoop

(

EventSetupImpl const &

es

)

Definition at line 71 of file EDLooperBase.cc.

                                                                           {
    const EventSetup es{esi, static_cast<unsigned int>(Transition::EndRun), nullptr, false};
    return endOfLoop(es, iCounter_);
  }

References endOfLoop(), edm::EndRun, and iCounter_.

doEndRun()

void EDLooperBase::doEndRun	(	RunPrincipal &	iRP,
		EventSetupImpl const &	iES,
		ProcessContext *	processContext
	)

Definition at line 106 of file EDLooperBase.cc.

                                                                                                          {
    GlobalContext globalContext(GlobalContext::Transition::kEndRun,
                                LuminosityBlockID(iRP.run(), 0),
                                iRP.index(),
                                LuminosityBlockIndex::invalidLuminosityBlockIndex(),
                                iRP.endTime(),
                                processContext);
    ParentContext parentContext(&globalContext);
    ModuleContextSentry moduleContextSentry(&moduleCallingContext_, parentContext);
    Run run(iRP, moduleDescription_, &moduleCallingContext_, true);
    const EventSetup es{iES, static_cast<unsigned int>(Transition::EndRun), nullptr, false};
    endRun(run, es);
  }

References edm::EndRun, endRun(), edm::RunPrincipal::endTime(), edm::RunPrincipal::index(), edm::LuminosityBlockIndex::invalidLuminosityBlockIndex(), edm::GlobalContext::kEndRun, moduleCallingContext_, moduleDescription_, writedatasetfile::run, and edm::RunPrincipal::run().

doStartingNewLoop()

void EDLooperBase::doStartingNewLoop

(

)

Definition at line 40 of file EDLooperBase.cc.

{ startingNewLoop(iCounter_); }

References iCounter_, and startingNewLoop().

duringLoop()

virtual Status edm::EDLooperBase::duringLoop ( Event const &  , EventSetup const &  , ProcessingController &    )

privatepure virtual

Called after all event modules have had a chance to process the Event.

Implemented in edm::NavigateEventsLooper, edm::EDLooper, and FWFFLooper.

Referenced by doDuringLoop().

endLuminosityBlock()

void EDLooperBase::endLuminosityBlock ( LuminosityBlock const &  , EventSetup const &    )

privatevirtual

Called after all event modules have processed the end of a LuminosityBlock.

Reimplemented in AlignmentProducer.

Definition at line 153 of file EDLooperBase.cc.

{}

Referenced by doEndLuminosityBlock().

endOfJob()

void EDLooperBase::endOfJob ( )

virtual

Reimplemented in MuScleFit, ZeeCalibration, Pi0FixedMassWindowCalibration, __class__< T >, EcalEleCalibLooper, InvRingCalib, and AlignmentProducer.

Definition at line 90 of file EDLooperBase.cc.

{}

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

endOfLoop()

virtual Status edm::EDLooperBase::endOfLoop ( EventSetup const &  , unsigned int  iCounter  )

privatepure virtual

Called after the system has finished one loop over the events. Thar argument is a count of how many loops have been processed before this loo. For the first time through the events the argument will be 0.

Implemented in edm::NavigateEventsLooper, edm::IterateNTimesLooper, MuScleFit, FWFFLooper, ZeeCalibration, Pi0FixedMassWindowCalibration, AlignmentProducer, EcalEleCalibLooper, and InvRingCalib.

Referenced by doEndOfLoop().

endRun()

void EDLooperBase::endRun ( Run const &  , EventSetup const &    )

privatevirtual

Called after all event modules have processed the end of a Run.

Reimplemented in AlignmentProducer.

Definition at line 151 of file EDLooperBase.cc.

{}

Referenced by doEndRun().

modifyingRecords()

std::set< eventsetup::EventSetupRecordKey > EDLooperBase::modifyingRecords ( ) const

virtual

Reimplemented in edm::ESProducerLooper.

Definition at line 157 of file EDLooperBase.cc.

                                                                             {
    return std::set<eventsetup::EventSetupRecordKey>();
  }

Referenced by prepareForNextLoop().

moduleChanger()

ModuleChanger * EDLooperBase::moduleChanger ( )

protected

This only returns a non-zero value during the call to endOfLoop.

Definition at line 164 of file EDLooperBase.cc.

{ return moduleChanger_; }

References moduleChanger_.

Referenced by FWFFLooper::endOfLoop().

operator=()

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

delete

prepareForNextLoop()

void EDLooperBase::prepareForNextLoop

(

eventsetup::EventSetupProvider *

esp

)

Definition at line 76 of file EDLooperBase.cc.

                                                                         {
    ++iCounter_;
 
    std::set<edm::eventsetup::EventSetupRecordKey> const& keys = modifyingRecords();
    for_all(keys,
            std::bind(&eventsetup::EventSetupProvider::resetRecordPlusDependentRecords, esp, std::placeholders::_1));
  }

References edm::for_all(), iCounter_, relativeConstraints::keys, modifyingRecords(), and edm::eventsetup::EventSetupProvider::resetRecordPlusDependentRecords().

scheduleInfo()

const ScheduleInfo * EDLooperBase::scheduleInfo ( ) const

protected

This returns a non-zero value after the constructor has been called.

Definition at line 165 of file EDLooperBase.cc.

{ return scheduleInfo_.get(); }

References scheduleInfo_.

Referenced by FWFFLooper::startingNewLoop().

setActionTable()

void edm::EDLooperBase::setActionTable ( ExceptionToActionTable const *  actionTable )

inline

Definition at line 106 of file EDLooperBase.h.

{ act_table_ = actionTable; }

References act_table_.

setModuleChanger()

void EDLooperBase::setModuleChanger

(

ModuleChanger *

iChanger

)

Definition at line 162 of file EDLooperBase.cc.

{ moduleChanger_ = iChanger; }

References moduleChanger_.

startingNewLoop()

virtual void edm::EDLooperBase::startingNewLoop ( unsigned int  )

privatepure virtual

Called before system starts to loop over the events. The argument is a count of how many loops have been processed. For the first time through the events the argument will be 0.

Implemented in FWFFLooper, __class__< T >, EcalEleCalibLooper, InvRingCalib, edm::IterateNTimesLooper, MuScleFit, ZeeCalibration, Pi0FixedMassWindowCalibration, AlignmentProducer, and edm::NavigateEventsLooper.

Referenced by doStartingNewLoop().

Member Data Documentation

act_table_

ExceptionToActionTable const* edm::EDLooperBase::act_table_

private

Definition at line 149 of file EDLooperBase.h.

Referenced by doDuringLoop(), and setActionTable().

iCounter_

unsigned int edm::EDLooperBase::iCounter_

private

Definition at line 148 of file EDLooperBase.h.

Referenced by doEndOfLoop(), doStartingNewLoop(), and prepareForNextLoop().

moduleCallingContext_

ModuleCallingContext edm::EDLooperBase::moduleCallingContext_

private

Definition at line 155 of file EDLooperBase.h.

Referenced by doBeginLuminosityBlock(), doBeginRun(), doDuringLoop(), doEndLuminosityBlock(), and doEndRun().

moduleChanger_

edm::propagate_const<ModuleChanger*> edm::EDLooperBase::moduleChanger_

private

Definition at line 152 of file EDLooperBase.h.

Referenced by moduleChanger(), and setModuleChanger().

moduleDescription_

ModuleDescription edm::EDLooperBase::moduleDescription_

private

Definition at line 154 of file EDLooperBase.h.

Referenced by doBeginLuminosityBlock(), doBeginRun(), doDuringLoop(), doEndLuminosityBlock(), and doEndRun().

scheduleInfo_

edm::propagate_const<std::unique_ptr<ScheduleInfo> > edm::EDLooperBase::scheduleInfo_

private

Definition at line 151 of file EDLooperBase.h.

Referenced by copyInfo(), and scheduleInfo().