JobResultsPresenter Class Reference

Description

Presents results of job (JobItem) using stack of different widgets and combo box in the right top corner of JobView, to switch between widgets.

Definition at line 27 of file JobResultsPresenter.h.

Inheritance diagram for JobResultsPresenter:

Collaboration diagram for JobResultsPresenter:

Public Types
using	factory_function_t = std::function< SessionItemWidget *()>

Public Slots
void	setPresentation (JobViewActivity activity)

Public Member Functions
	JobResultsPresenter (QWidget *parent=nullptr)
virtual QList< QAction * >	actionList ()
SessionItem *	currentItem ()
const SessionItem *	currentItem () const
void	registerWidget (const QString &presentationType, factory_function_t)
void	setItem (SessionItem *item) override
void	setPresentation (const QString &presentationType) override
	Sets stack to show widget corresponding to given presentation. More...
void	setToolbarVisible (bool value)

Protected Member Functions
QStringList	activePresentationList (SessionItem *item) override
	Returns list of presentation types, available for given item. JobItem with fitting abilities is valid for IntensityDataWidget and FitComparisonWidget. More...
void	hideEvent (QHideEvent *) override
QString	itemPresentation () const override
	Presentation which should be shown for current item. More...
QStringList	presentationList (SessionItem *item) override
	Returns full list of presentations available for given item. More...
QString	selectedPresentation () const
	Presentation selected in combo selector. More...
void	showEvent (QShowEvent *) override
void	subscribeToItem () override
virtual void	unsubscribeFromItem ()

Private Slots
void	onComboChanged (const QString &name)

Private Member Functions
QStringList	defaultActivePresentationsOfInstrument (InstrumentItem *instrumentItem)
QString	defaultPresentationOfInstrument (InstrumentItem *instrumentItem)
QString	fitPresentationOfInstrument (InstrumentItem *instrumentItem)
void	setSizeToCurrentWidget ()
	Resizes QStackedWidget to currently active page. More...

Private Attributes
QWidget *	m_blankWidget
SessionItemController *	m_itemController
QMap< QString, SessionItemWidget * >	m_presentationTypeToWidget
QStackedWidget *	m_stackedWidget
ItemComboToolbar *	m_toolbar
IFactory< QString, SessionItemWidget >	m_widgetFactory

Member Typedef Documentation

factory_function_t

using ItemComboWidget::factory_function_t = std::function<SessionItemWidget*()>

inherited

Definition at line 42 of file ItemComboWidget.h.

Constructor & Destructor Documentation

JobResultsPresenter()

JobResultsPresenter::JobResultsPresenter ( QWidget *  parent = nullptr )

explicit

Definition at line 25 of file JobResultsPresenter.cpp.

    : ItemComboWidget(parent)
{
    setWindowTitle("Job Datafield");
    setObjectName("JobResultsPresenter");
 
    registerWidget("Heat Map", create_new<IntensityDataWidget>);
    registerWidget("Projections", create_new<IntensityDataProjectionsWidget>);
    registerWidget("Fit 1D Data", create_new<FitComparisonWidget1D>);
    registerWidget("Fit 2D Data", create_new<FitComparisonWidget>);
    registerWidget("Reflectometry", create_new<SpecularDataWidget>);
 
    setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
    setMinimumSize(600, 600);
}

References ItemComboWidget::registerWidget().

Here is the call graph for this function:

Member Function Documentation

actionList()

QList< QAction * > SessionItemWidget::actionList ( )

virtualinherited

Reimplemented in IntensityDataProjectionsWidget, SpecularDataWidget, SpecularDataCanvas, FitComparisonWidget1D, FitComparisonWidget, IntensityDataWidget, IntensityDataCanvas, SpecularDataImportWidget, RealDataPresenter, and RealDataMaskWidget.

Definition at line 36 of file SessionItemWidget.cpp.

{
    return QList<QAction*>();
}

Referenced by ItemComboWidget::setPresentation().

activePresentationList()

QStringList JobResultsPresenter::activePresentationList ( SessionItem *  item )

overrideprotectedvirtual

Returns list of presentation types, available for given item. JobItem with fitting abilities is valid for IntensityDataWidget and FitComparisonWidget.

Reimplemented from ItemComboWidget.

Definition at line 85 of file JobResultsPresenter.cpp.

{
    auto* jobItem = dynamic_cast<JobItem*>(item);
    if (!jobItem || jobItem->isRunning())
        return {};
 
    ASSERT(jobItem->instrumentItem() != nullptr);
 
    auto result = defaultActivePresentationsOfInstrument(jobItem->instrumentItem());
 
    if (jobItem->isValidForFitting())
        result << fitPresentationOfInstrument(jobItem->instrumentItem());
 
    return result;
}

References defaultActivePresentationsOfInstrument(), and fitPresentationOfInstrument().

Here is the call graph for this function:

currentItem() [1/2]

SessionItem * SessionItemWidget::currentItem ( )

inherited

Definition at line 41 of file SessionItemWidget.cpp.

{
    return const_cast<SessionItem*>(static_cast<const SessionItemWidget*>(this)->currentItem());
}

Referenced by FitFlowWidget::fitSuiteItem(), RealDataMaskWidget::intensityDataItem(), IntensityDataCanvas::intensityDataItem(), IntensityDataWidget::intensityDataItem(), IntensityDataProjectionsWidget::intensityDataItem(), ProjectionsPlot::intensityItem(), ColorMap::intensityItem(), itemPresentation(), FitParameterWidget::jobItem(), ParameterTuningWidget::jobItem(), RunFitControlWidget::jobItem(), FitComparisonWidget::jobItem(), FitComparisonWidget1D::jobItem(), IntensityDataPropertyWidget::jobItem(), SpecularDataPropertyWidget::jobItem(), SpecularDataImportWidget::realDataItem(), ItemComboWidget::setPresentation(), setPresentation(), SpecularDataImportWidget::specularDataItem(), SpecularDataCanvas::specularDataItem(), SpecularDataWidget::specularDataItem(), SpecularPlot::specularItem(), ItemComboWidget::subscribeToItem(), ProjectionsPlot::unsubscribeFromChildren(), and Plot1D::viewItem().

currentItem() [2/2]

const SessionItem * SessionItemWidget::currentItem ( ) const

inherited

Definition at line 46 of file SessionItemWidget.cpp.

{
    return m_itemController->currentItem();
}

References SessionItemController::currentItem(), and SessionItemWidget::m_itemController.

Here is the call graph for this function:

defaultActivePresentationsOfInstrument()

QStringList JobResultsPresenter::defaultActivePresentationsOfInstrument ( InstrumentItem *  instrumentItem )

private

Definition at line 126 of file JobResultsPresenter.cpp.

{
    if (instrumentItem->is<SpecularInstrumentItem>())
        return {"Reflectometry"};
 
    return {"Heat Map", "Projections"};
}

References InstrumentItem::is().

Referenced by activePresentationList(), and presentationList().

Here is the call graph for this function:

defaultPresentationOfInstrument()

QString JobResultsPresenter::defaultPresentationOfInstrument ( InstrumentItem *  instrumentItem )

private

Definition at line 117 of file JobResultsPresenter.cpp.

{
    if (instrumentItem->is<SpecularInstrumentItem>())
        return "Reflectometry";
 
    return "Heat Map";
}

References InstrumentItem::is().

Referenced by setPresentation().

Here is the call graph for this function:

fitPresentationOfInstrument()

QString JobResultsPresenter::fitPresentationOfInstrument ( InstrumentItem *  instrumentItem )

private

Definition at line 134 of file JobResultsPresenter.cpp.

{
    if (instrumentItem->is<SpecularInstrumentItem>())
        return "Fit 1D Data";
 
    return "Fit 2D Data";
}

References InstrumentItem::is().

Referenced by activePresentationList(), presentationList(), and setPresentation().

Here is the call graph for this function:

hideEvent()

void SessionItemWidget::hideEvent ( QHideEvent *  )

overrideprotectedinherited

Definition at line 56 of file SessionItemWidget.cpp.

{
    m_itemController->unsubscribe();
}

References SessionItemWidget::m_itemController, and SessionItemController::unsubscribe().

Here is the call graph for this function:

itemPresentation()

QString JobResultsPresenter::itemPresentation ( ) const

overrideprotectedvirtual

Presentation which should be shown for current item.

Reimplemented from ItemComboWidget.

Definition at line 41 of file JobResultsPresenter.cpp.

{
    if (!currentItem())
        return {};
 
    const QString value = dynamic_cast<const JobItem*>(currentItem())->presentationType();
    return value.isEmpty() ? selectedPresentation() : value;
}

References SessionItemWidget::currentItem(), and ItemComboWidget::selectedPresentation().

Here is the call graph for this function:

onComboChanged

void ItemComboWidget::onComboChanged ( const QString &  name )

privateslotinherited

Definition at line 134 of file ItemComboWidget.cpp.

{
    setPresentation(selectedPresentation());
}

References ItemComboWidget::selectedPresentation(), and ItemComboWidget::setPresentation().

Referenced by ItemComboWidget::ItemComboWidget().

Here is the call graph for this function:

presentationList()

QStringList JobResultsPresenter::presentationList ( SessionItem *  item )

overrideprotectedvirtual

Returns full list of presentations available for given item.

Reimplemented from ItemComboWidget.

Definition at line 101 of file JobResultsPresenter.cpp.

{
    auto* jobItem = dynamic_cast<JobItem*>(item);
    if (!jobItem || jobItem->isRunning())
        return {};
 
    ASSERT(jobItem->instrumentItem() != nullptr);
 
    auto result = defaultActivePresentationsOfInstrument(jobItem->instrumentItem());
    auto addon = fitPresentationOfInstrument(jobItem->instrumentItem());
    if (!addon.isEmpty())
        result << addon;
 
    return result;
}

References defaultActivePresentationsOfInstrument(), and fitPresentationOfInstrument().

Here is the call graph for this function:

registerWidget()

void ItemComboWidget::registerWidget ( const QString &  presentationType, factory_function_t  f  )

inherited

Definition at line 44 of file ItemComboWidget.cpp.

{
    m_widgetFactory.registerItem(presentationType, f);
}

References ItemComboWidget::m_widgetFactory.

Referenced by JobResultsPresenter(), and RealDataPresenter::RealDataPresenter().

selectedPresentation()

QString ItemComboWidget::selectedPresentation ( ) const

protectedinherited

Presentation selected in combo selector.

Definition at line 122 of file ItemComboWidget.cpp.

{
    return m_toolbar->currentPresentation();
}

References ItemComboToolbar::currentPresentation(), and ItemComboWidget::m_toolbar.

Referenced by ItemComboWidget::itemPresentation(), itemPresentation(), and ItemComboWidget::onComboChanged().

Here is the call graph for this function:

setItem()

void JobResultsPresenter::setItem ( SessionItem *  item )

overridevirtual

Reimplemented from ItemComboWidget.

Definition at line 50 of file JobResultsPresenter.cpp.

{
    ItemComboWidget::setItem(item);
}

References ItemComboWidget::setItem().

Referenced by JobView::onSelectionChanged().

Here is the call graph for this function:

setPresentation() [1/2]

void JobResultsPresenter::setPresentation ( const QString &  presentationType )

overridevirtual

Sets stack to show widget corresponding to given presentation.

Reimplemented from ItemComboWidget.

Definition at line 55 of file JobResultsPresenter.cpp.

{
    ItemComboWidget::setPresentation(presentationType);
    auto* item = dynamic_cast<JobItem*>(currentItem());
    if (item && !presentationType.isEmpty())
        item->setPresentationType(presentationType);
}

References SessionItemWidget::currentItem(), ItemComboWidget::setPresentation(), and JobItem::setPresentationType().

Referenced by JobView::connectActivityRelated(), JobView::setAppropriateActivityForJob(), and setPresentation().

Here is the call graph for this function:

setPresentation [2/2]

void JobResultsPresenter::setPresentation ( JobViewActivity  activity )

slot

Definition at line 63 of file JobResultsPresenter.cpp.

{
    QString presentation;
    auto* jobItem = dynamic_cast<JobItem*>(currentItem());
    if (jobItem && !jobItem->isRunning()) {
        switch (activity) {
        case JobViewActivity::Fitting:
            presentation = fitPresentationOfInstrument(jobItem->instrumentItem());
            break;
 
        case JobViewActivity::RealTime:
        case JobViewActivity::JobView:
            presentation = defaultPresentationOfInstrument(jobItem->instrumentItem());
            break;
        }
        setPresentation(presentation);
    }
}

References SessionItemWidget::currentItem(), defaultPresentationOfInstrument(), fitPresentationOfInstrument(), Fitting, JobView, RealTime, and setPresentation().

Here is the call graph for this function:

setSizeToCurrentWidget()

void ItemComboWidget::setSizeToCurrentWidget ( )

privateinherited

Resizes QStackedWidget to currently active page.

Definition at line 141 of file ItemComboWidget.cpp.

{
    for (int i = 0; i < m_stackedWidget->count(); ++i) {
        // determine the vertical size policy
        QSizePolicy::Policy policy = QSizePolicy::Ignored;
        if (i == m_stackedWidget->currentIndex())
            policy = QSizePolicy::Expanding;
 
        // update the size policy
        auto* page = m_stackedWidget->widget(i);
        page->setSizePolicy(policy, policy);
    }
}

References ItemComboWidget::m_stackedWidget.

Referenced by ItemComboWidget::setPresentation().

setToolbarVisible()

void ItemComboWidget::setToolbarVisible ( bool  value )

inherited

Definition at line 83 of file ItemComboWidget.cpp.

{
    m_toolbar->setVisible(value);
}

References ItemComboWidget::m_toolbar.

Referenced by ItemComboWidget::ItemComboWidget(), ItemComboWidget::setItem(), and ItemComboWidget::setPresentation().

showEvent()

void SessionItemWidget::showEvent ( QShowEvent *  )

overrideprotectedinherited

Definition at line 51 of file SessionItemWidget.cpp.

{
    m_itemController->subscribe();
}

References SessionItemWidget::m_itemController, and SessionItemController::subscribe().

Here is the call graph for this function:

subscribeToItem()

void ItemComboWidget::subscribeToItem ( )

overrideprotectedvirtualinherited

Reimplemented from SessionItemWidget.

Definition at line 127 of file ItemComboWidget.cpp.

{
    m_toolbar->setPresentationList(presentationList(currentItem()),
                                   activePresentationList(currentItem()));
    setPresentation(itemPresentation());
}

References ItemComboWidget::activePresentationList(), SessionItemWidget::currentItem(), ItemComboWidget::itemPresentation(), ItemComboWidget::m_toolbar, ItemComboWidget::presentationList(), ItemComboWidget::setPresentation(), and ItemComboToolbar::setPresentationList().

Here is the call graph for this function:

unsubscribeFromItem()

virtual void SessionItemWidget::unsubscribeFromItem ( )

inlineprotectedvirtualinherited

Reimplemented in ProjectionsPlot, IntensityDataProjectionsWidget, ColorMap, SpecularPlot, Plot1D, FitFlowWidget, FitComparisonWidget1D, FitComparisonWidget, RealDataMaskWidget, and RunFitControlWidget.

Definition at line 44 of file SessionItemWidget.h.

{}

Referenced by SessionItemWidget::SessionItemWidget().

Member Data Documentation

m_blankWidget

QWidget* ItemComboWidget::m_blankWidget

privateinherited

Definition at line 70 of file ItemComboWidget.h.

Referenced by ItemComboWidget::ItemComboWidget(), ItemComboWidget::setItem(), and ItemComboWidget::setPresentation().

m_itemController

SessionItemController* SessionItemWidget::m_itemController

privateinherited

Definition at line 49 of file SessionItemWidget.h.

Referenced by SessionItemWidget::SessionItemWidget(), SessionItemWidget::currentItem(), SessionItemWidget::hideEvent(), SessionItemWidget::setItem(), and SessionItemWidget::showEvent().

m_presentationTypeToWidget

QMap<QString, SessionItemWidget*> ItemComboWidget::m_presentationTypeToWidget

privateinherited

Definition at line 69 of file ItemComboWidget.h.

Referenced by ItemComboWidget::setPresentation().

m_stackedWidget

QStackedWidget* ItemComboWidget::m_stackedWidget

privateinherited

Definition at line 67 of file ItemComboWidget.h.

Referenced by ItemComboWidget::ItemComboWidget(), ItemComboWidget::setItem(), ItemComboWidget::setPresentation(), and ItemComboWidget::setSizeToCurrentWidget().

m_toolbar

ItemComboToolbar* ItemComboWidget::m_toolbar

privateinherited

Definition at line 66 of file ItemComboWidget.h.

Referenced by ItemComboWidget::ItemComboWidget(), ItemComboWidget::selectedPresentation(), ItemComboWidget::setPresentation(), ItemComboWidget::setToolbarVisible(), and ItemComboWidget::subscribeToItem().

m_widgetFactory

IFactory<QString, SessionItemWidget> ItemComboWidget::m_widgetFactory

privateinherited

Definition at line 68 of file ItemComboWidget.h.

Referenced by ItemComboWidget::registerWidget(), and ItemComboWidget::setPresentation().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Job/JobResultsPresenter.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Job/JobResultsPresenter.cpp