#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 (EventSetup const &)

virtual void	beginOfJob ()

void	copyInfo (ScheduleInfo const &)

void	doBeginLuminosityBlock (LuminosityBlockPrincipal &, EventSetup const &, ProcessContext *)

void	doBeginRun (RunPrincipal &, EventSetup const &, ProcessContext *)

Status	doDuringLoop (EventPrincipal &eventPrincipal, EventSetup const &es, ProcessingController &, StreamContext *)

void	doEndLuminosityBlock (LuminosityBlockPrincipal &, EventSetup const &, ProcessContext *)

Status	doEndOfLoop (EventSetup const &es)

void	doEndRun (RunPrincipal &, EventSetup 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 ()

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

enum edm::EDLooperBase::Status

Enumerator
kContinue
kStop

Definition at line 79 of file EDLooperBase.h.

79 {kContinue, kStop};

edm::EDLooperBase::kContinue

Definition: EDLooperBase.h:79

edm::EDLooperBase::kStop

Definition: EDLooperBase.h:79

Constructor & Destructor Documentation

EDLooperBase::EDLooperBase ( )

Definition at line 31 of file EDLooperBase.cc.

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

EDLooperBase::~EDLooperBase ( )

virtual

Definition at line 35 of file EDLooperBase.cc.

35 { }

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

delete

Member Function Documentation

void EDLooperBase::attachTo ( ActivityRegistry & )

virtual

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

Reimplemented in FWFFLooper.

Definition at line 147 of file EDLooperBase.cc.

147 {}

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 144 of file EDLooperBase.cc.

Referenced by doBeginLuminosityBlock().

144 {}

void EDLooperBase::beginOfJob ( EventSetup const & )

virtual

Reimplemented in AlignmentProducer.

Definition at line 87 of file EDLooperBase.cc.

References beginOfJob().

87 { beginOfJob();}

edm::EDLooperBase::beginOfJob

virtual void beginOfJob()

Definition: EDLooperBase.cc:88

void EDLooperBase::beginOfJob ( )

virtual

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

Definition at line 88 of file EDLooperBase.cc.

Referenced by beginOfJob().

88 { }

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

privatevirtual

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

Reimplemented in AlignmentProducer, and FWFFLooper.

Definition at line 142 of file EDLooperBase.cc.

Referenced by doBeginRun().

142 {}

void EDLooperBase::copyInfo ( ScheduleInfo const & iInfo )

Definition at line 157 of file EDLooperBase.cc.

References scheduleInfo_.

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

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

Definition at line 117 of file EDLooperBase.cc.

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

                                                                                                                                {
     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_);
     beginLuminosityBlock(luminosityBlock,iES);
   }

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

Definition at line 92 of file EDLooperBase.cc.

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

                                                                                                         {
         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_);
         beginRun(run,iES);
   }

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

Definition at line 43 of file EDLooperBase.cc.

References act_table_, mps_fire::action, cms::Exception::addContext(), cms::Exception::category(), duringLoop(), alignCSCRings::e, event(), edm::ExceptionToActionTable::find(), edm::EventPrincipal::id(), edm::RunPrincipal::index(), edm::LuminosityBlockPrincipal::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().

                                                                                                   {
 
     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 {
       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;
   }

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

Definition at line 129 of file EDLooperBase.cc.

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

                                                                                                                              {
     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_);
     endLuminosityBlock(luminosityBlock,iES);
   }

EDLooperBase::Status EDLooperBase::doEndOfLoop ( EventSetup const & es )

Definition at line 73 of file EDLooperBase.cc.

References endOfLoop(), and iCounter_.

                                                    {
     return endOfLoop(es, iCounter_);
   }

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

Definition at line 105 of file EDLooperBase.cc.

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

                                                                                                      {
         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_);
         endRun(run,iES);
   }

void EDLooperBase::doStartingNewLoop ( )

Definition at line 38 of file EDLooperBase.cc.

References iCounter_, and startingNewLoop().

                                   {
     startingNewLoop(iCounter_);
   }

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 FWFFLooper, edm::EDLooper, and edm::NavigateEventsLooper.

Referenced by doDuringLoop().

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 145 of file EDLooperBase.cc.

Referenced by doEndLuminosityBlock().

145 {}

void EDLooperBase::endOfJob ( )

virtual

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

Definition at line 90 of file EDLooperBase.cc.

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

90 { }

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 MuScleFit, ZeeCalibration, AlignmentProducer, Pi0FixedMassWindowCalibration, FWFFLooper, EcalEleCalibLooper, InvRingCalib, edm::NavigateEventsLooper, edm::IterateNTimesLooper, and PhysicsTools::MVATrainerLooper.

Referenced by doEndOfLoop().

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 143 of file EDLooperBase.cc.

Referenced by doEndRun().

143 {}

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

virtual

Reimplemented in edm::ESProducerLooper.

Definition at line 151 of file EDLooperBase.cc.

Referenced by prepareForNextLoop().

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

ModuleChanger * EDLooperBase::moduleChanger ( )

protected

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

Definition at line 165 of file EDLooperBase.cc.

References moduleChanger_.

Referenced by FWFFLooper::endOfLoop().

                                              {
     return moduleChanger_;
   }

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

delete

void EDLooperBase::prepareForNextLoop ( eventsetup::EventSetupProvider * esp )

Definition at line 78 of file EDLooperBase.cc.

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

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

const ScheduleInfo * EDLooperBase::scheduleInfo ( ) const

protected

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

Definition at line 168 of file EDLooperBase.cc.

References scheduleInfo_.

Referenced by FWFFLooper::startingNewLoop().

                                                        {
     return scheduleInfo_.get();
   }

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

inline

Definition at line 105 of file EDLooperBase.h.

References act_table_.

105 { act_table_ = actionTable; }

edm::EDLooperBase::act_table_

ExceptionToActionTable const * act_table_

Definition: EDLooperBase.h:149

void EDLooperBase::setModuleChanger ( ModuleChanger * iChanger )

Definition at line 161 of file EDLooperBase.cc.

References moduleChanger_.

                                                         {
     moduleChanger_ = iChanger;
   }

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 MuScleFit, ZeeCalibration, AlignmentProducer, Pi0FixedMassWindowCalibration, FWFFLooper, __class__< T >, EcalEleCalibLooper, InvRingCalib, edm::NavigateEventsLooper, edm::IterateNTimesLooper, and PhysicsTools::MVATrainerLooper.