#include <FWFFLooper.h>

Inheritance diagram for FWFFLooper:

Public Member Functions
void	attachTo (edm::ActivityRegistry &) override
	Override this method if you need to monitor the state of the processing. More...

void	autoLoadNewEvent () override

void	beginRun (const edm::Run &, const edm::EventSetup &) override

void	checkPosition () override

void	display (const std::string &info="")

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

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

	FWFFLooper (const edm::ParameterSet &)

TEveMagField *	getMagField ()

void	postBeginJob ()

void	postEndJob ()

void	quit () override

void	remakeGeometry (const DisplayGeomRecord &dgRec)

void	requestChanges (const std::string &, const edm::ParameterSet &)

void	setupFieldForPropagator (TEveTrackPropagator *prop)

void	showPathsGUI (const TGWindow *p)

void	startingNewLoop (unsigned int) override

void	stopPlaying () override

	~FWFFLooper () override

Public Member Functions inherited from CmsShowMainBase
FWModelChangeManager *	changeManager ()

virtual void	checkKeyBindingsOnPLayEventsStateChanged ()

	CmsShowMainBase ()

FWColorManager *	colorManager ()

const char *	configFilename () const

FWConfigurationManager *	configurationManager ()

void	doFirstEvent ()

void	doLastEvent ()

void	doNextEvent ()

void	doPreviousEvent ()

void	draw ()

FWEventItemsManager *	eiManager ()

bool	forward () const

const std::string &	geometryFilename (void)

FWGeometry &	getGeom ()

void	goToRunEvent (edm::RunNumber_t, edm::LuminosityBlockNumber_t, edm::EventNumber_t)

FWGUIManager *	guiManager ()

bool	isPlaying () const

void	loadGeometry ()

bool	loop () const

FWModelChangeManager *	modelChangeManager ()

void	partialLoadConfiguration (const std::string &config)

void	partialWriteToConfigFile (const std::string &config)

void	playBackward ()

void	playForward ()

void	registerPhysicsObject (const FWPhysicsObjectDesc &iItem)

void	reloadConfiguration (const std::string &config)

FWSelectionManager *	selectionManager ()

void	setAutoSaveAllViewsFormat (const std::string &fmt)

void	setAutoSaveAllViewsHeight (int x)

void	setConfigFilename (const std::string &f)

void	setGeometryFilename (const std::string &filename)

void	setPlayDelay (Float_t val)

void	setPlayLoop ()

void	setSimGeometryFilename (const std::string &filename, const std::string &geoname)

void	setup (FWNavigatorBase navigator, fireworks::Context context, FWJobMetadataManager *metadataManager)

void	setupActions ()

void	setupAutoLoad (float x)

void	setupConfiguration ()

void	setupDebugSupport ()

void	setupViewManagers ()

void	startAutoLoadTimer ()

CmsShowTaskExecutor *	startupTasks ()

void	stopAutoLoadTimer ()

void	unsetPlayLoop ()

FWViewManagerManager *	viewManager ()

void	writePartialToConfigFile ()

void	writeToConfigFile (const std::string &config)

void	writeToCurrentConfigFile ()

virtual	~CmsShowMainBase () noexcept(false)

Public Member Functions inherited from edm::EDLooperBase
void	beginOfJob (EventSetupImpl const &)

virtual void	beginOfJob (EventSetup const &)

virtual void	beginOfJob ()

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)

Private Types
typedef std::map< std::string, edm::ParameterSet >	ModuleChanges

Private Member Functions
	FWFFLooper (const FWFFLooper &)

void	loadDefaultGeometryFile (void)

const FWFFLooper &	operator= (const FWFFLooper &)

Private Attributes
bool	m_AllowStep

edm::Service< FWFFHelper >	m_appHelper

bool	m_autoReload

std::unique_ptr< fireworks::Context >	m_context

TEveManager *	m_EveManager

bool	m_firstTime

edm::ESWatcher< DisplayGeomRecord >	m_geomWatcher

bool	m_isFirstEvent

bool	m_isLastEvent

TEveMagField *	m_MagField

std::unique_ptr< FWFFMetadataManager >	m_metadataManager

std::unique_ptr< FWFFNavigator >	m_navigator

edm::EventID	m_nextEventId

FWPathsPopup *	m_pathsGUI

TRint *	m_Rint

ModuleChanges	m_scheduledChanges

bool	m_ShowEvent

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

Protected Member Functions inherited from CmsShowMainBase
fireworks::Context *	context ()

virtual void	eventChangedImp ()

void	eventChangedSlot ()

void	sendVersionInfo ()

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...

Detailed Description

Definition at line 44 of file FWFFLooper.h.

Member Typedef Documentation

typedef std::map<std::string, edm::ParameterSet> FWFFLooper::ModuleChanges

private

Definition at line 103 of file FWFFLooper.h.

Constructor & Destructor Documentation

FWFFLooper::FWFFLooper ( const edm::ParameterSet & )

FWFFLooper::~FWFFLooper ( )

override

Definition at line 209 of file FWFFLooper.cc.

 {
    delete m_MagField;
 }

FWFFLooper::FWFFLooper ( const FWFFLooper & )

private

Member Function Documentation

void FWFFLooper::attachTo ( edm::ActivityRegistry & )

overridevirtual

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

Reimplemented from edm::EDLooperBase.

Definition at line 200 of file FWFFLooper.cc.

References postEndJob(), FWPathsPopup::postModuleEvent(), FWPathsPopup::preModuleEvent(), edm::ActivityRegistry::watchPostEndJob(), edm::ActivityRegistry::watchPostModuleEvent(), and edm::ActivityRegistry::watchPreModuleEvent().

 {
    m_pathsGUI = new FWPathsPopup(this, guiManager());
 
    ar.watchPostModuleEvent(m_pathsGUI, &FWPathsPopup::postModuleEvent);
    ar.watchPreModuleEvent(m_pathsGUI, &FWPathsPopup::preModuleEvent);
    ar.watchPostEndJob(this, &FWFFLooper::postEndJob);
 }

void FWFFLooper::autoLoadNewEvent ( )

overridevirtual

This actually needs to be different from the standalone case because nextEvent() / previousEvent() will immediately interrupt the GUI event loop and fall back to the looper.

Implements CmsShowMainBase.

Definition at line 276 of file FWFFLooper.cc.

References heppy_loop::loop, and CmsShowMainBase::stopPlaying().

 {
    stopAutoLoadTimer();
    bool reachedEnd = (forward() && m_isLastEvent) || (!forward() && m_isFirstEvent);
 
    if (!reachedEnd || loop())
    {
       // Will exit the loop here!
       m_autoReload = true;
       forward() ? m_navigator->nextEvent() : m_navigator->previousEvent();
    }
    else
    {
       m_autoReload = false;
       CmsShowMainBase::stopPlaying();
       guiManager()->enableActions();
       guiManager()->getMainFrame()->enableComplexNavigation(false);
    }
 }

void FWFFLooper::beginRun	(	const edm::Run &	iRun,
		const edm::EventSetup &	iSetup
	)

override

Definition at line 311 of file FWFFLooper.cc.

References edm::ConditionsInRunBlock::BAvgCurrent, cppFunctionSkipper::exception, edm::EventSetup::find(), fwLog, edm::EventSetup::get(), edm::Run::getByLabel(), FWRecoGeometry::idToName, edm::HandleBase::isValid(), fwlog::kInfo, CmsShowMainBase::loadGeometry(), RunInfo::m_avg_current, edm::ESHandle< T >::product(), FWGUIManager::showEventFilterGUI(), and showPathsGUI().

 {
    // Check DisplayGeomRecord changes.
    try {
       m_geomWatcher.check(iSetup);
    }
    catch (...) {}
    
    // If the geometry was not picked up from a file, we try to get it from the
    // EventSetup!
    // FIXME: we need to check we execute only once because the view managers
    //        depend on geometry and they cannot be initialised more than once.
    //        This should actually be cleaned up so that the various view manager
    //        don't care about geometry.
    // FIXME: we should actually be able to update the geometry when requested.
    //        this is not possible at the moment.
    if (m_firstTime == true)
    {
       if (m_context->getGeom() == nullptr)
       {
      try
      {
         guiManager()->updateStatus("Loading geometry...");
         edm::ESHandle<FWRecoGeometry> geoh;
         iSetup.get<FWRecoGeometryRecord>().get(geoh);
         getGeom().initMap(geoh.product()->idToName);
         m_context->setGeom(&(getGeom()));
      }
      catch( const cms::Exception& exception )
      {
             setGeometryFilename("cmsGeom10.root");
         CmsShowMainBase::loadGeometry();
      }
       }
 
       setupViewManagers();
       setupConfiguration();
       setupActions();
       
       guiManager()->showEventFilterGUI_.connect(boost::bind(&FWFFLooper::showPathsGUI, this, _1));
       guiManager()->setFilterButtonText("Show paths / CMSSW configuration editor");
       guiManager()->filterButtonClicked_.connect(boost::bind(&FWGUIManager::showEventFilterGUI, guiManager()));
 
       m_firstTime = false;
       m_autoReload = false;
    }
 
    float current = 18160.0f;
    try {
       edm::Handle<edm::ConditionsInRunBlock> runCond;
       // bool res = iRun.getByType(runCond);
       bool res = iRun.getByLabel("conditionsInEdm", runCond);
       if (res && runCond.isValid())
       {
          printf("Got current from conds in edm %f\n", runCond->BAvgCurrent);
          current = runCond->BAvgCurrent;
       }
       else
       {
          printf("Could not extract run-conditions get-result=%d, is-valid=%d\n", res, runCond.isValid());
 
          auto rec = iSetup.find( edm::eventsetup::EventSetupRecordKey::makeKey<RunInfoRcd>());
          if( rec )
          {
             edm::ESHandle<RunInfo> sum;
             iSetup.get<RunInfoRcd>().get(sum);
 
             current = sum->m_avg_current;
             printf("Got current from RunInfoRcd %f\n", sum->m_avg_current);
          }
       }
    }
    catch (...) {
       fwLog(fwlog::kInfo) << "ConditionsInRunBlock not available\n";
    }
    static_cast<CmsEveMagField*>(m_MagField)->SetFieldByCurrent(current);
    context()->getField()->setFFFieldMag(m_MagField->GetMaxFieldMag());
 }

void FWFFLooper::checkPosition ( )

overridevirtual

Implements CmsShowMainBase.

Definition at line 251 of file FWFFLooper.cc.

References heppy_loop::loop.

 {
    if (loop() && isPlaying())
       return;
   
    guiManager()->getMainFrame()->enableNavigatorControls();
    guiManager()->getMainFrame()->enableComplexNavigation(false);
 
    if (m_isFirstEvent)
       guiManager()->disablePrevious();
 
    if (m_isLastEvent)
    {
       guiManager()->disableNext();
       // force enable play events action in --port mode
       if (!guiManager()->playEventsAction()->isEnabled())
          guiManager()->playEventsAction()->enable();
    }
 }

void FWFFLooper::display ( const std::string & info = "" )

Definition at line 459 of file FWFFLooper.cc.

References FWFFHelper::m_Rint.

 {
    // Display whatever was registered so far, wait until user presses
    // the "Step" button.
 
    if (m_AllowStep)
    {
       gEve->Redraw3D();
       m_Rint->Run(kTRUE);
    }
 }

edm::EDLooperBase::Status FWFFLooper::duringLoop	(	const edm::Event &	event,
		const edm::EventSetup &	es,
		edm::ProcessingController &	controller
	)

override

Definition at line 392 of file FWFFLooper.cc.

References ntuplePlotting::draw(), edm::ProcessingController::forwardState(), edm::ProcessingController::kAtFirstEvent, edm::ProcessingController::kAtLastEvent, FWFFNavigator::kFirstEvent, FWFFNavigator::kLastEvent, FWFFNavigator::kNextEvent, FWFFNavigator::kPreviousEvent, edm::shared_memory::channel_names::kStop, FWFFHelper::m_Rint, edm::ProcessingController::reverseState(), edm::ProcessingController::setTransitionToEvent(), edm::ProcessingController::setTransitionToNextEvent(), and edm::ProcessingController::setTransitionToPreviousEvent().

 {
    // Check DisplayGeomRecord changes.
    try { 
       m_geomWatcher.check(es);
    } catch (...) {}
    
 
    m_pathsGUI->postEvent(event);
 
    m_isLastEvent = controller.forwardState() == edm::ProcessingController::kAtLastEvent;
    m_isFirstEvent = controller.reverseState() == edm::ProcessingController::kAtFirstEvent;
    // If the next event id is valid, set the transition so 
    // that we go to it go to to it.
    if (m_nextEventId != edm::EventID())
    {
       controller.setTransitionToEvent(m_nextEventId);
       m_nextEventId = edm::EventID();
       return kContinue;
    }
    // We handle "last event" by going to the first event and then moving to the
    // previous event.
    if (m_navigator->currentTransition() == FWFFNavigator::kLastEvent)
    {
       m_navigator->resetTransition();
       controller.setTransitionToPreviousEvent();
       return kContinue;
    }
 
    m_pathsGUI->hasChanges() = false;
    m_metadataManager->update(new FWFFMetadataUpdateRequest(event));
    m_navigator->setCurrentEvent(&event);
    if (m_autoReload == true)
       startAutoLoadTimer();
 
    checkPosition();
    draw();
       
    m_Rint->Run(kTRUE);
    // If the GUI changed the PSet, save the current event to reload
    // it on next iteration.
    if (m_pathsGUI->hasChanges())
    {
       m_nextEventId = edm::EventID();
       return kStop;
    }
    else if (m_navigator->currentTransition() == FWFFNavigator::kFirstEvent)
    {
       m_nextEventId = m_navigator->getFirstEventID();
       return kStop;
    }
    else if (m_navigator->currentTransition() == FWFFNavigator::kLastEvent)
    {
       m_nextEventId = m_navigator->getFirstEventID();
       return kStop;
    }
    else if (m_navigator->currentTransition() == FWFFNavigator::kNextEvent)
       controller.setTransitionToNextEvent();
    else if (m_navigator->currentTransition() == FWFFNavigator::kPreviousEvent)
       controller.setTransitionToPreviousEvent();
    return kContinue;
 }

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

override

This is called at the end of looping. We always continue because we want the transition set in the ProcessingController to happen.

Definition at line 505 of file FWFFLooper.cc.

References MessageLogger_cfi::cerr, MillePedeFileConverter_cfg::e, fwLog, mps_fire::i, fwlog::kError, and cms::Exception::what().

 {
    // Looks like the module changer is availble only here.
    for (ModuleChanges::iterator i = m_scheduledChanges.begin(),
                                 e = m_scheduledChanges.end();
         i != e; ++i)
    {
       try {
          moduleChanger()->changeModule(i->first, i->second);
       }
       catch (cms::Exception const& e)
       { 
          fwLog(fwlog::kError) << "FWFFLooper::endOfLoop caught exception.\n";
          std::cerr << e.what() << std::endl;
       } 
    }
    m_scheduledChanges.clear();
    return kContinue;
 }

TEveMagField * FWFFLooper::getMagField ( )

Definition at line 476 of file FWFFLooper.cc.

 {
    return m_MagField;
 }

void FWFFLooper::loadDefaultGeometryFile ( void )

private

Definition at line 192 of file FWFFLooper.cc.

References f, and CmsShowMainBase::loadGeometry().

 {
    CmsShowTaskExecutor::TaskFunctor f;
    f=boost::bind( &CmsShowMainBase::loadGeometry, this );
    startupTasks()->addTask( f );
 }

const FWFFLooper& FWFFLooper::operator= ( const FWFFLooper & )

private

void FWFFLooper::postBeginJob ( )

void FWFFLooper::postEndJob ( )

Definition at line 244 of file FWFFLooper.cc.

Referenced by attachTo().

 {
    printf("FWFFLooper::postEndJob\n");
    TEveManager::Terminate();
 }

void FWFFLooper::quit ( )

overridevirtual

Implements CmsShowMainBase.

Definition at line 488 of file FWFFLooper.cc.

 {
    gSystem->ExitLoop();
 
    // Throwing exception here is bad because:
    //   a) it does not work when in a "debug step";
    //   b) does not restore terminal state.
    // So we do exit instead for now.
    // throw cms::Exception("UserTerminationRequest");
    gSystem->Exit(0);
 }

void FWFFLooper::remakeGeometry ( const DisplayGeomRecord & dgRec )

Definition at line 551 of file FWFFLooper.cc.

References fwLog, relativeConstraints::geom, edm::eventsetup::DependentRecordImplementation< RecordT, ListT >::get(), fwlog::kInfo, edm::ESHandle< T >::product(), and FWGeometryTableViewManager::setGeoManagerRuntime().

 {
    fwLog(fwlog::kInfo) << "FWFFLooper set TGeo geomtery from DisplayGeomRecord.\n";
 
    edm::ESHandle<TGeoManager> geom;
    dgRec.get(geom);
    TEveGeoManagerHolder _tgeo(const_cast<TGeoManager*>(geom.product()));
    FWGeometryTableViewManager::setGeoManagerRuntime(gGeoManager);
 }

void FWFFLooper::requestChanges	(	const std::string &	moduleLabel,
		const edm::ParameterSet &	ps
	)

Definition at line 543 of file FWFFLooper.cc.

Referenced by FWPathsPopup::scheduleReloadEvent().

 {
    m_scheduledChanges[moduleLabel] = ps;
 }

void FWFFLooper::setupFieldForPropagator ( TEveTrackPropagator * prop )

Definition at line 482 of file FWFFLooper.cc.

 {
    prop->SetMagFieldObj(m_MagField, kFALSE);
 }

void FWFFLooper::showPathsGUI ( const TGWindow * p )

Definition at line 526 of file FWFFLooper.cc.

Referenced by beginRun().

 {
    if (!m_pathsGUI)
       return;
    if (m_pathsGUI->IsMapped())
    {
       guiManager()->setFilterButtonText("Show paths / CMSSW configuration editor");
       m_pathsGUI->UnmapWindow();
    }
    else
    {
       guiManager()->setFilterButtonText("Hide paths / CMSSW configuration editor");
       m_pathsGUI->MapWindow();
    }
 }

void FWFFLooper::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 220 of file FWFFLooper.cc.

References f, info(), and FWFFHelper::m_Rint.

 {
    // Initialise on first loop.
    if (count == 0)
    {
       const edm::ScheduleInfo *info = scheduleInfo();
       m_pathsGUI->setup(info);
 
       // We need to enter the GUI loop in order to 
       // have all the callbacks executed. The last callback will
       // be responsible for returning the control to CMSSW. 
       assert(m_Rint);
       CmsShowTaskExecutor::TaskFunctor f;
       f=boost::bind(&TApplication::Terminate, m_Rint, 0);
       startupTasks()->addTask(f);
       // FIXME: do we really need to delay tasks like this?
       startupTasks()->startDoingTasks(); 
       m_Rint->Run(kTRUE);
       // Show the GUI ...
       gSystem->ProcessEvents();
    }
 }

void FWFFLooper::stopPlaying ( )

overridevirtual

Reimplemented from CmsShowMainBase.

Definition at line 297 of file FWFFLooper.cc.

References CmsShowMainBase::stopPlaying().

 {
    stopAutoLoadTimer();
    m_autoReload = false;
    CmsShowMainBase::stopPlaying();
    guiManager()->enableActions();
    guiManager()->getMainFrame()->enableComplexNavigation(false);
    checkPosition();
 }

Member Data Documentation

bool FWFFLooper::m_AllowStep

private

Definition at line 98 of file FWFFLooper.h.

edm::Service<FWFFHelper> FWFFLooper::m_appHelper

private

Definition at line 88 of file FWFFLooper.h.

bool FWFFLooper::m_autoReload

private

Definition at line 106 of file FWFFLooper.h.

std::unique_ptr<fireworks::Context> FWFFLooper::m_context

private

Definition at line 91 of file FWFFLooper.h.

TEveManager* FWFFLooper::m_EveManager

private

Definition at line 93 of file FWFFLooper.h.

bool FWFFLooper::m_firstTime

private

Definition at line 100 of file FWFFLooper.h.

edm::ESWatcher<DisplayGeomRecord> FWFFLooper::m_geomWatcher

private

Definition at line 110 of file FWFFLooper.h.

bool FWFFLooper::m_isFirstEvent

private

Definition at line 107 of file FWFFLooper.h.

bool FWFFLooper::m_isLastEvent

private

Definition at line 108 of file FWFFLooper.h.

TEveMagField* FWFFLooper::m_MagField

private

Definition at line 96 of file FWFFLooper.h.

std::unique_ptr<FWFFMetadataManager> FWFFLooper::m_metadataManager

private

Definition at line 90 of file FWFFLooper.h.

std::unique_ptr<FWFFNavigator> FWFFLooper::m_navigator

private

Definition at line 89 of file FWFFLooper.h.

edm::EventID FWFFLooper::m_nextEventId

private

Definition at line 105 of file FWFFLooper.h.

FWPathsPopup* FWFFLooper::m_pathsGUI

private

Definition at line 101 of file FWFFLooper.h.

TRint* FWFFLooper::m_Rint

private

Definition at line 94 of file FWFFLooper.h.

ModuleChanges FWFFLooper::m_scheduledChanges

private

Definition at line 104 of file FWFFLooper.h.

bool FWFFLooper::m_ShowEvent

private

Definition at line 99 of file FWFFLooper.h.

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation