---

VisMainProgram Class Reference

edm::EventProcessor visualisation main program interface. More...

#include <VisFramework/VisFrameworkBase/interface/VisMainProgram.h>

Inheritance diagram for VisMainProgram:

List of all members.

Public Member Functions
void	cmsExceptionCallback (cms::Exception *e)
void	configFailureCallback (cms::Exception *e)
void	exceptionCallback (std::exception *e)
void	frameworkExceptionCallback (lat::Error *e)
void	processorStartedCallback (void)
void	processorStoppedCallback (void)
void	startingProcessorCallback (void)
void	statusMessageCallback (const std::string &msg)
void	stoppingProcessorCallback (void)
void	unhandledExceptionCallback (void)
	VisMainProgram (IgState *state)
	Create and initialise a manager proxy to run the EventProcessor thread.
	~VisMainProgram (void)
	This is assumed to be done late in application exit, and not before IgAtAppLoopService has ran its post-loop actions.
Private Member Functions
	IG_DECLARE_STATE_ELEMENT (VisMainProgram)
void	init (void)
void	quit (void)
	Join the main (GUI) and run() threads.
void	run (void)
	Thread main routine for running CARFMain.
void	start (void)
	Start the thread that runs CARFMain.
Private Attributes
QWidget *	m_mainWindow
IgState *	m_state

---

Detailed Description

edm::EventProcessor visualisation main program interface.

Definition at line 23 of file VisMainProgram.h.

---

Constructor & Destructor Documentation

VisMainProgram::VisMainProgram

(

IgState *

state

)

Create and initialise a manager proxy to run the EventProcessor thread.

The thread is not started yet but things are left initialised such that it will start just before the Qt event loop begins processing and that it is safe to begin loading actual studio contents like visualisers and data proxies.

Definition at line 42 of file VisMainProgram.cc.

References ASSERT, lat::CreateCallback(), DBSPlugin::get(), init(), LFfwvis, LOG, m_state, IgState::put(), start(), and GsfMatrixTools::trace().

    : m_state (state),
      m_mainWindow (IgQtAppWindowService::get (state)->mainWindow ())
{
    LOG (0, trace, LFfwvis, "VisMainProgram::VisMainProgram\n");

    // Register ourselves into the state.
    ASSERT (m_state);
    m_state->put (s_key, this);
    
    // Make sure the event queue is initialised.  This needs to be
    // early enough so that data proxies can be created.
    if (! VisQueue::get (m_state))
        new VisQueue (m_state);

    init ();

    // Auto-register to execute when studio starts running.
    ASSERT (IgQtAppLoopService::get (m_state));
    IgQtAppLoopService::get (m_state)->prepare
        (lat::CreateCallback (this, &VisMainProgram::start));
}

VisMainProgram::~VisMainProgram

(

void

)

This is assumed to be done late in application exit, and not before IgAtAppLoopService has ran its post-loop actions.

In other words, it is not valid to destroy this object when the CARFMain or the Qt event loop are still active.

Definition at line 154 of file VisMainProgram.cc.

References ASSERT, IgState::detach(), and m_state.

{
    ASSERT (m_state);
    m_state->detach (s_key);
}

---

Member Function Documentation

void VisMainProgram::cmsExceptionCallback

(

cms::Exception *

e

)

Definition at line 295 of file VisMainProgram.cc.

References arg, IgArgsElement::argv(), hlt_scaler_cfg::critical, DBSPlugin::get(), m_mainWindow, m_state, and cms::Exception::what().

Referenced by init().

{
    IgArgsElement *args = IgArgsElement::get (m_state);

    IgQtLock ();
    QApplication::restoreOverrideCursor ();

    // Make sure the event processor is finalized.
    if (VisEventProcessorService *procService = VisEventProcessorService::get (m_state)) 
    {
        delete procService;
    }

    QMessageBox::critical (m_mainWindow, "IGUANA", QString ("<p>CMS Exception caught in %1:</p>"
                                                            "<p>%2</p>").arg (args->argv () [0]).arg (e->what ()));
    qApp->quit ();
}

void VisMainProgram::configFailureCallback

(

cms::Exception *

e

)

Definition at line 373 of file VisMainProgram.cc.

References IgArgsElement::arg(), arg, IgArgsElement::args(), IgArgsElement::argv(), GenMuonPlsPt100GeV_cfg::cout, hlt_scaler_cfg::critical, lat::endl(), aod_PYTHIA_cfg::fileName, IgArgsElement::find(), DBSPlugin::get(), LFfwvis, LOG, m_mainWindow, m_state, quit(), GsfMatrixTools::trace(), and cms::Exception::what().

Referenced by init().

{
    LOG (0, trace, LFfwvis, "VisMainProgram::configFailureCallback() Failed to get a parameter set file.\n");

    IgArgsElement *args = IgArgsElement::get (m_state);
    std::vector <std::string> parameterSetOpts;
    parameterSetOpts.push_back ("--parameter-set");
    parameterSetOpts.push_back ("-p");
    std::string parameterSetFilename;
    args->find (parameterSetOpts, parameterSetFilename, false);

    if (parameterSetFilename.empty () && (args->args () > 1)) 
    {
        std::string fileName (args->arg (1));
        parameterSetFilename = fileName;
    }

    IgQtLock ();
    QApplication::restoreOverrideCursor ();

    switch (QMessageBox::critical (m_mainWindow, "IGUANA", QString ("<p><b>Attention:</b> Please, check that \"%1\" does exist and "
                                                                    "its Python syntax is valid.</p>"
                                                                    "<p>Use <i>python -i yourFileName_cfg.py</i> to check the syntax "
                                                                    "(Ctrl+D to exit Python shell).</p>"
                                                                    "Use iguana as follows:<br> <i>> iguana yourFileName_cfg.py</i>"
                                                                    "<p>%2 will load a default configuration with an EmptySource.</p>"
                                                                    "<p><b>CMS Exception:</b></p>"
                                                                    "<p>%3</p>")
                                   .arg (parameterSetFilename).arg (args->argv () [0]).arg (e->what ()), QMessageBox::Ok, QMessageBox::Cancel)) 
    {
    case QMessageBox::Ok:
        break;
    case QMessageBox::Cancel:
        std::cout << "Quit" << std::endl;
        
        this->quit ();
        break;
    }
}

void VisMainProgram::exceptionCallback

(

std::exception *

e

)

Definition at line 275 of file VisMainProgram.cc.

References arg, IgArgsElement::argv(), hlt_scaler_cfg::critical, DBSPlugin::get(), m_mainWindow, and m_state.

Referenced by init().

{
    IgArgsElement *args = IgArgsElement::get (m_state);

    IgQtLock ();
    QApplication::restoreOverrideCursor ();

    // Make sure the event processor is finalized.
    if (VisEventProcessorService *procService = VisEventProcessorService::get (m_state)) 
    {
        delete procService;
    }

    QMessageBox::critical (m_mainWindow, "IGUANA", QString ("<p>Standard library exception caught in %1:</p>"
                                                            "<p>%2</p>").arg (args->argv () [0]).arg (e->what ()));
    qApp->quit ();
}

void VisMainProgram::frameworkExceptionCallback

(

lat::Error *

e

)

Definition at line 256 of file VisMainProgram.cc.

References arg, IgArgsElement::argv(), hlt_scaler_cfg::critical, lat::Error::explainSelf(), DBSPlugin::get(), m_mainWindow, and m_state.

Referenced by init().

{
    IgArgsElement *args = IgArgsElement::get (m_state);
    
    IgQtLock ();
    QApplication::restoreOverrideCursor ();

    // Make sure the event processor is finalized.
    if (VisEventProcessorService *procService = VisEventProcessorService::get (m_state)) 
    {
        delete procService;
    }

    QMessageBox::critical (m_mainWindow, "IGUANA", QString ("<p>Exception caught in %1:</p>"
                                                            "<p>%2</p>").arg (args->argv () [0]).arg (e->explainSelf ()));
    qApp->quit ();      
}

VisMainProgram::IG_DECLARE_STATE_ELEMENT

(

VisMainProgram

)

[private]

void VisMainProgram::init

(

void

)

[private]

Definition at line 66 of file VisMainProgram.cc.

References ASSERT, cmsExceptionCallback(), configFailureCallback(), lat::CreateCallback(), exceptionCallback(), frameworkExceptionCallback(), DBSPlugin::get(), IgEnvsElement::getEnv(), VisEventProcessorService::initEventProcessor(), LFfwvis, LOG, m_state, VisEventProcessorService::onCmsException(), VisEventProcessorService::onConfigFailure(), VisEventProcessorService::onException(), VisEventProcessorService::onFrameworkException(), VisEventProcessorService::onProcessorStarted(), VisEventProcessorService::onProcessorStopped(), VisEventProcessorService::onStartingProcessor(), VisEventProcessorService::onStatusMessage(), VisEventProcessorService::onStoppingProcessor(), VisEventProcessorService::onUnhandledException(), processorStartedCallback(), processorStoppedCallback(), VisAppearanceService::setConfiguration(), startingProcessorCallback(), statusMessageCallback(), stoppingProcessorCallback(), GsfMatrixTools::trace(), and unhandledExceptionCallback().

Referenced by VisMainProgram().

{
    LOG (0, trace, LFfwvis, "VisMainProgram::init\n");

    VisAppearanceService *appearService = VisAppearanceService::get (m_state);
    if (! appearService)
    {
        appearService = new VisAppearanceService (m_state);
        ASSERT (appearService);

        IgEnvsElement *envs = IgEnvsElement::get (m_state);
        std::string configString;
        if (envs->getEnv ("IGUANA_CONFIG", configString))
        {       
            appearService->setConfiguration (configString);
        }
    }
    
    VisEventProcessorService *procService 
        = VisEventProcessorService::get (m_state);

    // Make sure the event processor is initialised.
    if (! procService) 
    {
        procService = new VisEventProcessorService (m_state);

        procService->onProcessorStarted (
            lat::CreateCallback (this, 
                                  &VisMainProgram::processorStartedCallback));

        procService->onProcessorStopped (
            lat::CreateCallback (this, 
                                  &VisMainProgram::processorStoppedCallback));

        procService->onStartingProcessor (
            lat::CreateCallback (this,
                                  &VisMainProgram::startingProcessorCallback));

        procService->onStoppingProcessor (
            lat::CreateCallback (this,
                                  &VisMainProgram::stoppingProcessorCallback));

        procService->onException (
            lat::CreateCallback (this, 
                                  &VisMainProgram::exceptionCallback));

        procService->onCmsException (
            lat::CreateCallback (this, 
                                  &VisMainProgram::cmsExceptionCallback));

        procService->onFrameworkException (
            lat::CreateCallback (this, 
                                  &VisMainProgram::frameworkExceptionCallback));

        procService->onUnhandledException (
            lat::CreateCallback (this, 
                                  &VisMainProgram::unhandledExceptionCallback));

        procService->onConfigFailure (
            lat::CreateCallback (this, 
                                  &VisMainProgram::configFailureCallback));

        procService->onStatusMessage (
            lat::CreateCallback (this, 
                                  &VisMainProgram::statusMessageCallback));
        
        procService->initEventProcessor ();
   }
    
//     // Auto-register to execute when studio starts running.
//     ASSERT (IgQtAppLoopService::get (m_state));
//     IgQtAppLoopService::get (m_state)->prepare
//      (lat::CreateCallback (this, &VisMainProgram::start));

    VisExceptionService *exService = VisExceptionService::get (m_state);
    if (! exService)
    {
        exService = new VisExceptionService (m_state);
    }

    LOG (0, trace, LFfwvis, "VisMainProgram::init: Done.\n");
}

void VisMainProgram::processorStartedCallback

(

void

)

Definition at line 362 of file VisMainProgram.cc.

References DBSPlugin::get(), LFfwvis, LOG, m_state, and GsfMatrixTools::trace().

Referenced by init().

{
    LOG (0, trace, LFfwvis, "VisMainProgram::processorStartedCallback() Processor initialized.\n");

    IgQtLock ();
    QApplication::restoreOverrideCursor ();
    if (IgQtAppStatusBarService *sbar = IgQtAppStatusBarService::get (m_state))
        sbar->setMessage (QString ("Event Processor is initialized."));    
}

void VisMainProgram::processorStoppedCallback

(

void

)

Definition at line 353 of file VisMainProgram.cc.

References DBSPlugin::get(), and m_state.

Referenced by init().

{
    IgQtLock ();
    QApplication::setOverrideCursor (Qt::waitCursor);
    if (IgQtAppStatusBarService *sbar = IgQtAppStatusBarService::get (m_state))
        sbar->setMessage (QString ("Event Processor stopped..."));
}

void VisMainProgram::quit

(

void

)

[private]

Join the main (GUI) and run() threads.

Called from the main thread.

Definition at line 216 of file VisMainProgram.cc.

References DBSPlugin::get(), LFfwvis, LOG, m_state, proc, and GsfMatrixTools::trace().

Referenced by configFailureCallback(), and start().

{
    LOG (0, trace, LFfwvis, "VisMainProgram::quit()\n");

    IgQtLock ();

    // The GUI has exited.  Tell the event processor thread to exit at
    // the earliest opportunity.  This is safe even if CARFMain has
    // already exited, VisQueueProcessor and VisQueue are still
    // around; we just schedule a callback that will never execute.
    // The event thread may not have started yet, or may have failed
    // to start completely.  In that case we simply assume the worst
    // and never join the threads.  The application will nevertheless
    // die when the main thread exits (FIXME: Does it?  Thread safety
    // of state access!).
    if (VisQueueProcessor *proc = VisQueueProcessor::get (m_state))
    {
        // Queue a request to abort event processing
        proc->scheduleAbort ();

        // Join with the CARFMain thread.  This is the only place we
        // do it, so this is guaranteed to succeed no matter which
        // order the threads quit.
        // m_thread->finalize ();
    }

    // Make sure the event processor is finalized.
    if (VisEventProcessorService *procService = VisEventProcessorService::get (m_state)) 
    {
        procService->scheduleAbort ();
        delete procService;
        
        LOG (1, trace, LFfwvis, "VisMainProgram::quit() eventProcessor ()->endJob () done\n");
    }
    
    LOG (0, trace, LFfwvis, "VisMainProgram::quit() done\n");
    qApp->quit ();
}

void VisMainProgram::run

(

void

)

[private]

Thread main routine for running CARFMain.

Once COBRA exits, instructs the GUI to exit too (if that hasn't happened yet).

Definition at line 179 of file VisMainProgram.cc.

References LFfwvis, LOG, and GsfMatrixTools::trace().

{
    LOG (0, trace, LFfwvis, "VisMainProgram::run()\n");

    // Force Objy initialisation.  This must be in the CARFMain thread
    // (= here, not in the main thread).
    // PackageInitializer::initializeALL ("BasicCompServices");
    
    // Get command line args.  (FIXME: Thread safety!)
    
    // Tell the GUI to exit.  We do not need to synchronise here.  As
    // of Qt 2.2.4 calling QApplication::quit() is harmless even if
    // done when the app has already exited.  Qt processes quitting
    // mostly unlocked so locking does us no extra good; we do just in
    // case things change.  The wake-up from unlock is also harmless
    // if the GUI has already quit.
    //
    // If the GUI is still running, this will cause it to quit at the
    // next opportunity.  Eventually IgQtAppLoopService will invoke
    // our quit() method below as a post-loop action.  quit() joins
    // with this thread as we now fall out.
    //
    // If the GUI has already quit, the main thread is most likely
    // already waiting in the join.  It will proceed to exit once we
    // return here.  The join is also the furthest the main thread can
    // get, so we know it is safe to access qApp here.
    //
    // FIXME: This should be the point where user is given the
    // opportunity to restart edm::EventProcessor or notify them about the
    // shut-down (and reason).

    LOG (0, trace, LFfwvis, "VisMainProgram::run() done\n");
}

void VisMainProgram::start

(

void

)

[private]

Start the thread that runs CARFMain.

This is invoked in the main thread just before Qt event loop starts in the studio.

Definition at line 163 of file VisMainProgram.cc.

References lat::CreateCallback(), DBSPlugin::get(), LFfwvis, LOG, m_state, quit(), and GsfMatrixTools::trace().

Referenced by VisMainProgram().

{
    LOG (0, trace, LFfwvis, "VisMainProgram::start()\n");

    IgQtLock ();
        
    // Auto-register a post-action to force a quit.
    IgQtAppLoopService::get (m_state)->post
        (lat::CreateCallback (this, &VisMainProgram::quit));
    
    LOG (0, trace, LFfwvis, "VisMainProgram::start() done\n");
}

void VisMainProgram::startingProcessorCallback

(

void

)

Definition at line 333 of file VisMainProgram.cc.

References DBSPlugin::get(), LFfwvis, LOG, m_state, and GsfMatrixTools::trace().

Referenced by init().

{
    LOG (0, trace, LFfwvis, "VisMainProgram::startingProcessorCallback() Starting Processor initialization...\n");
    
    IgQtLock ();
    QApplication::setOverrideCursor (Qt::waitCursor);
    if (IgQtAppStatusBarService *sbar = IgQtAppStatusBarService::get (m_state))
        sbar->setMessage (QString ("Start Event Processor initialization..."));
}

void VisMainProgram::statusMessageCallback

(

const std::string &

msg

)

Definition at line 414 of file VisMainProgram.cc.

References DBSPlugin::get(), LFfwvis, LOG, m_state, and GsfMatrixTools::trace().

Referenced by init().

{
    LOG (0, trace, LFfwvis, "VisMainProgram::statusMessageCallback() " << message << "\n");

    IgQtLock ();

    if (IgQtAppStatusBarService *sbar = IgQtAppStatusBarService::get (m_state))
        sbar->setMessage (message);    
}

void VisMainProgram::stoppingProcessorCallback

(

void

)

Definition at line 344 of file VisMainProgram.cc.

References DBSPlugin::get(), and m_state.

Referenced by init().

{
    IgQtLock ();
    QApplication::setOverrideCursor (Qt::waitCursor);
    if (IgQtAppStatusBarService *sbar = IgQtAppStatusBarService::get (m_state))
        sbar->setMessage (QString ("Stopping running Event Processor..."));
}

void VisMainProgram::unhandledExceptionCallback

(

void

)

Definition at line 314 of file VisMainProgram.cc.

References arg, IgArgsElement::argv(), hlt_scaler_cfg::critical, DBSPlugin::get(), m_mainWindow, and m_state.

Referenced by init().

{
    IgArgsElement *args = IgArgsElement::get (m_state);

    IgQtLock ();
    QApplication::restoreOverrideCursor ();

    // Make sure the event processor is finalized.
    if (VisEventProcessorService *procService = VisEventProcessorService::get (m_state)) 
    {
        delete procService;
    }

    QMessageBox::critical (m_mainWindow, "IGUANA", QString ("<p>Unknown exception caught in %1</p>")
                           .arg (args->argv () [0]));
    qApp->quit ();
}

---

Member Data Documentation

QWidget* VisMainProgram::m_mainWindow [private]

Definition at line 51 of file VisMainProgram.h.

Referenced by cmsExceptionCallback(), configFailureCallback(), exceptionCallback(), frameworkExceptionCallback(), and unhandledExceptionCallback().

IgState* VisMainProgram::m_state [private]

Definition at line 50 of file VisMainProgram.h.

Referenced by cmsExceptionCallback(), configFailureCallback(), exceptionCallback(), frameworkExceptionCallback(), init(), processorStartedCallback(), processorStoppedCallback(), quit(), start(), startingProcessorCallback(), statusMessageCallback(), stoppingProcessorCallback(), unhandledExceptionCallback(), VisMainProgram(), and ~VisMainProgram().

---

The documentation for this class was generated from the following files:

• VisFramework/VisFrameworkBase/interface/VisMainProgram.h
• VisFramework/VisFrameworkBase/src/VisMainProgram.cc

---