Inheritance diagram for edm::NavigateEventsLooper:

Public Member Functions
Status	duringLoop (Event const &ev, EventSetup const &es, ProcessingController &pc) override

Status	endOfLoop (EventSetup const &es, unsigned int iCounter) override

	NavigateEventsLooper (ParameterSet const &pset)

void	startingNewLoop (unsigned int iIteration) override

	~NavigateEventsLooper () override

Public Member Functions inherited from edm::EDLooperBase
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 *)

	~EDLooperBase () noexcept(false) override

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...

	EDConsumerBase ()

	EDConsumerBase (EDConsumerBase &&)=default

	EDConsumerBase (EDConsumerBase const &)=delete

ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (edm::Transition iTrans) const

ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const

std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const * > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const > const &labelsToDesc, std::string const &processName) const

EDConsumerBase &	operator= (EDConsumerBase &&)=default

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Private Member Functions
	NavigateEventsLooper (NavigateEventsLooper const &)=delete

NavigateEventsLooper const &	operator= (NavigateEventsLooper const &)=delete

Private Attributes
int	countLoops_

int	maxLoops_

bool	shouldStopLoop_

bool	shouldStopProcess_

Additional Inherited Members
Public Types inherited from edm::EDLooperBase
enum	Status { kContinue, kStop }

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::EDLooperBase
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...

Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()

void	consumesMany (const TypeToGet &id)

template<BranchType B>
void	consumesMany (const TypeToGet &id)

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()

template<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

Detailed Description

Allows interactive navigation from event to event in cmsRun jobs. Just add the looper to the python configuration and then respond to the questions that show up on the display by typing a number followed by return.

This was originally written to test the looper interface used by the Fireworks event display. It might be useful by itself.

If you use this either do not use a PoolOutputModule or turn off fast cloning its configuration.

Author: W. David Dagenhart, created 27 August, 2010

Definition at line 29 of file NavigateEventsLooper.cc.

Constructor & Destructor Documentation

◆ NavigateEventsLooper() [1/2]

edm::NavigateEventsLooper::NavigateEventsLooper ( ParameterSet const & pset )

Definition at line 48 of file NavigateEventsLooper.cc.

       : maxLoops_(pset.getUntrackedParameter<int>("maxLoops", -1)),
         countLoops_(0),
         shouldStopLoop_(false),
         shouldStopProcess_(false) {}

◆ ~NavigateEventsLooper()

edm::NavigateEventsLooper::~NavigateEventsLooper ( )

override

Definition at line 54 of file NavigateEventsLooper.cc.

54 {}

◆ NavigateEventsLooper() [2/2]

edm::NavigateEventsLooper::NavigateEventsLooper ( NavigateEventsLooper const & )

privatedelete

Member Function Documentation

◆ duringLoop()

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

overridevirtual

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

Implements edm::EDLooperBase.

Definition at line 58 of file NavigateEventsLooper.cc.

                                                                                                                {
     if (!pc.lastOperationSucceeded()) {
       std::cout << "Event could not be found. Nothing done. Try again.\n";
     }
  
     std::cout << "\nWhat should we do next?\n";
  
     if (pc.forwardState() == ProcessingController::kEventsAheadInFile) {
       std::cout << "(0) process the next event\n";
     } else if (pc.forwardState() == ProcessingController::kNextFileExists) {
       std::cout << "(0) process the next event if it exists (at last event in the open file. there are more files)\n";
     } else if (pc.forwardState() == ProcessingController::kAtLastEvent) {
       std::cout << "(0) will stop the loop because this is the last event\n";
     } else if (pc.forwardState() == ProcessingController::kUnknownForward) {
       std::cout << "(0) process the next event (if it exists)\n";
     }
  
     if (pc.canRandomAccess()) {
       if (pc.reverseState() == ProcessingController::kEventsBackwardsInFile) {
         std::cout << "(1) process the previous event\n";
       } else if (pc.reverseState() == ProcessingController::kPreviousFileExists) {
         std::cout << "(1) process the previous event if there are any (at first event in the open file. there are "
                      "previous files)\n";
       } else if (pc.reverseState() == ProcessingController::kAtFirstEvent) {
         std::cout << "(1) will stop the loop because this is the first event\n";
       }
  
       std::cout << "(2) process a specific event\n";
     }
  
     std::cout << "(3) stop loop\n";
     std::cout << "(4) stop process" << std::endl;
     long long int x;
  
     bool inputFailed = false;
     do {
       inputFailed = false;
       if (!(std::cin >> x) || x < 0 || x > 4) {
         inputFailed = true;
         std::cin.clear();
         std::cin.ignore(10000, '\n');
         std::cout << "Please enter numeric characters only. The value must be in the range 0 to 4 (inclusive). Please "
                      "try again."
                   << std::endl;
       }
       if (!pc.canRandomAccess() && (x == 1 || x == 2)) {
         inputFailed = true;
         std::cout << "The source cannot do random access. 1 and 2 are illegal values. Please try again." << std::endl;
       }
     } while (inputFailed);
  
     shouldStopLoop_ = false;
     shouldStopProcess_ = false;
     if (x == 0) {
       pc.setTransitionToNextEvent();
     } else if (x == 1) {
       pc.setTransitionToPreviousEvent();
     } else if (x == 2) {
       std::cout << "Which run?" << std::endl;
       do {
         inputFailed = false;
         if (!(std::cin >> x)) {
           inputFailed = true;
           std::cin.clear();
           std::cin.ignore(10000, '\n');
           std::cout << "Please enter numeric characters only. Please try again." << std::endl;
         }
       } while (inputFailed);
       RunNumber_t run = x;
       std::cout << "Which luminosity block?" << std::endl;
       do {
         inputFailed = false;
         if (!(std::cin >> x)) {
           inputFailed = true;
           std::cin.clear();
           std::cin.ignore(10000, '\n');
           std::cout << "Please enter numeric characters only. Please try again." << std::endl;
         }
       } while (inputFailed);
       LuminosityBlockNumber_t lumi = x;
       std::cout << "Which event?" << std::endl;
       do {
         inputFailed = false;
         if (!(std::cin >> x)) {
           inputFailed = true;
           std::cin.clear();
           std::cin.ignore(10000, '\n');
           std::cout << "Please enter numeric characters only. Please try again." << std::endl;
         }
       } while (inputFailed);
       EventNumber_t ev = x;
       pc.setTransitionToEvent(EventID(run, lumi, ev));
     } else if (x == 3) {
       pc.setTransitionToNextEvent();
       shouldStopLoop_ = true;
     } else if (x == 4) {
       pc.setTransitionToNextEvent();
       shouldStopLoop_ = true;
       shouldStopProcess_ = true;
     }
     return shouldStopLoop_ ? kStop : kContinue;
   }

◆ endOfLoop()

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

overridevirtual

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.

Implements edm::EDLooperBase.

Definition at line 161 of file NavigateEventsLooper.cc.

                                                                                       {
     std::cout << "Ending loop" << std::endl;
     if (shouldStopProcess_)
       return kStop;
     ++countLoops_;
     return (maxLoops_ < 0 || countLoops_ < maxLoops_) ? kContinue : kStop;
   }

References countLoops_, gather_cfg::cout, edm::EDLooperBase::kContinue, edm::EDLooperBase::kStop, maxLoops_, and shouldStopProcess_.

◆ operator=()

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

privatedelete

◆ startingNewLoop()

void edm::NavigateEventsLooper::startingNewLoop ( unsigned int )

overridevirtual

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.

Implements edm::EDLooperBase.

Definition at line 56 of file NavigateEventsLooper.cc.

56 {}

Member Data Documentation

◆ countLoops_

int edm::NavigateEventsLooper::countLoops_

private

Definition at line 43 of file NavigateEventsLooper.cc.

Referenced by endOfLoop().

◆ maxLoops_

int edm::NavigateEventsLooper::maxLoops_

private

Definition at line 42 of file NavigateEventsLooper.cc.

Referenced by endOfLoop().

◆ shouldStopLoop_

bool edm::NavigateEventsLooper::shouldStopLoop_

private

Definition at line 44 of file NavigateEventsLooper.cc.

Referenced by duringLoop().

◆ shouldStopProcess_

bool edm::NavigateEventsLooper::shouldStopProcess_

private

Definition at line 45 of file NavigateEventsLooper.cc.

Referenced by duringLoop(), and endOfLoop().

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NavigateEventsLooper() [1/2]

◆ ~NavigateEventsLooper()

◆ NavigateEventsLooper() [2/2]

Member Function Documentation

◆ duringLoop()

◆ endOfLoop()

◆ operator=()

◆ startingNewLoop()

Member Data Documentation

◆ countLoops_

◆ maxLoops_

◆ shouldStopLoop_

◆ shouldStopProcess_